add versioning info

Author: nastra

open-api/rest-catalog-open-api.py

@@ -41,6 +41,25 @@ class ErrorModel(BaseModel):
     stack: Optional[List[str]] = None
 
 
+class ServerCapability(BaseModel):
+    """
+    Describes a capability with versioning information supported by the server. A server is required to implement all endpoints grouped under a particular capability. For example, if a server reports the support of `views`, then all endpoints grouped under the `views` capability must be implemented by the server.
+    """
+
+    capability: str = Field(
+        ...,
+        description='A capability supported by the server. The currently available capabilities are:\n - tables\n - views\n - remote-signing\n - multi-table-commit\n - register-table\n - table-metrics\n',
+        example='views',
+    )
+    versions: List[int] = Field(
+        ...,
+        description='A list of versions supported by the server for the given capability. For example, `versions = [1, 3, 5]` indicates that only these versions are supported for the given capability, but not versions `2, 4, 6`.',
+        example=[1, 3, 5],
+        min_items=1,
+        unique_items=True,
+    )
+
+
 class CatalogConfig(BaseModel):
     """
     Server-provided configuration for the catalog.
@@ -54,19 +73,14 @@ class CatalogConfig(BaseModel):
         ...,
         description='Properties that should be used as default configuration; applied before client configuration.',
     )
-    capabilities: Optional[List[str]] = Field(
+    capabilities: Optional[List[ServerCapability]] = Field(
         None,
-        description='Describes capabilities supported by the server. A server is required to implement all endpoints grouped under a particular capability. For example, if a server reports the support of `views`, then all endpoints grouped under the `views` capability must be implemented by the server.',
+        description='Describes a capability with versioning information supported by the server',
         example=[
-            'tables',
-            'views',
-            'remote-signing',
-            'vended-credentials',
-            'multi-table-commit',
-            'register-table',
-            'table-metrics',
+            {'capability': 'views', 'versions': [1, 2]},
+            {'capability': 'register-table', 'versions': [1, 3, 5]},
+            {'capability': 'multi-table-commit', 'versions': [1]},
         ],
-        unique_items=True,
     )
 
 

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

@@ -143,7 +143,9 @@ paths:
                 "defaults": {
                   "clients": "4"
                 },
-                "capabilities": ["tables", "views", "remote-signing"]
+                "capabilities": [{"capability": "views", "versions": [1, 2]},
+                                 {"capability": "register-table", "versions": [1, 3, 5]},
+                                 {"capability": "multi-table-commit", "versions":[1]}]
               }
         400:
           $ref: '#/components/responses/BadRequestErrorResponse'
@@ -1581,6 +1583,35 @@ components:
           items:
             type: string
 
+    ServerCapability:
+      type: object
+      description: Describes a capability with versioning information supported by the server. A server is required to implement all endpoints grouped under a particular capability.
+        For example, if a server reports the support of `views`, then all endpoints grouped under the `views` capability must be implemented by the server.
+      required:
+        - capability
+        - versions
+      properties:
+        capability:
+          type: string
+          description: |
+            A capability supported by the server. The currently available capabilities are:
+             - tables
+             - views
+             - remote-signing
+             - multi-table-commit
+             - register-table
+             - table-metrics
+          example: "views"
+        versions:
+          type: array
+          uniqueItems: true
+          description: A list of versions supported by the server for the given capability. For example, `versions = [1, 3, 5]` indicates that only
+            these versions are supported for the given capability, but not versions `2, 4, 6`.
+          items:
+            type: integer
+          minItems: 1
+          example: [1, 3, 5]
+
     CatalogConfig:
       type: object
       description: Server-provided configuration for the catalog.
@@ -1602,13 +1633,10 @@ components:
             Properties that should be used as default configuration; applied before client configuration.
         capabilities:
           type: array
-          uniqueItems: true
           items:
-            type: string
-          description:
-            Describes capabilities supported by the server. A server is required to implement all endpoints grouped under a particular capability.
-            For example, if a server reports the support of `views`, then all endpoints grouped under the `views` capability must be implemented by the server.
-          example: [ "tables", "views", "remote-signing", "vended-credentials", "multi-table-commit", "register-table", "table-metrics" ]
+            $ref: '#/components/schemas/ServerCapability'
+          description: Describes a capability with versioning information supported by the server
+          example: [{"capability": "views", "versions": [1, 2]}, {"capability": "register-table", "versions": [1, 3, 5]}, {"capability": "multi-table-commit","versions":[1]}]
 
     CreateNamespaceRequest:
       type: object