chore(service): improve api docs #2103
Merged
Conversation
This file contains 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
|
You can access the deployment of this PR at https://renku-ci-rp-2103.dev.renku.ch |
|
I've removed the bit that added the api spec to the sphinx docs - it was not working properly (see e.g. sphinx-contrib/openapi#88 and sphinx-contrib/openapi#107) and caused build warnings which in turn made the docs CI fail. |
|
As agreed this morning, I added a stub for the service sphinx docs. |
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 PR fills in several of the API docstrings to add missing schemas. It also adds a description of the API including the response codes.
closes #2056
/deploy #notest