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

Provide Swagger Documentation for Buggregator's REST API #71

Closed
butschster opened this issue Sep 17, 2023 · 0 comments · Fixed by #105
Closed

Provide Swagger Documentation for Buggregator's REST API #71

butschster opened this issue Sep 17, 2023 · 0 comments · Fixed by #105
Assignees
@butschster
Labels
c: easy documentation Improvements or additions to documentation enhancement New feature or request usability
Milestone
1.0

Comments

@butschster
Copy link
Member

Buggregator has an API, but there's no easy way for developers to see how it works. This makes it tough for them to use it properly.

We should add Swagger documentation for our API. This will help everyone understand how to use it.

With Swagger:

  1. Developers can see and try out all the API parts.
  2. It's easier for other apps to work with Buggregator.
@butschster butschster added documentation Improvements or additions to documentation enhancement New feature or request c: easy usability labels Sep 17, 2023
@butschster butschster added this to the 1.0 milestone Sep 17, 2023
@butschster butschster pinned this issue Sep 17, 2023
@butschster butschster self-assigned this Nov 23, 2023
butschster added a commit that referenced this issue Dec 2, 2023
@butschster
Adds Swagger API docs
4b6e71d 
fixes #71
@butschster butschster mentioned this issue Dec 2, 2023
Merged
@butschster butschster unpinned this issue Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@butschster butschster

Labels
c: easy documentation Improvements or additions to documentation enhancement New feature or request usability
Projects
Buggregator
Archived in project
Milestone
1.0
Development

Successfully merging a pull request may close this issue.

Adds Swagger API docs buggregator/server
1 participant
@butschster