Skip to content

Commit 0bea94b

Browse files
Merge pull request #15 from PaystackOSS/dev
Update ReadMe
2 parents baa2d31 + 10087d5 commit 0bea94b

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Paystack OpenAPI Specification
22
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
33

4-
The OpenAPI specification for the Paystack API
4+
The OpenAPI specification for the [Paystack API](https://paystack.com/docs/api).
55

66
## Getting Started
77
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:
1212
## Components
1313
There are three main folders of interest in this repo:
1414
- `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
2128

2229
## Issues
2330
Kindly [open an issue](https://github.com/PaystackOSS/openapi/issues) if you discover any bug or have problems using this library.

0 commit comments

Comments
 (0)