From 4858812a7981824db3a5729cb0823f90acce487b Mon Sep 17 00:00:00 2001 From: Damilola Odujoko Date: Thu, 13 Jul 2023 14:56:59 +0100 Subject: [PATCH 1/2] Sample standardisaton --- README.md | 4 +++- main/paystack.yaml | 13 +++++++++++++ redocly.yaml | 30 ++++++++++++++++++++++++++++++ 3 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 redocly.yaml 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..d04afc2 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-displayName: 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-displayName: Transaction Splits + - name: Terminal + description: >- + The Terminal API allows you to build delightful in-person payment experiences + x-displayName: Terminal - name: Customer + description: >- + The Customers API allows you create and manage customers on your integration + x-displayName: 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 From fef45e0c721b4b7c255226290b645f9c1e01ddb6 Mon Sep 17 00:00:00 2001 From: Damilola Odujoko Date: Thu, 13 Jul 2023 14:58:53 +0100 Subject: [PATCH 2/2] Sample standardisaton --- main/paystack.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/main/paystack.yaml b/main/paystack.yaml index d04afc2..e55bfb5 100644 --- a/main/paystack.yaml +++ b/main/paystack.yaml @@ -13,19 +13,19 @@ tags: - name: Transaction description: >- The Transactions API allows you create and manage payments on your integration - x-displayName: Transaction + 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-displayName: Transaction Splits + x-display-name: Transaction Splits - name: Terminal description: >- The Terminal API allows you to build delightful in-person payment experiences - x-displayName: Terminal + x-display-name: Terminal - name: Customer description: >- The Customers API allows you create and manage customers on your integration - x-displayName: Customer + x-display-name: Customer - name: Dedicated Virtual Account - name: Subaccount - name: Plan