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

Swagger API documentation #377

Closed
danielwrayois opened this issue Jul 22, 2019 · 2 comments
Closed

Swagger API documentation #377

danielwrayois opened this issue Jul 22, 2019 · 2 comments
Assignees
@nohaapav
Labels
kind/feature New feature or request
Milestone
1.8

Comments

@danielwrayois
Copy link

FEATURE REQUEST

Hi, I can't seem to find any documentation covering the API spec, is there currently any generated (Swagger, or Redoc, etc) documentation, if not is this something that is planned for the future?
@nohaapav
Copy link
Member

Hi @danielwrayois .. Yes, we plan to introduce swagger for swarmpit API. Basically you can read api definition from this routing and check via browser inspect what kind of data are being sent.

@nohaapav nohaapav changed the title Can't find API documentation Swagger API documentation Oct 11, 2019
@nohaapav nohaapav self-assigned this Oct 11, 2019
@nohaapav nohaapav added the kind/feature New feature or request label Oct 11, 2019
@nohaapav nohaapav added this to the 1.8 milestone Oct 11, 2019
nohaapav added a commit that referenced this issue Oct 16, 2019
@nohaapav
rewrite routing for BE, first stage
d1c4fce 
#377
nohaapav added a commit that referenced this issue Oct 16, 2019
@nohaapav
prepare event handler for reitit
7446b56 
#377
nohaapav added a commit that referenced this issue Oct 16, 2019
@nohaapav
BE routes/handler + FE routes, path matcher reitit
6d41d57 
#377
nohaapav added a commit that referenced this issue Oct 16, 2019
@nohaapav
set reitit ring router
e25fda4 
#377
nohaapav added a commit that referenced this issue Oct 16, 2019
@nohaapav
FE reitit easy routing
03f60f3 
#377
nohaapav added a commit that referenced this issue Oct 16, 2019
@nohaapav
Fix FE components routing data in order to support new reitit routes
b304461 
#377
nohaapav added a commit that referenced this issue Oct 18, 2019
@nohaapav
swagger api
10ce87b 
#377
nohaapav added a commit that referenced this issue Oct 18, 2019
@nohaapav
fix authorization & resource wrapping
5d44531 
#377
nohaapav added a commit that referenced this issue Oct 24, 2019
@nohaapav
cleanup app middleware, reitit exception middleware
aad4a15 
#377
nohaapav added a commit that referenced this issue Oct 24, 2019
@nohaapav
clean nil keys from service domain if create/update due to coercion
37b7796 
#377
nohaapav added a commit that referenced this issue Oct 24, 2019
@nohaapav
request/response route spec
afd9adf 
#377
nohaapav added a commit that referenced this issue Oct 25, 2019
@nohaapav
swagger naming + version
c29d60e 
#377
nohaapav added a commit that referenced this issue Oct 25, 2019
@nohaapav
menu version pointing to backend api
85b6e9b 
#377
nohaapav added a commit that referenced this issue Oct 27, 2019
@nohaapav
Merge pull request #403 from /issues/377
e023083 
Issues/377
@nohaapav
Copy link
Member

Swagger integration done. You can list backend API by visiting /api-docs or clicking version in UI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nohaapav nohaapav

Labels
kind/feature New feature or request
Projects
None yet
Milestone
1.8
Development

No branches or pull requests
2 participants
@nohaapav @danielwrayois