Skip to content

Use operation summary and description in generated function docs #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 15, 2023

Conversation

simonjbeaumont
Copy link
Collaborator

@simonjbeaumont simonjbeaumont commented Jun 14, 2023

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

Signed-off-by: Si Beaumont <beaumont@apple.com>
@simonjbeaumont simonjbeaumont added the 🔨 semver/patch No public API change. label Jun 14, 2023
@simonjbeaumont simonjbeaumont requested a review from czechboy0 June 14, 2023 01:50
@simonjbeaumont simonjbeaumont marked this pull request as ready for review June 15, 2023 15:09
@simonjbeaumont simonjbeaumont requested a review from czechboy0 June 15, 2023 15:09
Copy link
Contributor

@czechboy0 czechboy0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@simonjbeaumont simonjbeaumont enabled auto-merge (squash) June 15, 2023 19:41
@simonjbeaumont simonjbeaumont merged commit cfe0780 into apple:main Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 semver/patch No public API change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include the user-provided operation description in the generated doc comment
2 participants