Skip to content
New issue

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

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

Already on GitHub? # to your account

fix typo, style guide updates #27

Merged
merged 2 commits into from
Nov 15, 2024
Merged

fix typo, style guide updates #27

merged 2 commits into from
Nov 15, 2024

Conversation

jeremyfiel
Copy link
Contributor

I realize the style guide changes may not jive with your cli flag naming, but the official style guide defines how to reference each of the specifications and the artifacts associated with them.

@jeremyfiel jeremyfiel force-pushed the patch-1 branch 2 times, most recently from 5401d74 to 9b7e986 Compare November 12, 2024 23:02
@micovery
Copy link
Collaborator

Hey @jeremyfiel , thanks for the PR.

I was not aware of the terminology "OpenAPI description", I had to go and look it up, and sure enough that's what they are calling it now over at: https://learn.openapis.org/specification/structure.html#structure-of-an-openapi-description.

There is also the naming of the CLI flags for some commands that have spec in the name.

It will be a little weird that only this page uses the "OpenAPI description" term vs all other pages using "OpenAPI spec" term, but it's a good start.

@jeremyfiel
Copy link
Contributor Author

Ya i figured it may be a small clash

I tried to find all instances of them to change

@micovery micovery self-assigned this Nov 12, 2024
@jeremyfiel jeremyfiel force-pushed the patch-1 branch 2 times, most recently from 1a2b63c to 0e60ca3 Compare November 13, 2024 05:14
* Updated usage of the name Overlay, per the [Overlay style guide](https://github.com/OAI/Overlay-Specification/blob/main/CONTRIBUTING.md#style-guide-for-overlay-specification)
* Updated the usage of OpenAPI `Description`, per the [OpenAPI style guide](https://spec.openapis.org/oas/v3.0.4#introduction)
* Update example to use preferred keyword `examples`
@jeremyfiel
Copy link
Contributor Author

tried to find all the references and renamed files

@micovery
Copy link
Collaborator

tried to find all the references and renamed files

Hey, I've checked out your PR branch locally and ran the tests go test ./..., there a couple of test cases that are failing.

Let's get those fixed. If you want give me collaborator access on your fork of the repo, and I will add a commit with the test fixes.

Alternatively, you can cherry-pick this commit: 588c379 into your branch, to get the test fixes.

To cherry-pick, first checkout your own patch-1 branch, and then do this:

git remote add micovery https://github.com/micovery/apigee-go-gen.git
git fetch micovery
git cherry-pick 588c379cbbcdbd22a3c1df4ef90fba47230b004f

@jeremyfiel
Copy link
Contributor Author

this was updated, not sure if you saw the latest commit.

@micovery micovery merged commit 471d392 into apigee:main Nov 15, 2024
1 check passed
@micovery
Copy link
Collaborator

I've made the doc changes live (https://apigee.github.io/apigee-go-gen/). I will be doing a new binary and docker release sometime next week, as I have some other changes lined up.

Once again, thanks for the contribution!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants