feat(payments): modify openapi

formancehq · Nov 7, 2023 · 7347085 · 7347085
1 parent a9e8a6a
commit 7347085
Showing 1 changed file with 73 additions and 58 deletions.
diff --git a/components/payments/openapi.yaml b/components/payments/openapi.yaml
@@ -251,7 +251,7 @@ paths:
       responses:
         '200':
           $ref: '#/components/responses/ConnectorsConfigs'
-  /connectors/{connector}:
+  /connectors/install/{connector}:
     post:
       summary: Install a connector
       tags:
@@ -265,30 +265,31 @@ paths:
       responses:
         '204':
           $ref: '#/components/responses/NoContent'
+  /connectors/{connectorId}:
     delete:
       summary: Uninstall a connector
       operationId: uninstallConnector
       tags:
         - Payments
       description: Uninstall a connector by its name.
       parameters:
-        - $ref: '#/components/parameters/Connector'
+        - $ref: '#/components/parameters/ConnectorID'
       responses:
         '204':
           $ref: '#/components/responses/NoContent'
-  /connectors/{connector}/config:
+  /connectors/{connectorId}/config:
     get:
       summary: Read the config of a connector
       operationId: readConnectorConfig
       tags:
         - Payments
       description: Read connector config
       parameters:
-        - $ref: '#/components/parameters/Connector'
+        - $ref: '#/components/parameters/ConnectorID'
       responses:
         '200':
           $ref: '#/components/responses/ConnectorConfig'
-  /connectors/{connector}/reset:
+  /connectors/{connectorId}/reset:
     post:
       summary: Reset a connector
       operationId: resetConnector
@@ -298,63 +299,38 @@ paths:
         Reset a connector by its name.
         It will remove the connector and ALL PAYMENTS generated with it.
       parameters:
-        - $ref: '#/components/parameters/Connector'
+        - $ref: '#/components/parameters/ConnectorID'
       responses:
         '204':
           $ref: '#/components/responses/NoContent'
-  /connectors/{connector}/tasks:
+  /connectors/{connectorId}/tasks:
     get:
       summary: List tasks from a connector
       tags:
         - Payments
       operationId: listConnectorTasks
       description: List all tasks associated with this connector.
       parameters:
-        - $ref: '#/components/parameters/Connector'
+        - $ref: '#/components/parameters/ConnectorID'
         - $ref: '#/components/parameters/PageSize'
         - $ref: '#/components/parameters/Cursor'
       responses:
         '200':
           $ref: '#/components/responses/Tasks'
-  /connectors/{connector}/tasks/{taskId}:
+  /connectors/{connectorId}/tasks/{taskId}:
     get:
       summary: Read a specific task of the connector
       tags:
         - Payments
       operationId: getConnectorTask
       description: Get a specific task associated to the connector.
       parameters:
-        - $ref: '#/components/parameters/Connector'
+        - $ref: '#/components/parameters/ConnectorID'
         - $ref: '#/components/parameters/TaskId'
       responses:
         '200':
           $ref: '#/components/responses/Task'
-  /connectors/{connector}/transfers:
-    post:
-      summary: Transfer funds between Connector accounts
-      tags:
-        - Payments
-      operationId: connectorsTransfer
-      description: Execute a transfer between two accounts.
-      parameters:
-        - $ref: '#/components/parameters/Connector'
-      requestBody:
-        $ref: '#/components/requestBodies/Transfer'
-      responses:
-        '200':
-          $ref: '#/components/responses/Transfer'
-    get:
-      summary: List transfers and their statuses
-      tags:
-        - Payments
-      operationId: listConnectorsTransfers
-      description: List transfers
-      parameters:
-        - $ref: '#/components/parameters/Connector'
-      responses:
-        '200':
-          $ref: '#/components/responses/Transfers'
-
+
 # ---------------------- COMPONENTS ----------------------
 components:
   # ---------------------- PARAMETERS ----------------------
@@ -417,6 +393,14 @@ components:
       description: The account ID.
       example: XXX
       required: true
+    ConnectorID:
+      name: connectorId
+      in: path
+      schema:
+        type: string
+      description: The connector ID.
+      example: XXX
+      required: true
     TransferId:
       name: transferId
       in: path
@@ -765,9 +749,10 @@ components:
             properties:
               provider:
                 $ref: '#/components/schemas/Connector'
-              enabled:
-                type: boolean
-                example: true
+              name:
+                type: string
+              connectorID:
+                type: string
     BankAccountResponse:
       type: object
       required:
@@ -880,8 +865,12 @@ components:
     StripeConfig:
       type: object
       required:
+        - name
         - apiKey
       properties:
+        name:
+          type: string
+          example: 'My Stripe Account'
         pollingPeriod:
           type: string
           example: '60s'
@@ -902,8 +891,12 @@ components:
     DummyPayConfig:
       type: object
       required:
+        - name
         - directory
       properties:
+        name:
+          type: string
+          example: 'My DummyPay Account'
         filePollingPeriod:
           type: string
           example: '60s'
@@ -920,8 +913,12 @@ components:
     WiseConfig:
       type: object
       required:
+        - name
         - apiKey
       properties:
+        name:
+          type: string
+          example: 'My Wise Account'
         apiKey:
           type: string
           example: 'XXX'
@@ -934,9 +931,13 @@ components:
     ModulrConfig:
       type: object
       required:
+      - name
       - apiKey
       - apiSecret
       properties:
+        name:
+          type: string
+          example: 'My Modulr Account'
         apiKey:
           type: string
           example: 'XXX'
@@ -955,13 +956,17 @@ components:
     BankingCircleConfig:
       type: object
       required:
+        - name
         - username
         - password
         - endpoint
         - authorizationEndpoint
         - userCertificate
         - userCertificateKey
       properties:
+        name:
+          type: string
+          example: 'My Banking Circle Account'
         username:
           type: string
           example: 'XXX'
@@ -989,10 +994,14 @@ components:
     MangoPayConfig:
       type: object
       required:
+        - name
         - clientID
         - apiKey
         - endpoint
       properties:
+        name:
+          type: string
+          example: 'My MangoPay Account'
         pollingPeriod:
           type: string
           example: '60s'
@@ -1011,10 +1020,14 @@ components:
     MoneycorpConfig:
       type: object
       required:
+        - name
         - clientID
         - apiKey
         - endpoint
       properties:
+        name:
+          type: string
+          example: 'My Moneycorp Account'
         clientID:
           type: string
           example: 'XXX'
@@ -1033,9 +1046,13 @@ components:
     CurrencyCloudConfig:
       type: object
       required:
+        - name
         - apiKey
         - loginID
       properties:
+        name:
+          type: string
+          example: 'My CurrencyCloud Account'
         apiKey:
           type: string
           example: 'XXX'
@@ -1062,7 +1079,7 @@ components:
         - description
         - sourceAccountID
         - destinationAccountID
-        - provider
+        - connectorID
         - type
         - amount
         - asset
@@ -1087,8 +1104,8 @@ components:
           type: string
         destinationAccountID:
           type: string
-        provider:
-          $ref: '#/components/schemas/Connector'
+        connectorID:
+          type: string
         type:
           type: string
           enum:
@@ -1131,7 +1148,7 @@ components:
         - id
         - createdAt
         - country
-        - provider
+        - connectorID
       properties:
         id:
           type: string
@@ -1140,8 +1157,8 @@ components:
           format: date-time
         country:
           type: string
-        provider:
-          $ref: '#/components/schemas/Connector'
+        connectorID:
+          type: string
         iban:
           type: string
         accountNumber:
@@ -1156,7 +1173,6 @@ components:
         - sourceAccountID
         - destinationAccountID
         - type
-        - provider
         - status
         - initialAmount
         - scheme
@@ -1175,15 +1191,15 @@ components:
           type: string
         destinationAccountID:
           type: string
+        connectorID:
+          type: string
         type:
           type: string
           enum:
             - PAY-IN
             - PAYOUT
             - TRANSFER
             - OTHER
-        provider:
-          $ref: '#/components/schemas/Connector'
         status:
           $ref: '#/components/schemas/PaymentStatus'
         initialAmount:
@@ -1261,8 +1277,8 @@ components:
       required:
         - id
         - createdAt
-        - provider
         - reference
+        - connectorID
         - defaultCurrency
         - defaultAsset
         - accountName
@@ -1274,10 +1290,10 @@ components:
         createdAt:
           type: string
           format: date-time
-        provider:
-          $ref: '#/components/schemas/Connector'
         reference:
           type: string
+        connectorID:
+          type: string
         defaultCurrency:
           type: string
           deprecated: true
@@ -1332,7 +1348,6 @@ components:
           format: uuid
         connectorId:
           type: string
-          format: uuid
         createdAt:
           type: string
           format: date-time
@@ -1497,14 +1512,14 @@ components:
       type: object
       required:
         - country
-        - provider
+        - connectorID
         - name
       properties:
         country:
           type: string
           example: GB
-        provider:
-          $ref: '#/components/schemas/Connector'
+        connectorID:
+          type: string
         name:
           type: string
           example: 'My account'
@@ -1522,7 +1537,7 @@ components:
         - description
         - sourceAccountID
         - destinationAccountID
-        - provider
+        - connectorID
         - type
         - amount
         - asset
@@ -1540,8 +1555,8 @@ components:
           type: string
         destinationAccountID:
           type: string
-        provider:
-          $ref: '#/components/schemas/Connector'
+        connectorID:
+          type: string
         type:
           type: string
           enum: