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 API info to Docs #798

Merged
merged 1 commit into from
Dec 26, 2023
Merged

Conversation

brianmakesthings
Copy link
Contributor

@brianmakesthings brianmakesthings commented Dec 26, 2023

Just wanted to give some indication of how to access the API itself.

This will help future client developers and contributers get started easier.

Direct Link to Markdown Preview

Comment on lines +31 to +37
#### REST
> [!WARNING]
>
> Soon to be deprecated

The REST API can be queried at `/api/v1`. An interactive Swagger API explorer is available at `/api/swagger-ui`.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this is still worth keeping until the REST api is actually deprecated, let me know what you think!

@brianmakesthings brianmakesthings marked this pull request as ready for review December 26, 2023 04:30
Copy link
Collaborator

@Syer10 Syer10 left a comment

Choose a reason for hiding this comment

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

Looks good 👍

@Syer10 Syer10 merged commit 3ed84de into Suwayomi:master Dec 26, 2023
@brianmakesthings brianmakesthings deleted the add_api_documentation branch December 26, 2023 04:58
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.

2 participants