feat (openapi): add missing schedules get endpoint to api spec (#300)

formancehq · Jan 29, 2025 · cbe197a · cbe197a
1 parent 1326df4
commit cbe197a
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 9 deletions.
diff --git a/openapi.yaml b/openapi.yaml
@@ -3419,6 +3419,7 @@ components:
       required:
         - id
         - connectorID
+        - provider
         - reference
         - createdAt
         - type
@@ -3428,6 +3429,8 @@ components:
           type: string
         connectorID:
           type: string
+        provider:
+          type: string
         reference:
           type: string
         createdAt:

diff --git a/openapi/v3/v3-api.yaml b/openapi/v3/v3-api.yaml
@@ -17,13 +17,13 @@ paths:
           description: OK
           content:
             application/json:
-              schema: 
+              schema:
                 $ref: '#/components/schemas/V3ConfigInfoResponse'
         default:
           description: Error
           content:
             application/json:
-              schema: 
+              schema:
                 $ref: '#/components/schemas/V3ErrorResponse'
       security:
         - Authorization:
@@ -393,7 +393,7 @@ paths:
       security:
         - Authorization:
             - payments:write
-  
+
   /v3/connectors/{connectorID}/config:
     get:
       tags:
@@ -475,6 +475,33 @@ paths:
         - Authorization:
             - payments:read
 
+  /v3/connectors/{connectorID}/schedules/{scheduleID}:
+    get:
+      tags:
+        - payments.v3
+      summary: Get a connector schedule by ID
+      operationId: v3GetConnectorSchedule
+      x-speakeasy-name-override: GetConnectorSchedule
+      parameters:
+        - $ref: '#/components/parameters/V3ConnectorID'
+        - $ref: '#/components/parameters/V3ScheduleID'
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/V3ConnectorScheduleResponse'
+        default:
+          description: Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/V3ErrorResponse'
+      security:
+        - Authorization:
+            - payments:read
+
   /v3/connectors/{connectorID}/schedules/{scheduleID}/instances:
     get:
       tags:
@@ -726,7 +753,7 @@ paths:
       security:
         - Authorization:
             - payments:read
-  
+
   /v3/payment-initiations/{paymentInitiationID}/retry:
     post:
       tags:
@@ -1091,4 +1118,4 @@ paths:
       security:
         - Authorization:
             - payments:read
-  
+
diff --git a/openapi/v3/v3-schemas.yaml b/openapi/v3/v3-schemas.yaml
@@ -288,7 +288,7 @@ components:
       properties:
         data:
           $ref: "#/components/schemas/V3BankAccount"
-    
+
     V3BankAccount:
       type: object
       required:
@@ -471,6 +471,14 @@ components:
               items:
                 $ref: "#/components/schemas/V3Schedule"
 
+    V3ConnectorScheduleResponse:
+      type: object
+      required:
+        - data
+      properties:
+        data:
+          $ref: '#/components/schemas/V3Schedule'
+
     V3ConnectorScheduleInstancesCursorResponse:
       type: object
       required:
@@ -613,7 +621,7 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/V3CreatePaymentAdjustmentRequest"
-    
+
     V3CreatePaymentAdjustmentRequest:
       type: object
       required:
@@ -1195,7 +1203,7 @@ components:
       properties:
         data:
           $ref: "#/components/schemas/V3PoolBalances"
-          
+
     V3Pool:
       type: object
       required:
@@ -1307,4 +1315,4 @@ components:
         - MISSING_OR_INVALID_BODY
         - CONFLICT
         - NOT_FOUND
-      example: VALIDATION
+      example: VALIDATION