OpenAPI: Express server capabilities via /config endpoint

Author: nastra

aws/src/main/resources/s3-signer-open-api.yaml

@@ -56,13 +56,18 @@ servers:
         description: Optional prefix to be appended to all routes
         default: ""
 
+tags:
+  - name: remote-signing
+    description: Requires server to support remote signing
+
 paths:
 
   /v1/aws/s3/sign:
 
     post:
       tags:
         - S3 Signer API
+        - remote-signing
       summary: Remotely signs S3 requests
       operationId: signS3Request
       requestBody:

open-api/rest-catalog-open-api.yaml

@@ -61,6 +61,14 @@ security:
   - OAuth2: [catalog]
   - BearerAuth: []
 
+tags:
+  - name: views
+    description: Requires server to support views
+  - name: oauth2
+    description: Requires server to support OAuth2
+  - name: scan-planning
+    description: Requires server to support scan planning
+
 paths:
   /v1/config:
 
@@ -80,12 +88,14 @@ paths:
         "
         All REST clients should first call this route to get catalog configuration
         properties from the server to configure the catalog and its HTTP client.
-        Configuration from the server consists of two sets of key/value pairs.
+        Configuration from the server consists of:
 
         - defaults -  properties that should be used as default configuration; applied before client configuration
 
         - overrides - properties that should be used to override client configuration; applied after defaults and client configuration
 
+        - capabilities - list of capabilities that are supported by the server
+
 
         Catalog configuration is constructed by setting the defaults, then client-
         provided configuration, and finally overrides. The final property set is then
@@ -114,7 +124,8 @@ paths:
                 },
                 "defaults": {
                   "clients": "4"
-                }
+                },
+                "capabilities": ["views","pagination","remote_signing"]
               }
         400:
           $ref: '#/components/responses/BadRequestErrorResponse'
@@ -134,6 +145,7 @@ paths:
     post:
       tags:
         - OAuth2 API
+        - oauth2
       summary: Get a token using an OAuth2 flow
       operationId: getToken
       description:
@@ -1072,6 +1084,7 @@ paths:
     get:
       tags:
         - Catalog API
+        - views
       summary: List all view identifiers underneath a given namespace
       description: Return all view identifiers under this namespace
       operationId: listViews
@@ -1106,6 +1119,7 @@ paths:
     post:
       tags:
         - Catalog API
+        - views
       summary: Create a view in the given namespace
       description:
         Create a view in the given namespace.
@@ -1158,6 +1172,7 @@ paths:
     get:
       tags:
         - Catalog API
+        - views
       summary: Load a view from the catalog
       operationId: loadView
       description:
@@ -1204,6 +1219,7 @@ paths:
     post:
       tags:
         - Catalog API
+        - views
       summary: Replace a view
       operationId: replaceView
       description:
@@ -1303,6 +1319,7 @@ paths:
     delete:
       tags:
         - Catalog API
+        - views
       summary: Drop a view from the catalog
       operationId: dropView
       description: Remove a view from the catalog
@@ -1335,6 +1352,7 @@ paths:
     head:
       tags:
         - Catalog API
+        - views
       summary: Check if a view exists
       operationId: viewExists
       description:
@@ -1362,6 +1380,7 @@ paths:
     post:
       tags:
         - Catalog API
+        - views
       summary: Rename a view from its current name to a new name
       description:
         Rename a view from one identifier to another. It's valid to move a view
@@ -1559,6 +1578,22 @@ components:
             type: string
           description:
             Properties that should be used as default configuration; applied before client configuration.
+        capabilities:
+          type: array
+          uniqueItems: true
+          items:
+            type: string
+            enum:
+              - pagination
+              - scan-planning
+              - views
+              - vended-credentials
+              - remote-signing
+              - oauth2
+              - sigv4
+          description: Capabilities supported by the server
+          example: "[views,vended-credentials,remote-signing]"
+
 
     CreateNamespaceRequest:
       type: object