use api generated docs instead of comments #92
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
arcan1s
force-pushed
the
feature/api-docs
branch
10 times, most recently
from
fde738b to
c89b7f1
Compare
arcan1s
force-pushed
the
feature/api-docs
branch
6 times, most recently
from
93b1541 to
5cfd8af
Compare
arcan1s
force-pushed
the
feature/api-docs
branch
from
5cfd8af to
5feaf0d
Compare
arcan1s
added a commit
that referenced
this pull request
Apr 5, 2023
arcan1s
added a commit
that referenced
this pull request
Apr 5, 2023
arcan1s
added
documentation
arcan1s
added a commit
that referenced
this pull request
Sep 30, 2024
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.
Summary
Instead of taking documenting HTTP in docstrings, lets try to use decorators as it is in normal languages. Currently there is only one library which provides descent support for documenting by decorators: https://github.com/maximdanilchenko/aiohttp-apispec
However, as we are using 3+ OpenAPI, support of it is still incomplete (see maximdanilchenko/aiohttp-apispec#46), but with some minor tweaks it works.
This MR implements OpenAPI and drops method descriptions from comments
Checklist
make checkpassedmake testspassed