Conversation
Merged
Collaborator
|
From a quick check:
|
Member
Author
|
I only documented the “stable” API calls listed on the wiki. I think |
This patch adds the description of the RESTful API in OpenAPI 3.0 format. Previously, the API was manually documented on the wiki without any guarantee that the description matches reality. Formal description will allow us to check for compliance automatically, as well as use other cool tools like Swagger UI. Closes: #993
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This patch adds the description of the RESTful API in OpenAPI 3.0 format. Previously, the API was manually documented on the wiki without any guarantee that the description matches reality. Formal description will allow us to check for compliance automatically, as well as use other cool tools like Swagger UI.
For now, you can view the API on https://app.swaggerhub.com/apis/jtojnar/selfoss/2.18-SNAPSHOT
Closes: #993
cc @niol