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

Conversation

Projects
None yet
3 participants
@nvllsvm
Copy link
Member

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 requested a review from Bond-009 Jan 18, 2019

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

@Bond-009
Copy link
Member

left a comment

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

Show resolved Hide resolved Emby.Server.Implementations/Services/SwaggerService.cs
info = new SwaggerInfo
{
title = "Jellyfin Server API",
version = "1.0.0",

This comment has been minimized.

Copy link
@Bond-009

Bond-009 Jan 18, 2019

Member

We have a proper API version, right?

Show resolved Hide resolved Emby.Server.Implementations/Services/SwaggerService.cs
@taconaut

This comment has been minimized.

Copy link

commented Jan 19, 2019

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

@nvllsvm

This comment has been minimized.

Copy link
Member Author

commented Jan 19, 2019

@taconaut ReDoc will be added at some point.

@nvllsvm nvllsvm merged commit 3aaaa96 into jellyfin:dev Jan 19, 2019

1 check passed

continuous-integration/drone/pr Build is passing
Details

@joshuaboniface joshuaboniface referenced this pull request Jan 21, 2019

Merged

Release 10.1.0 #651

@nvllsvm nvllsvm deleted the nvllsvm:swagger branch Jan 23, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.