Draft: Add formal API documentation #205
Draft
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
added 30 commits
March 22, 2023 11:29
added 16 commits
April 24, 2023 18:45
|
I think this can be better solved using https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-openapi.html which @julien-nc is working on afaik. Your documentation looks very good though, so it could be copied to the controllers and automatically appear in the OpenAPI specification. |
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 is a (probably still incomplete) draft PR. It only adds to the documentation.
The goal of the PR is to provide a comprehensive documentation about the API of Cospend, which is currently non-existent.
As I spent a long time, and it is quite a large document, I would appreciate if multiple eyes could have a look at it, and suggest changes or point mistakes/inconsistencies. I definitely have changed my style while I was writing this, as I was learning more and more about Cospend.
It's probably "good enough" to be already used, but it should also definitely be refined a bit.