Skip to content
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

Add support for .yml extension (openapi.yml and openapi-generator-config.yml) #77

Merged
merged 3 commits into from
Jun 19, 2023

Conversation

Kyle-Ye
Copy link
Contributor

@Kyle-Ye Kyle-Ye commented Jun 19, 2023

Motivation

Some openapi file use .yml as the yaml file extension, we should support this instead of forcing user to rename it.

https://github.com/discourse/discourse_api_docs/blob/main/openapi.yml

Modifications

Add yml file extension support

Result

[After your change, what will change.]

Test Plan

[Describe the steps you took, or will take, to qualify the change - such as adjusting tests and manual testing.]

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.

Completely reasonable, and follows precedent we set with openapi.yaml vs openapi.json.

Just a style nit, otherwise lgtm.

@czechboy0
Copy link
Contributor

@swift-server-bot test this please

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.

The new multiple configs checking logic needs a bit of work.

@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Jun 19, 2023

The soundness test passed locally. If there are no other issues, would you mind help run the test again? @czechboy0

** ✅ Successfully built integration test package.
** ✅ All soundness check(s) passed.

@Kyle-Ye Kyle-Ye requested a review from czechboy0 June 19, 2023 16:05
@czechboy0
Copy link
Contributor

@swift-server-bot add to allowlist

Copy link
Collaborator

@simonjbeaumont simonjbeaumont left a comment

Choose a reason for hiding this comment

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

Thanks for helping with this @Kyle-Ye!

@simonjbeaumont simonjbeaumont changed the title Add yml file extension support Add support for .yml extension (openapi.yml and openapi-generator-config.yml) Jun 19, 2023
@simonjbeaumont simonjbeaumont merged commit 2c52179 into apple:main Jun 19, 2023
@Kyle-Ye Kyle-Ye deleted the bugfix/yml branch June 19, 2023 18:09
@czechboy0 czechboy0 added 🆕 semver/minor Adds new public API. 🔨 semver/patch No public API change. and removed 🆕 semver/minor Adds new public API. labels Jun 20, 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.

3 participants