Merge pull request #60 from PaystackOSS/patch-settlements

chore: update settlements examples and descriptions

Author: damilola-paystack

dist/paystack.yaml

@@ -4218,15 +4218,18 @@ paths:
     get:
       tags:
         - Settlement
-      summary: Fetch Settlements
+      summary: List Settlements
+      description: List settlements made to your settlement accounts
       operationId: settlements_fetch
       parameters:
         - name: perPage
+          description: The number of records to fetch per request
           in: query
           schema:
             type: integer
           example: 50
         - name: page
+          description: The offset to retrieve data from
           in: query
           schema:
             type: integer
@@ -4240,18 +4243,21 @@ paths:
           $ref: '#/components/responses/NotFound'
         default:
           description: Server error
-  /settlement/{id}/transaction:
+  /settlement/{id}/transactions:
     get:
       tags:
         - Settlement
-      summary: Settlement Transactions
+      summary: Fetch Settlement Transactions
+      description: Get the transactions that make up a particular settlement
       operationId: settlements_transaction
       parameters:
         - name: id
+          description: The settlement ID in which you want to fetch its transactions
           in: path
           required: true
           schema:
-            type: string
+            type: integer
+          example: 8610870
       responses:
         '200':
           $ref: '#/components/responses/Ok'

src/assets/openapi/openapi.yaml

@@ -352,8 +352,8 @@ paths:
     $ref: paths/page_{id}_product.yaml
   /settlement:
     $ref: paths/settlement.yaml
-  /settlement/{id}/transaction:
-    $ref: paths/settlement_{id}_transaction.yaml
+  /settlement/{id}/transactions:
+    $ref: paths/settlement_{id}_transactions.yaml
   /integration/payment_session_timeout:
     $ref: paths/integration_payment_session_timeout.yaml
   /refund:

src/assets/openapi/paths/settlement.yaml

@@ -1,15 +1,18 @@
 get:
   tags:
     - Settlement
-  summary: Fetch Settlements
+  summary: List Settlements
+  description: List settlements made to your settlement accounts
   operationId: settlements_fetch
   parameters:
     - name: perPage
+      description: The number of records to fetch per request
       in: query
       schema:
         type: integer
       example: 50
     - name: page
+      description: The offset to retrieve data from
       in: query
       schema:
         type: integer

…i/paths/settlement_{id}_transaction.yaml …/paths/settlement_{id}_transactions.yamlsrc/assets/openapi/paths/settlement_{id}_transaction.yaml renamed to src/assets/openapi/paths/settlement_{id}_transactions.yaml src/assets/openapi/paths/settlement_{id}_transaction.yaml renamed to src/assets/openapi/paths/settlement_{id}_transactions.yaml

@@ -1,14 +1,17 @@
 get:
   tags:
     - Settlement
-  summary: Settlement Transactions
+  summary: Fetch Settlement Transactions
+  description: Get the transactions that make up a particular settlement
   operationId: settlements_transaction
   parameters:
     - name: id
+      description: The settlement ID in which you want to fetch its transactions
       in: path
       required: true
       schema:
-        type: string
+        type: integer
+      example: 8610870
   responses:
     '200':
       $ref: ../components/responses/Ok.yaml