merge dev into branch

Author: Andrew-Paystack

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] Bug name goes here"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEAT] Feature name goes here"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+---
+name: Pull Request
+about: Create a PR for a new feature or bug fix
+
+---
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+## What issue does this change solve?
+A clear and concise description of what the solution is.
+
+
+# Additional context
+Add any other context or screenshots about the change.

.github/workflows/lint-spec.yml

@@ -0,0 +1,19 @@
+name: Run Spectral on Pull Requests
+
+on:
+  - pull_request
+
+jobs:
+  build:
+    name: Lint 
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Lint SDK specification
+        uses: stoplightio/spectral-action@latest
+        with:
+          file_glob: 'sdk/*.yaml'
+      - name: Lint distribution specification
+        uses: stoplightio/spectral-action@latest
+        with:
+          file_glob: 'dist/*.yaml'

.gitignore

@@ -1 +1,2 @@
-node_modules
+node_modules
+.DS_Store

README.md

@@ -1,7 +1,7 @@
 # Paystack OpenAPI Specification
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-The OpenAPI specification for the Paystack API
+The OpenAPI specification for the [Paystack API](https://paystack.com/docs/api).
 
 ## Getting Started
 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:
 ## Components
 There are three main folders of interest in this repo:
 - `main`: This contains a comprehensive specification of the Paystack API:
-  - resources: This contains individual endpoints in each API category
-  - responses: This contains the models for responses
-  - schemas: This contains models for each endpoint 
-  - paystack.yml: This is the entry point for all components
-- `dist`: In order to allow making use of the specification, we built a single file from all components in `main` folder.
-- `sdk`: This is a single file specification being used to client library generation. It contains just enough parameters for our client libraries.
+  - `resources`: This contains individual endpoints in each API category
+  - `responses`: This contains the models for responses
+  - `schemas`: This contains models for each endpoint 
+  - `paystack.yml`: This is the entry point for all components
+- `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.
+- `sdk`: This is a single file specification being used for client library generation. It contains just enough parameters for our client libraries.
+- `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).
+
+## Contributing
+Here are some of the ways to contribute to this repository:
+- Create a use case
+- Raise an issue
+- Suggest an improvement
 
 ## Issues
 Kindly [open an issue](https://github.com/PaystackOSS/openapi/issues) if you discover any bug or have problems using this library.

dist/betting.yaml

@@ -252,7 +252,7 @@ paths:
           in: query
           schema:
             type: integer
-          example: '063'
+          example: 51
       responses:
         '200':
           description: Resolve Account Number

dist/lending.yaml

@@ -357,7 +357,7 @@ paths:
           in: query
           schema:
             type: integer
-          example: '063'
+          example: 51
       responses:
         '200':
           description: Resolve Account Number

dist/paystack.yaml

@@ -1929,7 +1929,7 @@ paths:
         default:
           description: Server error
   '/subscription/{code}/manage/link':
-    post:
+    get:
       tags:
         - Subscription
       summary: Generate Update Subscription Link
@@ -2708,12 +2708,12 @@ paths:
           in: query
           schema:
             type: integer
-          example: '50'
+          example: 50
         - name: page
           in: query
           schema:
             type: integer
-          example: '2'
+          example: 2
       responses:
         '200':
           $ref: '#/paths/~1product/post/responses/201'
@@ -2740,12 +2740,12 @@ paths:
           in: query
           schema:
             type: integer
-          example: '50'
+          example: 50
         - name: page
           in: query
           schema:
             type: integer
-          example: '2'
+          example: 2
       responses:
         '200':
           $ref: '#/paths/~1product/post/responses/201'
@@ -4351,7 +4351,7 @@ paths:
           in: query
           schema:
             type: integer
-          example: '063'
+          example: 51
       responses:
         '200':
           description: Resolve Account Number

dist/savings.yaml

@@ -252,7 +252,7 @@ paths:
           in: query
           schema:
             type: integer
-          example: '063'
+          example: 51
       responses:
         '200':
           description: Resolve Account Number