Add summary and description provider to improve documentation #122
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
Collaborator
thschmitt
commented
Sep 26, 2024
thschmitt
commented
- Added descriptionProvider which can be used to override command summaries and descriptions in order to improve the documentation
- Extended command structs with summary and description fields
- Updated to latest OpenAPI definitions with improved summaries
thschmitt
requested review from
radu-iviniciu and
florin-szilagyi
as code owners
thschmitt
force-pushed
the
feature/improve-command-documentation
branch
from
a18cc08
to
e308086
Compare
- Added descriptionProvider which can be used to override command summaries and descriptions in order to improve the documentation - Extended command structs with summary and description fields - Updated to latest OpenAPI definitions with improved summaries
thschmitt
force-pushed
the
feature/improve-command-documentation
branch
from
e308086
to
12167ac
Compare
radu-iviniciu
approved these changes
Oct 3, 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.