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.

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

Add Swagger documentation #616

Merged
merged 2 commits into from
Jan 19, 2019
Merged

Add Swagger documentation #616

merged 2 commits into from
Jan 19, 2019

Conversation

nvllsvm
Copy link
Member

@nvllsvm nvllsvm commented Jan 18, 2019

Adds Swagger/OpenAPI version 2.0 documentation.

Changes
Adds the SwaggerService from https://github.com/jellyfin/Emby/blob/7aa573d4e0fc231932ad3da4cdf15199cf97709a/Emby.Server.Implementations/Services/SwaggerService.cs

Issues
The spec is version 2.0 here so it will be a stop-gap for #614.

@joshuaboniface joshuaboniface changed the title Swagger Add Swagger documentation Jan 18, 2019
Copy link
Member

@Bond-009 Bond-009 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this works I'm good with it.
(Except for the camelBack properties)

info = new SwaggerInfo
{
title = "Jellyfin Server API",
version = "1.0.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a proper API version, right?

@taconaut
Copy link

Does this PR also add Swagger Ui? Would be handy for testing.

@nvllsvm
Copy link
Member Author

nvllsvm commented Jan 19, 2019

@taconaut ReDoc will be added at some point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants