You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The OpenAPI specification for the [Paystack API](https://paystack.com/docs/api).
5
5
6
6
## Getting Started
7
7
The [OpenAPI specification](https://swagger.io/specification/) provides another alternative to test the Paystack API.
@@ -12,12 +12,19 @@ You can download the specification and make use of it on:
12
12
## Components
13
13
There are three main folders of interest in this repo:
14
14
-`main`: This contains a comprehensive specification of the Paystack API:
15
-
- resources: This contains individual endpoints in each API category
16
-
- responses: This contains the models for responses
17
-
- schemas: This contains models for each endpoint
18
-
- paystack.yml: This is the entry point for all components
19
-
-`dist`: In order to allow making use of the specification, we built a single file from all components in `main` folder.
20
-
-`sdk`: This is a single file specification being used to client library generation. It contains just enough parameters for our client libraries.
15
+
-`resources`: This contains individual endpoints in each API category
16
+
-`responses`: This contains the models for responses
17
+
-`schemas`: This contains models for each endpoint
18
+
-`paystack.yml`: This is the entry point for all components
19
+
-`dist`: Not all OpenAPI readers can read from different file sources, so we built a single file from all the components in the `main` directory.
20
+
-`sdk`: This is a single file specification being used for client library generation. It contains just enough parameters for our client libraries.
21
+
-`use_cases`: This is a collection of specifications containing APIs for common use cases of the Paystack API. For example, the `wallet.yaml` contains the APIs needed to build a wallet feature into your application. The specifications in this directory are used to create the collections in our [Postman Workspace](https://www.postman.com/paystack-developers?tab=collections).
22
+
23
+
## Contributing
24
+
Here are some of the ways to contribute to this repository:
25
+
- Create a use case
26
+
- Raise an issue
27
+
- Suggest an improvement
21
28
22
29
## Issues
23
30
Kindly [open an issue](https://github.com/PaystackOSS/openapi/issues) if you discover any bug or have problems using this library.
0 commit comments