Skip to content

[OAS][DOCS] Clarify license, version, and source URL #2859

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 2 commits into from
Sep 5, 2024
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Sep 5, 2024

This PR removes the info.license overlay implemented in #2817, since per https://spec.openapis.org/oas/v3.0.3#info-object the info.license pertains to the API license, not the documentation license.

I've moved the documentation license information to a custom extension and to the info.description until that extension is supported. I've also added a comment about which branch and repo the documentation is derived from.

Preview

image

@lcawl lcawl added the OpenAPI label Sep 5, 2024
@lcawl lcawl marked this pull request as ready for review September 5, 2024 01:28
@lcawl lcawl requested a review from szabosteve September 5, 2024 14:11
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM!

@lcawl lcawl merged commit 1bbd45a into main Sep 5, 2024
7 checks passed
@lcawl lcawl deleted the oas-source branch September 5, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants