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

is there any doc or usage? #19

Open
s0urcelab opened this issue Oct 15, 2019 · 4 comments
Open

is there any doc or usage? #19

s0urcelab opened this issue Oct 15, 2019 · 4 comments

Comments

@s0urcelab
Copy link

can't find any description in docs
i guess it's a little hard to start with src code

@JustAMan
Copy link
Contributor

There's no definite documentation now. At best there's Swagger (jellyfin/jellyfin#616) and a slowly-being-worked-on repo which uses the client https://github.com/jellyfin/jellyfin-react-client

@fhyoga
Copy link

fhyoga commented Nov 22, 2019

I didn't find the documentation. I exported a json myself and imported it into swaggerUI.
But the interface parameters and return values, information is rare.
Documentation: https://app.swaggerhub.com/apis/vdts/jellyfin-server_api/1.0.0

@thornbill
Copy link
Contributor

#21 will add JSDoc as a dev dependency and provides instructions for generating that documentation. There is still a lot of room for improvement, but it's a start.

@heyhippari
Copy link
Contributor

An update on this:

This now cleaned up to work with jellyfin-web, which means we can now start documenting code properly, as it'll be used in production on jellyfin-web;

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

No branches or pull requests

5 participants