Add pre-released version of portal endpoint

microsoft · Feb 23, 2024 · 591a648 · 591a648
1 parent fc42558
commit 591a648
Showing 1 changed file with 102 additions and 0 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
@@ -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