-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use operation summary and description in generated function docs (#67)
### 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 the `description` 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 - Resolves #64. --------- Signed-off-by: Si Beaumont <[email protected]>
- Loading branch information
1 parent
907abfa
commit cfe0780
Showing
5 changed files
with
100 additions
and
69 deletions.
There are no files selected for viewing
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
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
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
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
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