Updates to webapp service yaml (#74)

- Document import route
- Document changing workspace
- Include workspaces in webapp metadata
- Other minor cleanup

Author: mollykreis

webapp/niapp.yaml

@@ -195,6 +195,25 @@ paths:
           $ref: '#/responses/Unauthorized'
         default:
           $ref: '#/responses/Error'
+  '/webapps/import':
+    post:
+      tags:
+        - metadata
+      summary: Import webapp metadata
+      description: >-
+        Import a list of webapp metadata.
+
+        The webapp Id, created timestamp, and updated timestamp are optional. These fields will be generated by the service if they are not provided in the request.
+      operationId: import-webapps
+      parameters:
+        - $ref: '#/parameters/ImportWebAppsRequest'
+      responses:
+        200:
+          $ref: '#/responses/ImportWebAppsResponse'
+        401:
+          $ref: '#/responses/Unauthorized'
+        default:
+          $ref: '#/responses/Error'
   '/webapps/{id}/content':
     get:
       tags:
@@ -329,6 +348,11 @@ parameters:
         name:
           type: string
           description: The webapp's name
+          example: My webapp
+        workspace:
+          type: string
+          description: The workspace Id for the webapp. If this is not specified, the webapp will be created in the default workspace.
+          example: 0c80cf49-54e9-4e92-b117-3bfa574caa84
         policyIds:
           type: array
           items:
@@ -353,6 +377,11 @@ parameters:
         name:
           type: string
           description: The webapp's name
+          example: My webapp
+        workspace:
+          type: string
+          description: The workspace Id for the webapp. If this is not specified, the webapp will remain in its existing workspace.
+          example: 0c80cf49-54e9-4e92-b117-3bfa574caa84
         policyIds:
           type: array
           items:
@@ -380,12 +409,27 @@ parameters:
             - private
             - direct
             - public
+          example: direct
           description: The webapp's sharing option
         sharedEmails:
           type: array
           items:
             type: string
+            example: [email protected]
           description: List of emails of users to share the webapp with. Applies when "shared" option is "direct"
+  ImportWebAppsRequest:
+    in: body
+    name: ImportWebAppsRequest
+    description: Import WebApp Metadata Request
+    schema:
+      type: object
+      title: Import WebApp Metadata Request
+      properties:
+        webapps:
+          description: List of webapps to import
+          type: array
+          items:
+            $ref: '#/definitions/WebApp'
   DuplicateWebAppRequest:
     in: body
     name: DuplicateWebAppRequest
@@ -400,7 +444,7 @@ parameters:
           example: My webapp name
         workspace:
           type: string
-          description: The workspace in which to create the new webapp. If no workspace is specified, the new webapp will be put in the default workspace.
+          description: The Id of the workspace in which to create the new webapp. If no workspace is specified, the new webapp will be put in the default workspace.
           example: 0c80cf49-54e9-4e92-b117-3bfa574caa84
 
 responses:
@@ -427,6 +471,17 @@ responses:
     description: Create WebApp Response
     schema:
       $ref: '#/definitions/WebApp'
+  ImportWebAppsResponse:
+    description: Import WebApps Response
+    schema:
+      title: Import WebApps Response
+      type: object
+      properties:
+        webapps:
+          description: List of webapps that were imported
+          type: array
+          items:
+            $ref: '#/definitions/WebApp'
   UpdateWebAppResponse:
     description: Update WebApp Response
     schema:
@@ -472,12 +527,20 @@ definitions:
         type: string
         enum:
           - Dashboard
+          - TileDashboard
           - DashboardTemplate
           - WebVI
+          - Visualization
+          - VisualizationTemplate
         description: The webapp type
       name:
         type: string
         description: The webapp name
+        example: My webapp
+      workspace:
+        type: string
+        description: The Id of the workspace containing the webapp
+        example: 0c80cf49-54e9-4e92-b117-3bfa574caa84
       shared:
         type: string
         enum:
@@ -495,7 +558,7 @@ definitions:
         type: array
         items:
           type: string
-          example: "asdsad-17a6-45323-b64b-65325287372d"
+          example: asdsad-17a6-45323-b64b-65325287372d
         description: List of policy Ids associated with the webapp, which give it access to the user's resources"
       created:
         type: string
@@ -599,8 +662,19 @@ definitions:
         type: array
         items:
           type: string
+      innerErrors:
+        type: array
+        items:
+          $ref: '#/definitions/Error'
     example:
-      name: DocumentManager.NotFound
-      code: -252520
-      message: The specified document was not found.
-      args: []
+      name: Skyline.OneOrMoreErrorsOccurred
+      code: -251041
+      message: >-
+        One or more errors occurred. See the contained list for details of each
+        error.
+      args: []
+      innerErrors:
+        - name: DocumentManager.NotFound
+          code: -252520
+          message: The specified document was not found.
+          args: []