Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: API & general documentation #8

Merged
merged 4 commits into from
Dec 15, 2023
Merged

docs: API & general documentation #8

merged 4 commits into from
Dec 15, 2023

Conversation

pajicf
Copy link
Owner

@pajicf pajicf commented Dec 15, 2023

What does this PR resolve? 🚀

  • Adds Swagger UI client
  • Adds Postman collection
  • Updates the README

Details 📝

We'll be using Swagger as the primary tool for displaying APIs but there'a also a Postman collection for those who prefer it.

Checklist ✅

  • I've read Contributions section in the README.md document
  • I have merged the main branch into my branch and resolved all conflicts
  • I have documented the new code
  • I have created automated tests for the new code
  • I have smoke tested the new code locally
  • I have assigned the PR to myself
  • I have named the PR correctly

@pajicf pajicf added the documentation Improvements or additions to documentation label Dec 15, 2023
@pajicf pajicf self-assigned this Dec 15, 2023
@pajicf pajicf merged commit 753fbda into main Dec 15, 2023
2 checks passed
@pajicf pajicf deleted the docs branch December 15, 2023 19:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@pajicf pajicf

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@pajicf