Skip to content

Commit

Permalink
docs: Updated Postman links
Browse files Browse the repository at this point in the history
  • Loading branch information
rajdip-b committed Sep 5, 2024
1 parent c087b32 commit 444bfb1
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 9 deletions.
7 changes: 0 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,6 @@ Please ensure your pull request adheres to the following guidelines:
- Your PR should follow this pattern: `fix|feat|chore|docs|style|refactor|perf|test|ci|build|breaking-change|revert: <description>`. For example, `feat: add new feature` or `fix: fix a bug`. Note that description can contain only alphanumeric characters and `-`, `.` and `_` characters.
- Before you make a push to your branch, make sure you rebase your branch with the latest changes from the `develop` branch.

## API Documentation Contribution

We are managing our API documentation using Postman. Hence, for any changes to the API that requires changes to the API documentation as well, they can be implemented in one way or the other:

- Either, you can manually update the collections in [postman/collections](./postman/collections/) and make the PR.
- Or, you can export the collection from Postman, paste them in the respective files in [postman/collections](./postman/collections) and make the PR.

## Documentation

We love documentation contributions! Whether it's more complete descriptions, new examples, or better formatting, any help improving the documentation is appreciated.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ description: API testing using Postman

# API Testing

We use Postman to test our APIs. All of our endpoints are tested using Postman and we maintain a detailed documentation of every endpoint in our Postman collection. You can find the workspace in [here](https://www.postman.com/blue-crescent-581920/workspace/keyshade)
We use Postman to test our APIs. All of our endpoints are tested using Postman and we maintain a detailed documentation of every endpoint in our Postman collection. You can find the workspace in [here](hhttps://www.postman.com/keyshade/workspace/keyshade/api/a31bdb66-69e3-469b-afb4-f2051385e634?action=share&creator=32733901)

We maintain an API named [`keyshade API`](https://www.postman.com/keyshade/workspace/keyshade) in our Postman workspace. This API contains all the endpoints that we have in our application. This is where you can find all the collections which you can use to develop/test our APIs
We maintain an API named [`keyshade API`](https://www.postman.com/keyshade/workspace/keyshade/api/a31bdb66-69e3-469b-afb4-f2051385e634?action=share&creator=32733901) in our Postman workspace. This API contains all the endpoints that we have in our application. This is where you can find all the collections which you can use to develop/test our APIs

## Getting started

Expand Down

0 comments on commit 444bfb1

Please sign in to comment.