Skip to content

Commit 07984eb

Browse files
authored
feat: add postman api documentation (#18)
* refractor: remove static postman collection file * feat: add postman badge
1 parent 238461b commit 07984eb

File tree

2 files changed

+4
-4398
lines changed

2 files changed

+4
-4398
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
<br />
99

1010
<p align="center">
11+
<a href="https://documenter.getpostman.com/view/33840175/2sA35Bd54w">
12+
<img style="border-radius:3px" height="20px" src="https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white" alt="Postman" />
13+
</a>
1114
<a href="https://github.com/hellhub-collective/api/actions/workflows/github-code-scanning/codeql">
1215
<img src="https://github.com/hellhub-collective/api/actions/workflows/github-code-scanning/codeql/badge.svg" alt="CodeQL" />
1316
</a>
@@ -28,7 +31,7 @@ To start using the HellHub API, you can use the following base for your requests
2831
https://api-hellhub-collective.koyeb.app/api
2932
```
3033

31-
Followed by the endpoint you want to access. Our data is **updated every 30 minutes**. For more information on the available endpoints, check the [postman collection](postman.json).
34+
Followed by the endpoint you want to access. Our data is **updated every 30 minutes**. For more information on the available endpoints, check out the [postman collection](https://documenter.getpostman.com/view/33840175/2sA35Bd54w).
3235

3336
## Fair usage
3437

0 commit comments

Comments
 (0)