Use operation summary and description in generated function docs #67
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.
Motivation
For generated functions for each operations we generate reference
documentation. Currently this only states the HTTP information and the
operation ID, and doesn't include either the
summary
or thedescription
that may be present in the OpenAPI document.
Modifications
Change the reference documentation to include both the summary and the
description if they are provided.
Result
Reference documentation for operation functions contains the documentation from
the OpenAPI document.
Test Plan
The OpenAPI document used in the reference test includes operations with and
without these fields.
Resolves