From 436bf3b941eff39e70752a0f8b702cf5f8cd3519 Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Wed, 31 Jan 2024 19:50:16 +0530 Subject: [PATCH 01/12] added webExtension swagger API Docs --- .../vscode.dev_powerplatform_v2.1.yml | 1360 +++++++++++++++++ 1 file changed, 1360 insertions(+) create mode 100644 src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml new file mode 100644 index 00000000..5322dc19 --- /dev/null +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml @@ -0,0 +1,1360 @@ +openapi: "3.0.2" +info: + title: VSCode.dev API for PowerPlatform + version: "1.1" +servers: + - url: https://vscode.dev/powerplatform +tags: + - name: portal + description: Everything about editing portal in vscode + - name: default + description: Everything about editing PowerPlatform default app in vscode +paths: + /portal/webpages/{webpageId}: + get: + tags: + - portal + description: "Edit a specific webpage" + parameters: + - name: "webpageId" + in: "path" + description: "ID of the webpage" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + example: dataverse + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "referrerSessionId" + in: "query" + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" + required: false + schema: + type: string + - name: "referrer" + in: "query" + description: "Name of the referrer from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webpages: + get: + tags: + - portal + description: "Edit all webpages" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webfiles/{webfileId}: + get: + tags: + - portal + description: "Edit a specific webfile" + parameters: + - name: "webfileId" + in: "path" + description: "ID of the webfile" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webfiles: + get: + tags: + - portal + description: "Edit all webfiles" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webtemplates/{webtemplateId}: + get: + tags: + - portal + description: "Edit a specific webtemplate" + parameters: + - name: "webtemplateId" + in: "path" + description: "ID of the webtemplate" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webtemplates: + get: + tags: + - portal + description: "Edit all webtemplates" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/pagetemplates/{pagetemplateId}: + get: + tags: + - portal + description: "Edit a specific pagetemplate" + parameters: + - name: "pagetemplateId" + in: "path" + description: "ID of the pagetemplate" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/pagetemplates: + get: + tags: + - portal + description: "Edit all pagetemplates" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/contentsnippets/{contentsnippetId}: + get: + tags: + - portal + description: "Edit a specific contentsnippet" + parameters: + - name: "contentsnippetId" + in: "path" + description: "ID of the contentsnippet" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/contentsnippets: + get: + tags: + - portal + description: "Edit all contentsnippets" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/lists/{listId}: + get: + tags: + - portal + description: "Edit a specific entity List" + parameters: + - name: "listId" + in: "path" + description: "ID of the List" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/lists: + get: + tags: + - portal + description: "Edit all Lists" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/basicforms/{basicformId}: + get: + tags: + - portal + description: "Edit a specific basicform" + parameters: + - name: "basicformId" + in: "path" + description: "ID of the basicform" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/basicforms: + get: + tags: + - portal + description: "Edit all basicforms" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/advancedforms/{advancedformId}: + get: + tags: + - portal + description: "Edit a specific advancedform" + parameters: + - name: "advancedformId" + in: "path" + description: "ID of the advancedform" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/advancedforms: + get: + tags: + - portal + description: "Edit all advancedforms" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal: + get: + tags: + - portal + description: "Edit multiple portal entities: webpages, webfiles, webtemplates, pagetemplates and content snippets" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + example: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /default/{entity}/{entityId}: + get: + tags: + - default + description: "Edit a specific entity" + parameters: + - name: "entity" + in: "path" + description: "Plural Name of the entity" + required: true + schema: + type: string + example: contacts + - name: "entityId" + in: "path" + description: "ID of the entity" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the app data is stored" + required: true + schema: + type: string + example: dataverse + - name: "columns" + in: "query" + style: form + explode: false + description: "comma separated list of columns to edit" + required: true + schema: + type: string + example: address1_addressid, address2_addressid + - name: "splitColumns" + in: "query" + description: "edit in a single file or multiple files" + required: false + schema: + type: boolean + default: true + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PortalManagementApp + responses: + "200": + description: OK + /default/{entity}: + get: + tags: + - default + description: "Edit all records of an entity" + parameters: + - name: "entity" + in: "path" + description: "Plural Name of the entity" + required: true + schema: + type: string + example: contacts + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the app data is stored" + required: true + schema: + type: string + example: dataverse + - name: "columns" + in: "query" + style: form + explode: false + description: "comma separated list of columns to edit" + required: true + schema: + type: string + example: address1_addressid, address2_addressid + - name: "splitColumns" + in: "query" + description: "edit in a single file or multiple files" + required: false + schema: + type: boolean + default: true + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PortalManagementApp + responses: + "200": + description: OK From edb9a5b183606d9b836f42d1ba351246d858efe8 Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Wed, 31 Jan 2024 20:03:01 +0530 Subject: [PATCH 02/12] added updated swagger api docs --- .../vscode.dev_powerplatform_v2.1.yml | 2 +- .../vscode.dev_powerplatform_v3.1.yml | 1360 +++++++++++++++++ 2 files changed, 1361 insertions(+), 1 deletion(-) create mode 100644 src/server/swagger_docs/vscode.dev_powerplatform_v3.1.yml diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml index 5322dc19..ae85a68e 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml @@ -1,7 +1,7 @@ openapi: "3.0.2" info: title: VSCode.dev API for PowerPlatform - version: "1.1" + version: "2.1" servers: - url: https://vscode.dev/powerplatform tags: diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v3.1.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v3.1.yml new file mode 100644 index 00000000..14aa255a --- /dev/null +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v3.1.yml @@ -0,0 +1,1360 @@ +openapi: "3.0.2" +info: + title: VSCode.dev API for PowerPlatform + version: "3.1" +servers: + - url: https://vscode.dev/ +tags: + - name: portal + description: Everything about editing portal in vscode + - name: default + description: Everything about editing PowerPlatform default app in vscode +paths: + /power/portal/webpages/{webpageId}: + get: + tags: + - portal + description: "Edit a specific webpage" + parameters: + - name: "webpageId" + in: "path" + description: "ID of the webpage" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + example: dataverse + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "referrerSessionId" + in: "query" + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" + required: false + schema: + type: string + - name: "referrer" + in: "query" + description: "Name of the referrer from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/webpages: + get: + tags: + - portal + description: "Edit all webpages" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/webfiles/{webfileId}: + get: + tags: + - portal + description: "Edit a specific webfile" + parameters: + - name: "webfileId" + in: "path" + description: "ID of the webfile" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/webfiles: + get: + tags: + - portal + description: "Edit all webfiles" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/webtemplates/{webtemplateId}: + get: + tags: + - portal + description: "Edit a specific webtemplate" + parameters: + - name: "webtemplateId" + in: "path" + description: "ID of the webtemplate" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/webtemplates: + get: + tags: + - portal + description: "Edit all webtemplates" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/pagetemplates/{pagetemplateId}: + get: + tags: + - portal + description: "Edit a specific pagetemplate" + parameters: + - name: "pagetemplateId" + in: "path" + description: "ID of the pagetemplate" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/pagetemplates: + get: + tags: + - portal + description: "Edit all pagetemplates" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/contentsnippets/{contentsnippetId}: + get: + tags: + - portal + description: "Edit a specific contentsnippet" + parameters: + - name: "contentsnippetId" + in: "path" + description: "ID of the contentsnippet" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/contentsnippets: + get: + tags: + - portal + description: "Edit all contentsnippets" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/lists/{listId}: + get: + tags: + - portal + description: "Edit a specific entity List" + parameters: + - name: "listId" + in: "path" + description: "ID of the List" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/lists: + get: + tags: + - portal + description: "Edit all Lists" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/basicforms/{basicformId}: + get: + tags: + - portal + description: "Edit a specific basicform" + parameters: + - name: "basicformId" + in: "path" + description: "ID of the basicform" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/basicforms: + get: + tags: + - portal + description: "Edit all basicforms" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/advancedforms/{advancedformId}: + get: + tags: + - portal + description: "Edit a specific advancedform" + parameters: + - name: "advancedformId" + in: "path" + description: "ID of the advancedform" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal/advancedforms: + get: + tags: + - portal + description: "Edit all advancedforms" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /power/portal: + get: + tags: + - portal + description: "Edit multiple portal entities: webpages, webfiles, webtemplates, pagetemplates and content snippets" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: PortalSchemaV1 + summary: old portal schema + portal new schema: + value: PortalSchemaV2 + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + example: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /default/{entity}/{entityId}: + get: + tags: + - default + description: "Edit a specific entity" + parameters: + - name: "entity" + in: "path" + description: "Plural Name of the entity" + required: true + schema: + type: string + example: contacts + - name: "entityId" + in: "path" + description: "ID of the entity" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the app data is stored" + required: true + schema: + type: string + example: dataverse + - name: "columns" + in: "query" + style: form + explode: false + description: "comma separated list of columns to edit" + required: true + schema: + type: string + example: address1_addressid, address2_addressid + - name: "splitColumns" + in: "query" + description: "edit in a single file or multiple files" + required: false + schema: + type: boolean + default: true + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PortalManagementApp + responses: + "200": + description: OK + /default/{entity}: + get: + tags: + - default + description: "Edit all records of an entity" + parameters: + - name: "entity" + in: "path" + description: "Plural Name of the entity" + required: true + schema: + type: string + example: contacts + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the app data is stored" + required: true + schema: + type: string + example: dataverse + - name: "columns" + in: "query" + style: form + explode: false + description: "comma separated list of columns to edit" + required: true + schema: + type: string + example: address1_addressid, address2_addressid + - name: "splitColumns" + in: "query" + description: "edit in a single file or multiple files" + required: false + schema: + type: boolean + default: true + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PortalManagementApp + responses: + "200": + description: OK From 3382c072a2912fa2c21ae16323f15f5a06b0e987 Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Thu, 1 Feb 2024 11:07:32 +0530 Subject: [PATCH 03/12] Added swagger docs for powerplatform api v1.0 --- .../vscode.dev_powerplatform_v1.0.yml | 931 ++++++++++++++++++ 1 file changed, 931 insertions(+) create mode 100644 src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml new file mode 100644 index 00000000..c20152dd --- /dev/null +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml @@ -0,0 +1,931 @@ +openapi: "3.0.2" +info: + title: VSCode.dev API for PowerPlatform + version: "1.0" +servers: + - url: https://vscode.dev/powerplatform +tags: + - name: portal + description: Everything about editing portal in vscode + - name: default + description: Everything about editing PowerPlatform default app in vscode +paths: + /portal/webpages/{webpageId}: + get: + tags: + - portal + description: "Edit a specific webpage" + parameters: + - name: "webpageId" + in: "path" + description: "ID of the webpage" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webpages: + get: + tags: + - portal + description: "Edit all webpages" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webfiles/{webfileId}: + get: + tags: + - portal + description: "Edit a specific webfile" + parameters: + - name: "webfileId" + in: "path" + description: "ID of the webfile" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webfiles: + get: + tags: + - portal + description: "Edit all webfiles" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webtemplates/{webtemplateId}: + get: + tags: + - portal + description: "Edit a specific webtemplate" + parameters: + - name: "webtemplateId" + in: "path" + description: "ID of the webtemplate" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/webtemplates: + get: + tags: + - portal + description: "Edit all webtemplates" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/pagetemplates/{pagetemplateId}: + get: + tags: + - portal + description: "Edit a specific pagetemplate" + parameters: + - name: "pagetemplateId" + in: "path" + description: "ID of the pagetemplate" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/pagetemplates: + get: + tags: + - portal + description: "Edit all pagetemplates" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/contentsnippets/{contentsnippetId}: + get: + tags: + - portal + description: "Edit a specific contentsnippet" + parameters: + - name: "contentsnippetId" + in: "path" + description: "ID of the contentsnippet" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal/contentsnippets: + get: + tags: + - portal + description: "Edit all contentsnippets" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /portal: + get: + tags: + - portal + description: "Edit multiple portal entities: webpages, webfiles, webtemplates, pagetemplates and content snippets" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + examples: + dataverse: + value: dataverse + summary: if the data is saved in dataverse + github: + value: github + summary: if the data is saved in github + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalDataverseOldDataModelSchema + summary: old portal schema + portal new schema: + value: portalDataverseNewDataModelSchema + summary: new portal schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + example: site + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PowerPagesStudio + responses: + "200": + description: OK + /default/{entity}/{entityId}: + get: + tags: + - default + description: "Edit a specific entity" + parameters: + - name: "entity" + in: "path" + description: "Plural Name of the entity" + required: true + schema: + type: string + example: contacts + - name: "entityId" + in: "path" + description: "ID of the entity" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the app data is stored" + required: true + schema: + type: string + example: dataverse + - name: "columns" + in: "query" + style: form + explode: false + description: "comma separated list of columns to edit" + required: true + schema: + type: string + example: address1_addressid, address2_addressid + - name: "splitColumns" + in: "query" + description: "edit in a single file or multiple files" + required: false + schema: + type: boolean + default: true + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PortalManagementApp + responses: + "200": + description: OK + /default/{entity}: + get: + tags: + - default + description: "Edit all records of an entity" + parameters: + - name: "entity" + in: "path" + description: "Plural Name of the entity" + required: true + schema: + type: string + example: contacts + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the app data is stored" + required: true + schema: + type: string + example: dataverse + - name: "columns" + in: "query" + style: form + explode: false + description: "comma separated list of columns to edit" + required: true + schema: + type: string + example: address1_addressid, address2_addressid + - name: "splitColumns" + in: "query" + description: "edit in a single file or multiple files" + required: false + schema: + type: boolean + default: true + - name: "clientSessionId" + in: "query" + description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + required: false + schema: + type: string + - name: "client" + in: "query" + description: "Name of the client from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + example: PortalManagementApp + responses: + "200": + description: OK From 826ef42ab8b1ac99703873b5cb07dbaaf36546f1 Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Thu, 1 Feb 2024 11:08:14 +0530 Subject: [PATCH 04/12] Added API docs for powerplatform v1.1 --- ....yml => vscode.dev_powerplatform_v1.1.yml} | 485 +----------------- 1 file changed, 25 insertions(+), 460 deletions(-) rename src/server/swagger_docs/{vscode.dev_powerplatform_v2.1.yml => vscode.dev_powerplatform_v1.1.yml} (65%) diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v1.1.yml similarity index 65% rename from src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml rename to src/server/swagger_docs/vscode.dev_powerplatform_v1.1.yml index ae85a68e..927515e4 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v2.1.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v1.1.yml @@ -1,7 +1,7 @@ openapi: "3.0.2" info: title: VSCode.dev API for PowerPlatform - version: "2.1" + version: "1.1" servers: - url: https://vscode.dev/powerplatform tags: @@ -45,11 +45,11 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 - summary: old portal schema + value: portalSchema_v1.0 + summary: portalSchema_v1.0 portal new schema: - value: PortalSchemaV2 - summary: new portal schema + value: portalSchema_v2.0 + summary: portalSchema_v2.0 - name: "websiteId" in: "query" description: "ID of the website" @@ -114,10 +114,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" @@ -190,10 +190,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" @@ -259,10 +259,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" @@ -335,10 +335,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" @@ -404,10 +404,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" @@ -480,10 +480,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" @@ -549,10 +549,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" @@ -625,10 +625,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" @@ -694,445 +694,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/lists/{listId}: - get: - tags: - - portal - description: "Edit a specific entity List" - parameters: - - name: "listId" - in: "path" - description: "ID of the List" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/lists: - get: - tags: - - portal - description: "Edit all Lists" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/basicforms/{basicformId}: - get: - tags: - - portal - description: "Edit a specific basicform" - parameters: - - name: "basicformId" - in: "path" - description: "ID of the basicform" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/basicforms: - get: - tags: - - portal - description: "Edit all basicforms" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/advancedforms/{advancedformId}: - get: - tags: - - portal - description: "Edit a specific advancedform" - parameters: - - name: "advancedformId" - in: "path" - description: "ID of the advancedform" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/advancedforms: - get: - tags: - - portal - description: "Edit all advancedforms" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" @@ -1198,10 +763,10 @@ paths: type: string examples: portal old schema: - value: PortalSchemaV1 + value: portalDataverseOldDataModelSchema summary: old portal schema portal new schema: - value: PortalSchemaV2 + value: portalDataverseNewDataModelSchema summary: new portal schema - name: "websiteId" in: "query" From 0bef1b7c527571774f5ca38217e422d06c1f12ca Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Thu, 1 Feb 2024 11:09:24 +0530 Subject: [PATCH 05/12] Updated API docs for powerplatform to v2.0 --- ...powerplatform_v3.1.yml => vscode.dev_powerplatform_v2.0.yml} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename src/server/swagger_docs/{vscode.dev_powerplatform_v3.1.yml => vscode.dev_powerplatform_v2.0.yml} (99%) diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v3.1.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml similarity index 99% rename from src/server/swagger_docs/vscode.dev_powerplatform_v3.1.yml rename to src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml index 14aa255a..26142d71 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v3.1.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml @@ -1,7 +1,7 @@ openapi: "3.0.2" info: title: VSCode.dev API for PowerPlatform - version: "3.1" + version: "2.0" servers: - url: https://vscode.dev/ tags: From 26217f3a66e1929ab44af0f714b77a169ac4bf15 Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Thu, 1 Feb 2024 11:20:55 +0530 Subject: [PATCH 06/12] Update Swagger API paths for PowerPlatform --- .../vscode.dev_powerplatform_v2.0.yml | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml index 26142d71..8804cd88 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml @@ -3,14 +3,14 @@ info: title: VSCode.dev API for PowerPlatform version: "2.0" servers: - - url: https://vscode.dev/ + - url: https://vscode.dev/power tags: - name: portal description: Everything about editing portal in vscode - name: default description: Everything about editing PowerPlatform default app in vscode paths: - /power/portal/webpages/{webpageId}: + /portal/webpages/{webpageId}: get: tags: - portal @@ -80,7 +80,7 @@ paths: responses: "200": description: OK - /power/portal/webpages: + /portal/webpages: get: tags: - portal @@ -149,7 +149,7 @@ paths: responses: "200": description: OK - /power/portal/webfiles/{webfileId}: + /portal/webfiles/{webfileId}: get: tags: - portal @@ -225,7 +225,7 @@ paths: responses: "200": description: OK - /power/portal/webfiles: + /portal/webfiles: get: tags: - portal @@ -294,7 +294,7 @@ paths: responses: "200": description: OK - /power/portal/webtemplates/{webtemplateId}: + /portal/webtemplates/{webtemplateId}: get: tags: - portal @@ -370,7 +370,7 @@ paths: responses: "200": description: OK - /power/portal/webtemplates: + /portal/webtemplates: get: tags: - portal @@ -439,7 +439,7 @@ paths: responses: "200": description: OK - /power/portal/pagetemplates/{pagetemplateId}: + /portal/pagetemplates/{pagetemplateId}: get: tags: - portal @@ -515,7 +515,7 @@ paths: responses: "200": description: OK - /power/portal/pagetemplates: + /portal/pagetemplates: get: tags: - portal @@ -584,7 +584,7 @@ paths: responses: "200": description: OK - /power/portal/contentsnippets/{contentsnippetId}: + /portal/contentsnippets/{contentsnippetId}: get: tags: - portal @@ -660,7 +660,7 @@ paths: responses: "200": description: OK - /power/portal/contentsnippets: + /portal/contentsnippets: get: tags: - portal @@ -729,7 +729,7 @@ paths: responses: "200": description: OK - /power/portal/lists/{listId}: + /portal/lists/{listId}: get: tags: - portal @@ -805,7 +805,7 @@ paths: responses: "200": description: OK - /power/portal/lists: + /portal/lists: get: tags: - portal @@ -874,7 +874,7 @@ paths: responses: "200": description: OK - /power/portal/basicforms/{basicformId}: + /portal/basicforms/{basicformId}: get: tags: - portal @@ -950,7 +950,7 @@ paths: responses: "200": description: OK - /power/portal/basicforms: + /portal/basicforms: get: tags: - portal @@ -1019,7 +1019,7 @@ paths: responses: "200": description: OK - /power/portal/advancedforms/{advancedformId}: + /portal/advancedforms/{advancedformId}: get: tags: - portal @@ -1095,7 +1095,7 @@ paths: responses: "200": description: OK - /power/portal/advancedforms: + /portal/advancedforms: get: tags: - portal @@ -1164,7 +1164,7 @@ paths: responses: "200": description: OK - /power/portal: + /portal: get: tags: - portal From a4e5fd0e9c4339ba63346179bf6b3336dc4f5b2d Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Fri, 9 Feb 2024 15:45:59 +0530 Subject: [PATCH 07/12] Update Swagger documentation for VSCode extension --- .../vscode.dev_powerplatform_v1.0.yml | 24 +- .../vscode.dev_powerplatform_v1.1.yml | 925 ------------------ 2 files changed, 9 insertions(+), 940 deletions(-) delete mode 100644 src/server/swagger_docs/vscode.dev_powerplatform_v1.1.yml diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml index c20152dd..c94c9f2d 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml @@ -36,13 +36,7 @@ paths: required: true schema: type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github + example: dataverse - name: "schema" in: "query" description: "Schema file name of the app" @@ -51,11 +45,11 @@ paths: type: string examples: portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema + value: portalSchema_v1.0 + summary: portalSchema_v1.0 portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema + value: portalSchema_v2.0 + summary: portalSchema_v2.0 - name: "websiteId" in: "query" description: "ID of the website" @@ -70,15 +64,15 @@ paths: schema: type: string default: site - - name: "clientSessionId" + - name: "referrerSessionId" in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" required: false schema: type: string - - name: "client" + - name: "referrer" in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." + description: "Name of the referrer from where vscode is launched. This is used only for analytics." required: false schema: type: string diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v1.1.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v1.1.yml deleted file mode 100644 index 927515e4..00000000 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v1.1.yml +++ /dev/null @@ -1,925 +0,0 @@ -openapi: "3.0.2" -info: - title: VSCode.dev API for PowerPlatform - version: "1.1" -servers: - - url: https://vscode.dev/powerplatform -tags: - - name: portal - description: Everything about editing portal in vscode - - name: default - description: Everything about editing PowerPlatform default app in vscode -paths: - /portal/webpages/{webpageId}: - get: - tags: - - portal - description: "Edit a specific webpage" - parameters: - - name: "webpageId" - in: "path" - description: "ID of the webpage" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - example: dataverse - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalSchema_v1.0 - summary: portalSchema_v1.0 - portal new schema: - value: portalSchema_v2.0 - summary: portalSchema_v2.0 - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "referrerSessionId" - in: "query" - description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" - required: false - schema: - type: string - - name: "referrer" - in: "query" - description: "Name of the referrer from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webpages: - get: - tags: - - portal - description: "Edit all webpages" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webfiles/{webfileId}: - get: - tags: - - portal - description: "Edit a specific webfile" - parameters: - - name: "webfileId" - in: "path" - description: "ID of the webfile" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webfiles: - get: - tags: - - portal - description: "Edit all webfiles" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webtemplates/{webtemplateId}: - get: - tags: - - portal - description: "Edit a specific webtemplate" - parameters: - - name: "webtemplateId" - in: "path" - description: "ID of the webtemplate" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webtemplates: - get: - tags: - - portal - description: "Edit all webtemplates" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/pagetemplates/{pagetemplateId}: - get: - tags: - - portal - description: "Edit a specific pagetemplate" - parameters: - - name: "pagetemplateId" - in: "path" - description: "ID of the pagetemplate" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/pagetemplates: - get: - tags: - - portal - description: "Edit all pagetemplates" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/contentsnippets/{contentsnippetId}: - get: - tags: - - portal - description: "Edit a specific contentsnippet" - parameters: - - name: "contentsnippetId" - in: "path" - description: "ID of the contentsnippet" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/contentsnippets: - get: - tags: - - portal - description: "Edit all contentsnippets" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal: - get: - tags: - - portal - description: "Edit multiple portal entities: webpages, webfiles, webtemplates, pagetemplates and content snippets" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - example: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /default/{entity}/{entityId}: - get: - tags: - - default - description: "Edit a specific entity" - parameters: - - name: "entity" - in: "path" - description: "Plural Name of the entity" - required: true - schema: - type: string - example: contacts - - name: "entityId" - in: "path" - description: "ID of the entity" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the app data is stored" - required: true - schema: - type: string - example: dataverse - - name: "columns" - in: "query" - style: form - explode: false - description: "comma separated list of columns to edit" - required: true - schema: - type: string - example: address1_addressid, address2_addressid - - name: "splitColumns" - in: "query" - description: "edit in a single file or multiple files" - required: false - schema: - type: boolean - default: true - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PortalManagementApp - responses: - "200": - description: OK - /default/{entity}: - get: - tags: - - default - description: "Edit all records of an entity" - parameters: - - name: "entity" - in: "path" - description: "Plural Name of the entity" - required: true - schema: - type: string - example: contacts - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the app data is stored" - required: true - schema: - type: string - example: dataverse - - name: "columns" - in: "query" - style: form - explode: false - description: "comma separated list of columns to edit" - required: true - schema: - type: string - example: address1_addressid, address2_addressid - - name: "splitColumns" - in: "query" - description: "edit in a single file or multiple files" - required: false - schema: - type: boolean - default: true - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PortalManagementApp - responses: - "200": - description: OK From 9925ee34bbcf7033ae2f07a4276190decc18763a Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Fri, 23 Feb 2024 08:35:12 +0530 Subject: [PATCH 08/12] updated swagger docs --- .../vscode.dev_powerplatform_v1.0.yml | 412 +---- .../vscode.dev_powerplatform_v2.0.yml | 1360 ----------------- 2 files changed, 4 insertions(+), 1768 deletions(-) delete mode 100644 src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml index c94c9f2d..547d553e 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml @@ -45,11 +45,11 @@ paths: type: string examples: portal old schema: - value: portalSchema_v1.0 - summary: portalSchema_v1.0 + value: portalSchemaV1 + summary: portalSchemaV1 portal new schema: - value: portalSchema_v2.0 - summary: portalSchema_v2.0 + value: portalSchemaV2 + summary: portalSchemaV2 - name: "websiteId" in: "query" description: "ID of the website" @@ -80,75 +80,6 @@ paths: responses: "200": description: OK - /portal/webpages: - get: - tags: - - portal - description: "Edit all webpages" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK /portal/webfiles/{webfileId}: get: tags: @@ -225,75 +156,6 @@ paths: responses: "200": description: OK - /portal/webfiles: - get: - tags: - - portal - description: "Edit all webfiles" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK /portal/webtemplates/{webtemplateId}: get: tags: @@ -370,75 +232,6 @@ paths: responses: "200": description: OK - /portal/webtemplates: - get: - tags: - - portal - description: "Edit all webtemplates" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK /portal/pagetemplates/{pagetemplateId}: get: tags: @@ -515,75 +308,6 @@ paths: responses: "200": description: OK - /portal/pagetemplates: - get: - tags: - - portal - description: "Edit all pagetemplates" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK /portal/contentsnippets/{contentsnippetId}: get: tags: @@ -660,75 +384,6 @@ paths: responses: "200": description: OK - /portal/contentsnippets: - get: - tags: - - portal - description: "Edit all contentsnippets" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema - portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK /portal: get: tags: @@ -864,62 +519,3 @@ paths: responses: "200": description: OK - /default/{entity}: - get: - tags: - - default - description: "Edit all records of an entity" - parameters: - - name: "entity" - in: "path" - description: "Plural Name of the entity" - required: true - schema: - type: string - example: contacts - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the app data is stored" - required: true - schema: - type: string - example: dataverse - - name: "columns" - in: "query" - style: form - explode: false - description: "comma separated list of columns to edit" - required: true - schema: - type: string - example: address1_addressid, address2_addressid - - name: "splitColumns" - in: "query" - description: "edit in a single file or multiple files" - required: false - schema: - type: boolean - default: true - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PortalManagementApp - responses: - "200": - description: OK diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml deleted file mode 100644 index 8804cd88..00000000 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v2.0.yml +++ /dev/null @@ -1,1360 +0,0 @@ -openapi: "3.0.2" -info: - title: VSCode.dev API for PowerPlatform - version: "2.0" -servers: - - url: https://vscode.dev/power -tags: - - name: portal - description: Everything about editing portal in vscode - - name: default - description: Everything about editing PowerPlatform default app in vscode -paths: - /portal/webpages/{webpageId}: - get: - tags: - - portal - description: "Edit a specific webpage" - parameters: - - name: "webpageId" - in: "path" - description: "ID of the webpage" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - example: dataverse - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "referrerSessionId" - in: "query" - description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" - required: false - schema: - type: string - - name: "referrer" - in: "query" - description: "Name of the referrer from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webpages: - get: - tags: - - portal - description: "Edit all webpages" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webfiles/{webfileId}: - get: - tags: - - portal - description: "Edit a specific webfile" - parameters: - - name: "webfileId" - in: "path" - description: "ID of the webfile" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webfiles: - get: - tags: - - portal - description: "Edit all webfiles" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webtemplates/{webtemplateId}: - get: - tags: - - portal - description: "Edit a specific webtemplate" - parameters: - - name: "webtemplateId" - in: "path" - description: "ID of the webtemplate" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/webtemplates: - get: - tags: - - portal - description: "Edit all webtemplates" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/pagetemplates/{pagetemplateId}: - get: - tags: - - portal - description: "Edit a specific pagetemplate" - parameters: - - name: "pagetemplateId" - in: "path" - description: "ID of the pagetemplate" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/pagetemplates: - get: - tags: - - portal - description: "Edit all pagetemplates" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/contentsnippets/{contentsnippetId}: - get: - tags: - - portal - description: "Edit a specific contentsnippet" - parameters: - - name: "contentsnippetId" - in: "path" - description: "ID of the contentsnippet" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/contentsnippets: - get: - tags: - - portal - description: "Edit all contentsnippets" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/lists/{listId}: - get: - tags: - - portal - description: "Edit a specific entity List" - parameters: - - name: "listId" - in: "path" - description: "ID of the List" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/lists: - get: - tags: - - portal - description: "Edit all Lists" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/basicforms/{basicformId}: - get: - tags: - - portal - description: "Edit a specific basicform" - parameters: - - name: "basicformId" - in: "path" - description: "ID of the basicform" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/basicforms: - get: - tags: - - portal - description: "Edit all basicforms" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/advancedforms/{advancedformId}: - get: - tags: - - portal - description: "Edit a specific advancedform" - parameters: - - name: "advancedformId" - in: "path" - description: "ID of the advancedform" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal/advancedforms: - get: - tags: - - portal - description: "Edit all advancedforms" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - default: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /portal: - get: - tags: - - portal - description: "Edit multiple portal entities: webpages, webfiles, webtemplates, pagetemplates and content snippets" - parameters: - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the portal data is saved" - required: true - schema: - type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github - - name: "schema" - in: "query" - description: "Schema file name of the app" - required: true - schema: - type: string - examples: - portal old schema: - value: PortalSchemaV1 - summary: old portal schema - portal new schema: - value: PortalSchemaV2 - summary: new portal schema - - name: "websiteId" - in: "query" - description: "ID of the website" - required: true - schema: - type: string - format: guid - - name: "websiteName" - in: "query" - description: "Name of the portal you want to edit" - required: false - schema: - type: string - example: site - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /default/{entity}/{entityId}: - get: - tags: - - default - description: "Edit a specific entity" - parameters: - - name: "entity" - in: "path" - description: "Plural Name of the entity" - required: true - schema: - type: string - example: contacts - - name: "entityId" - in: "path" - description: "ID of the entity" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the app data is stored" - required: true - schema: - type: string - example: dataverse - - name: "columns" - in: "query" - style: form - explode: false - description: "comma separated list of columns to edit" - required: true - schema: - type: string - example: address1_addressid, address2_addressid - - name: "splitColumns" - in: "query" - description: "edit in a single file or multiple files" - required: false - schema: - type: boolean - default: true - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PortalManagementApp - responses: - "200": - description: OK - /default/{entity}: - get: - tags: - - default - description: "Edit all records of an entity" - parameters: - - name: "entity" - in: "path" - description: "Plural Name of the entity" - required: true - schema: - type: string - example: contacts - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the app data is stored" - required: true - schema: - type: string - example: dataverse - - name: "columns" - in: "query" - style: form - explode: false - description: "comma separated list of columns to edit" - required: true - schema: - type: string - example: address1_addressid, address2_addressid - - name: "splitColumns" - in: "query" - description: "edit in a single file or multiple files" - required: false - schema: - type: boolean - default: true - - name: "clientSessionId" - in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" - required: false - schema: - type: string - - name: "client" - in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." - required: false - schema: - type: string - example: PortalManagementApp - responses: - "200": - description: OK From 212e26211ca5ade585d73de8061612df3d1e992f Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Fri, 23 Feb 2024 09:22:21 +0530 Subject: [PATCH 09/12] Updated swagger docs --- .../vscode.dev_powerplatform_v1.0.yml | 309 ++++++++++-------- 1 file changed, 164 insertions(+), 145 deletions(-) diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml index 547d553e..ca1777d1 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml @@ -36,7 +36,7 @@ paths: required: true schema: type: string - example: dataverse + example: Dataverse - name: "schema" in: "query" description: "Schema file name of the app" @@ -46,10 +46,10 @@ paths: examples: portal old schema: value: portalSchemaV1 - summary: portalSchemaV1 + summary: portal old schema portal new schema: value: portalSchemaV2 - summary: portalSchemaV2 + summary: portal new schema - name: "websiteId" in: "query" description: "ID of the website" @@ -64,6 +64,18 @@ paths: schema: type: string default: site + - name: "websitePreviewUrl" + in: "query" + description: "Preview URL of the website" + required: false + schema: + type: string + - name: "websitePreviewId" + in: "query" + description: "Preview Id of the website" + required: false + schema: + type: string - name: "referrerSessionId" in: "query" description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" @@ -76,7 +88,13 @@ paths: required: false schema: type: string - example: PowerPagesStudio + examples: + PowerPagesStudio: + value: PowerPagesStudio + summary: Power Pages Studio + PowerPagesHome: + value: PowerPagesHome + summary: Power Pages Home responses: "200": description: OK @@ -106,13 +124,7 @@ paths: required: true schema: type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github + example: Dataverse - name: "schema" in: "query" description: "Schema file name of the app" @@ -121,11 +133,11 @@ paths: type: string examples: portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema + value: portalSchemaV1 + summary: portal old schema portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema + value: portalSchemaV2 + summary: portal new schema - name: "websiteId" in: "query" description: "ID of the website" @@ -140,19 +152,37 @@ paths: schema: type: string default: site - - name: "clientSessionId" + - name: "websitePreviewUrl" in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + description: "Preview URL of the website" required: false schema: type: string - - name: "client" + - name: "websitePreviewId" in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." + description: "Preview Id of the website" required: false schema: type: string - example: PowerPagesStudio + - name: "referrerSessionId" + in: "query" + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" + required: false + schema: + type: string + - name: "referrer" + in: "query" + description: "Name of the referrer from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + examples: + PowerPagesStudio: + value: PowerPagesStudio + summary: Power Pages Studio + PowerPagesHome: + value: PowerPagesHome + summary: Power Pages Home responses: "200": description: OK @@ -182,13 +212,7 @@ paths: required: true schema: type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github + example: Dataverse - name: "schema" in: "query" description: "Schema file name of the app" @@ -197,11 +221,11 @@ paths: type: string examples: portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema + value: portalSchemaV1 + summary: portal old schema portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema + value: portalSchemaV2 + summary: portal new schema - name: "websiteId" in: "query" description: "ID of the website" @@ -216,19 +240,37 @@ paths: schema: type: string default: site - - name: "clientSessionId" + - name: "websitePreviewUrl" in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + description: "Preview URL of the website" required: false schema: type: string - - name: "client" + - name: "websitePreviewId" in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." + description: "Preview Id of the website" required: false schema: type: string - example: PowerPagesStudio + - name: "referrerSessionId" + in: "query" + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" + required: false + schema: + type: string + - name: "referrer" + in: "query" + description: "Name of the referrer from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + examples: + PowerPagesStudio: + value: PowerPagesStudio + summary: Power Pages Studio + PowerPagesHome: + value: PowerPagesHome + summary: Power Pages Home responses: "200": description: OK @@ -258,13 +300,7 @@ paths: required: true schema: type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github + example: Dataverse - name: "schema" in: "query" description: "Schema file name of the app" @@ -273,11 +309,11 @@ paths: type: string examples: portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema + value: portalSchemaV1 + summary: portal old schema portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema + value: portalSchemaV2 + summary: portal new schema - name: "websiteId" in: "query" description: "ID of the website" @@ -292,19 +328,37 @@ paths: schema: type: string default: site - - name: "clientSessionId" + - name: "websitePreviewUrl" + in: "query" + description: "Preview URL of the website" + required: false + schema: + type: string + - name: "websitePreviewId" in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + description: "Preview Id of the website" required: false schema: type: string - - name: "client" + - name: "referrerSessionId" in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" required: false schema: type: string - example: PowerPagesStudio + - name: "referrer" + in: "query" + description: "Name of the referrer from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + examples: + PowerPagesStudio: + value: PowerPagesStudio + summary: Power Pages Studio + PowerPagesHome: + value: PowerPagesHome + summary: Power Pages Home responses: "200": description: OK @@ -334,13 +388,7 @@ paths: required: true schema: type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github + example: Dataverse - name: "schema" in: "query" description: "Schema file name of the app" @@ -349,11 +397,11 @@ paths: type: string examples: portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema + value: portalSchemaV1 + summary: portal old schema portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema + value: portalSchemaV2 + summary: portal new schema - name: "websiteId" in: "query" description: "ID of the website" @@ -368,28 +416,53 @@ paths: schema: type: string default: site - - name: "clientSessionId" + - name: "websitePreviewUrl" in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + description: "Preview URL of the website" required: false schema: type: string - - name: "client" + - name: "websitePreviewId" in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." + description: "Preview Id of the website" required: false schema: type: string - example: PowerPagesStudio + - name: "referrerSessionId" + in: "query" + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" + required: false + schema: + type: string + - name: "referrer" + in: "query" + description: "Name of the referrer from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + examples: + PowerPagesStudio: + value: PowerPagesStudio + summary: Power Pages Studio + PowerPagesHome: + value: PowerPagesHome + summary: Power Pages Home responses: "200": description: OK - /portal: + /portal/basicforms/{basicformId}: get: tags: - portal - description: "Edit multiple portal entities: webpages, webfiles, webtemplates, pagetemplates and content snippets" + description: "Edit a specific basic form" parameters: + - name: "basicformId" + in: "path" + description: "ID of the basic form" + required: true + schema: + type: string + format: guid - name: "orgUrl" in: "query" description: "Dataverse OrgUrl" @@ -403,13 +476,7 @@ paths: required: true schema: type: string - examples: - dataverse: - value: dataverse - summary: if the data is saved in dataverse - github: - value: github - summary: if the data is saved in github + example: Dataverse - name: "schema" in: "query" description: "Schema file name of the app" @@ -418,11 +485,11 @@ paths: type: string examples: portal old schema: - value: portalDataverseOldDataModelSchema - summary: old portal schema + value: portalSchemaV1 + summary: portal old schema portal new schema: - value: portalDataverseNewDataModelSchema - summary: new portal schema + value: portalSchemaV2 + summary: portal new schema - name: "websiteId" in: "query" description: "ID of the website" @@ -436,86 +503,38 @@ paths: required: false schema: type: string - example: site - - name: "clientSessionId" + default: site + - name: "websitePreviewUrl" in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + description: "Preview URL of the website" required: false schema: type: string - - name: "client" + - name: "websitePreviewId" in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." + description: "Preview Id of the website" required: false schema: type: string - example: PowerPagesStudio - responses: - "200": - description: OK - /default/{entity}/{entityId}: - get: - tags: - - default - description: "Edit a specific entity" - parameters: - - name: "entity" - in: "path" - description: "Plural Name of the entity" - required: true - schema: - type: string - example: contacts - - name: "entityId" - in: "path" - description: "ID of the entity" - required: true - schema: - type: string - format: guid - - name: "orgUrl" - in: "query" - description: "Dataverse OrgUrl" - required: true - schema: - type: string - example: https://contoso.crm.dynamics.com - - name: "dataSource" - in: "query" - description: "Location where the app data is stored" - required: true - schema: - type: string - example: dataverse - - name: "columns" - in: "query" - style: form - explode: false - description: "comma separated list of columns to edit" - required: true - schema: - type: string - example: address1_addressid, address2_addressid - - name: "splitColumns" - in: "query" - description: "edit in a single file or multiple files" - required: false - schema: - type: boolean - default: true - - name: "clientSessionId" + - name: "referrerSessionId" in: "query" - description: "Studio SessionId - this serves as the correlationId between Studio and VSCode extension" + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" required: false schema: type: string - - name: "client" + - name: "referrer" in: "query" - description: "Name of the client from where vscode is launched. This is used only for analytics." + description: "Name of the referrer from where vscode is launched. This is used only for analytics." required: false schema: type: string - example: PortalManagementApp + examples: + PowerPagesStudio: + value: PowerPagesStudio + summary: Power Pages Studio + PowerPagesHome: + value: PowerPagesHome + summary: Power Pages Home responses: "200": description: OK From fc4255817d80ae3fea666eae262ba0988c24c3d1 Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Fri, 23 Feb 2024 10:16:46 +0530 Subject: [PATCH 10/12] Update Swagger documentation for portal entities --- .../vscode.dev_powerplatform_v1.0.yml | 128 +++++++++++++++++- 1 file changed, 126 insertions(+), 2 deletions(-) diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml index ca1777d1..8ec0cca6 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml @@ -7,8 +7,8 @@ servers: tags: - name: portal description: Everything about editing portal in vscode - - name: default - description: Everything about editing PowerPlatform default app in vscode + # - name: default + # description: Everything about editing PowerPlatform default app in vscode paths: /portal/webpages/{webpageId}: get: @@ -538,3 +538,127 @@ paths: responses: "200": description: OK + /portal/{entity}/{entityId}: + get: + tags: + - portal + description: "Edit multiple portal entities: webpages, webfiles, webtemplates, pagetemplates and content snippets" + parameters: + - name: "entity" + in: "path" + description: "Plural Name of the entity" + required: true + schema: + type: string + examples: + webpages: + value: webpages + summary: webpages + webfiles: + value: webfiles + summary: webfiles + webtemplates: + value: webtemplates + summary: webtemplates + pagetemplates: + value: pagetemplates + summary: pagetemplates + contentsnippets: + value: contentsnippets + summary: contentsnippets + basicforms: + value: basicforms + summary: basicforms + - name: "entityId" + in: "path" + description: "ID of the entity" + required: true + schema: + type: string + format: guid + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + example: Dataverse + - name: "enableMultifile" + in: "query" + description: "Enable Multifile load" + required: true + schema: + type: boolean + examples: + enable multifile: + value: true + disable multifile: + value: false + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalSchemaV1 + summary: portal old schema + portal new schema: + value: portalSchemaV2 + summary: portal new schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "websitePreviewUrl" + in: "query" + description: "Preview URL of the website" + required: false + schema: + type: string + - name: "websitePreviewId" + in: "query" + description: "Preview Id of the website" + required: false + schema: + type: string + - name: "referrerSessionId" + in: "query" + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" + required: false + schema: + type: string + - name: "referrer" + in: "query" + description: "Name of the referrer from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + examples: + PowerPagesStudio: + value: PowerPagesStudio + summary: Power Pages Studio + PowerPagesHome: + value: PowerPagesHome + summary: Power Pages Home + responses: + "200": + description: OK From 591a64818030eddfbb5ea0fcb8d9743af9d8ed50 Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Fri, 23 Feb 2024 11:05:40 +0530 Subject: [PATCH 11/12] Add pre-released version of portal endpoint --- .../vscode.dev_powerplatform_v1.0.yml | 102 ++++++++++++++++++ 1 file changed, 102 insertions(+) diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml index 8ec0cca6..f6201f93 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml @@ -4,6 +4,9 @@ info: version: "1.0" servers: - url: https://vscode.dev/powerplatform + description: released version + - url: https://insiders.vscode.dev/powerplatform + description: pre-released version tags: - name: portal description: Everything about editing portal in vscode @@ -662,3 +665,102 @@ paths: responses: "200": description: OK + /portal: + get: + summary: "Pre-released" + servers: + - url: https://insiders.vscode.dev/powerplatform + tags: + - portal + description: "Edit portal" + parameters: + - name: "orgUrl" + in: "query" + description: "Dataverse OrgUrl" + required: true + schema: + type: string + example: https://contoso.crm.dynamics.com + - name: "organizationId" + in: "query" + description: "ID of the organization" + required: true + schema: + type: string + format: guid + - name: "dataSource" + in: "query" + description: "Location where the portal data is saved" + required: true + schema: + type: string + example: Dataverse + - name: "enableMultifile" + in: "query" + description: "Enable Multifile load" + required: true + schema: + type: boolean + enum: + - true + - name: "schema" + in: "query" + description: "Schema file name of the app" + required: true + schema: + type: string + examples: + portal old schema: + value: portalSchemaV1 + summary: portal old schema + portal new schema: + value: portalSchemaV2 + summary: portal new schema + - name: "websiteId" + in: "query" + description: "ID of the website" + required: true + schema: + type: string + format: guid + - name: "websiteName" + in: "query" + description: "Name of the portal you want to edit" + required: false + schema: + type: string + default: site + - name: "websitePreviewUrl" + in: "query" + description: "Preview URL of the website" + required: false + schema: + type: string + - name: "websitePreviewId" + in: "query" + description: "Preview Id of the website" + required: false + schema: + type: string + - name: "referrerSessionId" + in: "query" + description: "Referrer SessionId - this serves as the correlationId between Referrer and VSCode extension" + required: false + schema: + type: string + - name: "referrer" + in: "query" + description: "Name of the referrer from where vscode is launched. This is used only for analytics." + required: false + schema: + type: string + examples: + PowerPagesStudio: + value: PowerPagesStudio + summary: Power Pages Studio + PowerPagesHome: + value: PowerPagesHome + summary: Power Pages Home + responses: + "200": + description: OK From bfd08c7ce451eb110772e5d9efdd1d7b40a991a2 Mon Sep 17 00:00:00 2001 From: ramukaritik Date: Fri, 23 Feb 2024 11:08:50 +0530 Subject: [PATCH 12/12] Update API version and URLs in swagger_docs --- .../vscode.dev_powerplatform_v1.0.yml | 24 +++++++++---------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml index f6201f93..0b20dd62 100644 --- a/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml +++ b/src/server/swagger_docs/vscode.dev_powerplatform_v1.0.yml @@ -1,17 +1,15 @@ -openapi: "3.0.2" +openapi: "3.1.0" info: title: VSCode.dev API for PowerPlatform version: "1.0" servers: - - url: https://vscode.dev/powerplatform + - url: https://vscode.dev/power description: released version - - url: https://insiders.vscode.dev/powerplatform + - url: https://insiders.vscode.dev/power description: pre-released version tags: - name: portal description: Everything about editing portal in vscode - # - name: default - # description: Everything about editing PowerPlatform default app in vscode paths: /portal/webpages/{webpageId}: get: @@ -669,7 +667,7 @@ paths: get: summary: "Pre-released" servers: - - url: https://insiders.vscode.dev/powerplatform + - url: https://insiders.vscode.dev/power tags: - portal description: "Edit portal" @@ -681,13 +679,6 @@ paths: schema: type: string example: https://contoso.crm.dynamics.com - - name: "organizationId" - in: "query" - description: "ID of the organization" - required: true - schema: - type: string - format: guid - name: "dataSource" in: "query" description: "Location where the portal data is saved" @@ -761,6 +752,13 @@ paths: PowerPagesHome: value: PowerPagesHome summary: Power Pages Home + - name: "organizationId" + in: "query" + description: "ID of the organization" + required: true + schema: + type: string + format: guid responses: "200": description: OK