Add OpenAPI documentation for /v1/properties/session

prestodb · Oct 14, 2024 · 74432de · 74432de
1 parent 7066128
commit 74432de
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 1 deletion.
diff --git a/presto-openapi/src/main/resources/schemas.yaml b/presto-openapi/src/main/resources/schemas.yaml
@@ -999,7 +999,25 @@ components:
     QueryInfo:
       type: object
       # TODO generate all the classes for this object
-
+    SessionPropertyMetadata:
+      type: object
+      required:
+        - name
+        - description
+        - typeSignature
+        - defaultValue
+        - hidden
+      properties:
+        name:
+          type: string
+        description:
+          type: string
+        typeSignature:
+          $ref: '#/components/schemas/TypeSignature'
+        defaultValue:
+          type: string
+        hidden:
+          type: boolean
 
 
 

diff --git a/presto-openapi/src/main/resources/session_properties.yaml b/presto-openapi/src/main/resources/session_properties.yaml
@@ -0,0 +1,20 @@
+openapi: 3.0.0
+info:
+  title: Presto session properties API
+  description: API for retrieving session properties in Presto.
+  version: "1"
+servers:
+  - url: http://localhost:8080
+    description: Presto endpoint when running locally
+paths:
+  /v1/properties/session:
+    get:
+      summary: Returns the list of session properties.
+      description: This endpoint retrieves the supported session properties list from a Prestissimo cluster.
+      responses:
+        '200':
+          description: List of session properties.
+          content:
+            application/json:
+              schema:
+                $ref: './schemas.yaml/#/components/schemas/SessionPropertyMetadata'