feat: route doc descriptions #322
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
ChrisPdgn
changed the title
ChrisPdgn
requested review from
kon14,
kkopanidis,
sdimitris and
SotiriaSte
and removed request for
kon14
kon14
previously requested changes
Sep 14, 2022
There was a problem hiding this comment.
Remove explicit references to required params in descriptions (eg requiring only ...) as these can become outdated and are otherwise already documented for each route outside the description.
Remove the all part from getters (eg Returns all forms) as most of them can be queried, or at the very least paginated, based on other params etc.
packages/core/src/config-manager/admin/routes/GetConfigRoute.ts
Outdated
Show resolved
Hide resolved
packages/core/src/config-manager/admin/routes/GetModules.route.ts
Outdated
Show resolved
Hide resolved
kon14
changed the title
kkopanidis
approved these changes
Sep 15, 2022
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.
What kind of change does this PR introduce?
Does this PR introduce a breaking change?
The PR fulfills these requirements:
mainbranchfix #xxx, where "xxx" is the issue number)