Merge branch '123-docs-update-swagger-ui' into 'master'

chore: update SwaggerUI specs and dist (docs#123)

Closes #123

See merge request postgres-ai/database-lab!632

Author: agneum

engine/.gitlab-ci.yml

@@ -397,16 +397,15 @@ build-image-rc-client:
     DOCKER_FILE: "Dockerfile.dblab-cli"
     DOCKER_NAME: "postgresai/dblab"
 
-build-image-swagger-latest:
+build-image-swagger-release:
   <<: *build_image_definition
   <<: *only_tag_release
   variables:
     DOCKER_FILE: "Dockerfile.swagger-ui"
-    DOCKER_NAME: "registry.gitlab.com/postgres-ai/database-lab/dblab-swagger-ui"
+    DOCKER_IMAGE_NAME: "registry.gitlab.com/postgres-ai/database-lab/dblab-swagger-ui"
   before_script:
     - export CLEAN_TAG=$(echo ${CI_COMMIT_TAG#"v"})
-    - export LATEST_TAG=$(echo ${CLEAN_TAG%.*}-latest)
-    - export TAGS="${DOCKER_NAME}:${LATEST_TAG}"
+    - export TAGS="${DOCKER_IMAGE_NAME}:${CLEAN_TAG}"
 
 .bash-test: &bash_test
   stage: integration-test
@@ -483,3 +482,24 @@ integration-test:
   script:
     - cd engine
     - make test-ci-integration
+
+## Deploy
+.deploy-definition: &deploy_definition
+  stage: deploy
+  image: dtzar/helm-kubectl:2.14.1
+  script:
+    - bash ./engine/scripts/do.sh subs_envs ./engine/deploy/swagger-ui.yaml /tmp/swagger-ui.yaml
+    - kubectl apply --filename /tmp/swagger-ui.yaml -n $NAMESPACE
+
+deploy-swagger-ui-tag-release:
+  <<: *only_tag_release
+  <<: *deploy_definition
+  environment:
+    name: production
+  variables:
+    ENV: production
+    NAMESPACE: production
+    DOCKER_IMAGE_NAME: "registry.gitlab.com/postgres-ai/database-lab/dblab-swagger-ui"
+  before_script:
+    - export CLEAN_TAG=$(echo ${CI_COMMIT_TAG#"v"})
+    - export TAG="${DOCKER_IMAGE_NAME}:${CLEAN_TAG}"

engine/api/swagger-spec/dblab_server_swagger.yaml

@@ -1,8 +1,8 @@
 swagger: "2.0"
 info:
   description: "This is a Database Lab Engine sample server."
-  version: "2.5.0"
-  title: "Database Lab"
+  version: "3.2.0"
+  title: "Database Lab Engine API"
   contact:
     email: "[email protected]"
   license:
@@ -461,6 +461,30 @@ paths:
           schema:
             $ref: "#/definitions/Error"
 
+  /instance/retrieval:
+    get:
+      tags:
+        - "instance"
+      summary: "Report state of retrieval subsystem"
+      description: ""
+      operationId: "instanceRetrieval"
+      produces:
+        - "application/json"
+      parameters:
+        - in: header
+          name: Verification-Token
+          type: string
+          required: true
+      responses:
+        200:
+          description: "Successful operation"
+          schema:
+            $ref: "#/definitions/Retrieving"
+        500:
+          description: "Internal server error"
+          schema:
+            $ref: "#/definitions/Error"
+
   /healthz:
     get:
       tags:
@@ -592,6 +616,30 @@ paths:
           schema:
             $ref: "#/definitions/Error"
 
+  /admin/ws-auth:
+    post:
+      tags:
+        - "config"
+      summary: "Test source database"
+      description: ""
+      operationId: "testDBConnection"
+      consumes:
+        - "application/json"
+      parameters:
+        - in: header
+          name: Verification-Token
+          type: string
+          required: true
+      responses:
+        200:
+          description: "Successful operation"
+          schema:
+            $ref: "#/definitions/WSToken"
+        500:
+          description: "Internal server error"
+          schema:
+            $ref: "#/definitions/Error"
+
 definitions:
   Instance:
     type: "object"
@@ -710,6 +758,34 @@ definitions:
       nextRefresh:
         type: "string"
         format: "date-time"
+      activity:
+        $ref: "#/definitions/Activity"
+
+  Activity:
+    type: "object"
+    properties:
+      source:
+        type: "array"
+        items:
+          $ref: "#/definitions/PGActivityEvent"
+      target:
+        type: "array"
+        items:
+          $ref: "#/definitions/PGActivityEvent"
+
+  PGActivityEvent:
+    type: "object"
+    properties:
+      user:
+        type: "string"
+      query:
+        type: "string"
+      duration:
+        type: "number"
+      waitEventType:
+        type: "string"
+      waitEvent:
+        type: "string"
 
   Provisioner:
     type: "object"
@@ -1020,6 +1096,17 @@ definitions:
         type: "string"
       password:
         type: "string"
+      db_list:
+        type: "array"
+        items:
+          type: "string"
+
+  WSToken:
+    type: "object"
+    properties:
+      token:
+        type: "string"
+        description: "WebSocket token"
 
 
 externalDocs:

engine/api/swagger-ui/index.css

@@ -0,0 +1,16 @@
+html {
+    box-sizing: border-box;
+    overflow: -moz-scrollbars-vertical;
+    overflow-y: scroll;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body {
+    margin: 0;
+    background: #fafafa;
+}

engine/api/swagger-ui/index.html

@@ -5,56 +5,15 @@
     <meta charset="UTF-8">
     <title>Swagger UI</title>
     <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="index.css" />
     <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
     <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
-    <style>
-      html
-      {
-        box-sizing: border-box;
-        overflow: -moz-scrollbars-vertical;
-        overflow-y: scroll;
-      }
-
-      *,
-      *:before,
-      *:after
-      {
-        box-sizing: inherit;
-      }
-
-      body
-      {
-        margin:0;
-        background: #fafafa;
-      }
-    </style>
   </head>
 
   <body>
     <div id="swagger-ui"></div>
-
     <script src="./swagger-ui-bundle.js" charset="UTF-8"> </script>
     <script src="./swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
-    <script>
-    window.onload = function() {
-      // Begin Swagger UI call region
-      const ui = SwaggerUIBundle({
-        url: "api/swagger-spec/dblab_server_swagger.yaml",
-        dom_id: '#swagger-ui',
-        deepLinking: true,
-        presets: [
-          SwaggerUIBundle.presets.apis,
-          SwaggerUIStandalonePreset
-        ],
-        plugins: [
-          SwaggerUIBundle.plugins.DownloadUrl
-        ],
-        layout: "StandaloneLayout"
-      });
-      // End Swagger UI call region
-
-      window.ui = ui;
-    };
-  </script>
+    <script src="./swagger-initializer.js" charset="UTF-8"> </script>
   </body>
 </html>

engine/api/swagger-ui/oauth2-redirect.html

@@ -13,7 +13,7 @@
         var isValid, qp, arr;
 
         if (/code|token|error/.test(window.location.hash)) {
-            qp = window.location.hash.substring(1);
+            qp = window.location.hash.substring(1).replace('?', '&');
         } else {
             qp = location.search.substring(1);
         }
@@ -38,7 +38,7 @@
                     authId: oauth2.auth.name,
                     source: "auth",
                     level: "warning",
-                    message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
+                    message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
                 });
             }
 
@@ -58,7 +58,7 @@
                     authId: oauth2.auth.name,
                     source: "auth",
                     level: "error",
-                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
                 });
             }
         } else {
@@ -67,9 +67,13 @@
         window.close();
     }
 
-    window.addEventListener('DOMContentLoaded', function () {
-      run();
-    });
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
 </script>
 </body>
 </html>

engine/api/swagger-ui/swagger-initializer.js

@@ -0,0 +1,20 @@
+window.onload = function() {
+  //<editor-fold desc="Changeable Configuration Block">
+
+  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
+  window.ui = SwaggerUIBundle({
+    url: "api/swagger-spec/dblab_server_swagger.yaml",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout"
+  });
+
+  //</editor-fold>
+};