Skip to content

Add and serve swagger api docs, i.e. spec.yaml? #76

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
Open
mvolz opened this issue Jan 18, 2019 · 3 comments
Open

Add and serve swagger api docs, i.e. spec.yaml? #76

mvolz opened this issue Jan 18, 2019 · 3 comments

Comments

@mvolz
Copy link
Contributor

mvolz commented Jan 18, 2019 •
edited
Loading

If I made a pull request for adding and serving swagger docs, would that something you would merge?
https://swagger.io/specification/

Example of what swagger docs look like in the wild: https://en.wikipedia.org/api/rest_v1/#!/Citation/getCitation
@dstillman
Copy link
Member

Sure!

@retorquere
Copy link
Contributor

Has work on this been done? I'd be very interested in a swagger spec for the zotero api!

@mvolz
Copy link
Contributor Author

mvolz commented Apr 12, 2020

Has work on this been done? I'd be very interested in a swagger spec for the zotero api!

Nope- WIP here, but never got around to submitting this upstream T_T https://gerrit.wikimedia.org/r/#/c/mediawiki/services/zotero/+/481170/

mvolz added a commit to mvolz/translation-server that referenced this issue Oct 5, 2021
@mvolz
Add OpenApi spec and Swagger documentation
918b6c8 
Add Swagger documentation to the root
http://127.0.0.1:1969/?doc with OpenApi 3.0
specification at http://127.0.0.1:1969/?spec

Addresses zotero#76

Change-Id: Ide7b45e7dca90b3ccbbf8141358a66f8dc7b1187
mvolz added a commit to mvolz/translation-server that referenced this issue Oct 5, 2021
@mvolz
Add OpenApi spec and Swagger documentation
42bc4af 
Add Swagger documentation to the root
http://127.0.0.1:1969/?doc with OpenApi 3.0
specification at http://127.0.0.1:1969/?spec

Addresses zotero#76

Change-Id: Ide7b45e7dca90b3ccbbf8141358a66f8dc7b1187
@mvolz mvolz mentioned this issue Oct 5, 2021
Open
mvolz added a commit to mvolz/translation-server that referenced this issue Mar 14, 2024
@mvolz
Add OpenApi spec and Swagger documentation
5890897 
Add Swagger documentation to the root
http://127.0.0.1:1969/?doc with OpenApi 3.0
specification at http://127.0.0.1:1969/?spec

Addresses zotero#76

Bug: T291707
Change-Id: Ide7b45e7dca90b3ccbbf8141358a66f8dc7b1187
(cherry picked from commit 42bc4af)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@retorquere @mvolz @dstillman