feat: improve api-docs #40
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
rawongithub
force-pushed
the
revise-some-api-docs-decorators
branch
from
6a9c3da
to
35da7fc
Compare
rawongithub
force-pushed
the
revise-some-api-docs-decorators
branch
from
35da7fc
to
56416cb
Compare
| description: | ||
| 'Use only allowed properties separated by semicolon; default is ascending created_at; prefix name with hyphen/minus sign to get descending order', | ||
| 'Only whitelisted properties separated by semicolon; prefix with -/+ for DESC/ASC order', | ||
| example: '-created_at;filename', |
There was a problem hiding this comment.
this example doesn't work, and when using endpoints we need to remove this string in swagger, should it still be added to documentantion?
There was a problem hiding this comment.
This example shows just the format for the filter. As described above - only whitelisted properties are allowed for filtering. If proper ones used it does work.
nataszczypiora
approved these changes
Feb 12, 2024
espresse
approved these changes
Feb 12, 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.
Due to lack of examples provided for swagger module some tools may later generate incorrect sample data.
This PR adds some missing properties for some decorators to resolve this issue.