diff --git a/README.md b/README.md index 31b16a7..fbfc82d 100644 --- a/README.md +++ b/README.md @@ -30,4 +30,6 @@ Here are some of the ways to contribute to this repository: Kindly [open an issue](https://github.com/PaystackOSS/openapi/issues) if you discover any bug or have problems using this library. ## License -This repository is made available under the MIT license. Kindly read the [LICENSE](https://github.com/PaystackOSS/openapi/blob/main/LICENSE) file for more information. \ No newline at end of file +This repository is made available under the MIT license. Kindly read the [LICENSE](https://github.com/PaystackOSS/openapi/blob/main/LICENSE) file for more information. + + diff --git a/main/paystack.yaml b/main/paystack.yaml index d3324fa..e55bfb5 100644 --- a/main/paystack.yaml +++ b/main/paystack.yaml @@ -11,8 +11,21 @@ servers: description: Base API endpoint tags: - name: Transaction + description: >- + The Transactions API allows you create and manage payments on your integration + x-display-name: Transaction - name: Split + description: >- + The Transaction Splits API enables merchants split the settlement for a transaction across their payout account, and one or more subaccounts + x-display-name: Transaction Splits + - name: Terminal + description: >- + The Terminal API allows you to build delightful in-person payment experiences + x-display-name: Terminal - name: Customer + description: >- + The Customers API allows you create and manage customers on your integration + x-display-name: Customer - name: Dedicated Virtual Account - name: Subaccount - name: Plan diff --git a/redocly.yaml b/redocly.yaml new file mode 100644 index 0000000..085eae4 --- /dev/null +++ b/redocly.yaml @@ -0,0 +1,30 @@ +# See https://redocly.com/docs/cli/configuration/ + +apis: + # Update the apiName with your actual API name, and the version with your actual API version. + main@1: + root: ./main/paystack.yaml + sdk@1: + root: ./sdk/paystack.yaml + +extends: + - recommended + +rules: + # A sample custom rule. Read more about rules: https://redocly.com/docs/cli/rules/ + assert/operation-description: + subject: + type: Operation + property: description + assertions: + defined: true + minLength: 30 + +theme: + openapi: + generateCodeSamples: + languages: + - lang: curl + - lang: Node.js + - lang: Python + - lang: PHP \ No newline at end of file