DEVDOCS-4878: [external] API specs, update Operation IDs to be consistent & programmatic #45
Conversation
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
Otherwise OpenAPI parsing error is:
Colons must be followed by a space or an indication character (i.e. " ", ",", "[", "]", "{", "}") at line 2195 (near "value: {\"originalName\":\"BigCommerceLogo.jpeg\",\"temporaryPath\":\"121_fbfb71dfc5a5d911f62d8e35dedd6e45.jpeg\",\"path\":\"f606efcae7e179970b19c3658142c5d0.jpeg\"}").
…conventions. As per OpenAPI specification guidance for operationID field, follow programmatic conventions for operationId field. To me that means as if I were defining a method or function name. This field is not used in the API docs as far as I can tell. There were many different naming conventions across APIs. I've aligned to be camel case. This help facilitate API SDK generation as all endpoints can have a function named based on the operation ID and it have sufficient context to be unique amongst all APIs
added 3 commits
January 15, 2024 10:15
…mmerce/docs into bobbyshaw-consistent-operation-ids
|
Merging following review from @bobbyshaw. If this commit broke your API client, see https://github.com/bigcommerce/docs/releases/tag/before-operation-id-change. |
bc-tgomez
pushed a commit
that referenced
this pull request
Apr 26, 2024
…tent & programmatic (#45) <!-- Ticket number or summary of work --> # [DEVDOCS-4878] > As per OpenAPI specification guidance for operationID field, follow programmatic conventions for operationId field. To me that means as if I were defining a method or function name. > This field is not used in the API docs as far as I can tell. There were many different naming conventions across APIs. I've aligned to be camel case. > This helps facilitate API SDK generation as all endpoints can have a function name based on the operation ID and have it have sufficient context to be unique amongst all APIs. ## What changed? * Make operation IDs consistent and follow programmatic conventions ## Release notes draft * A valued partner has put in the heroic work to make the OAS operation IDs programmatic across our public APIs. The operationId property is now consistently camelCase and relates to the plain-language name of the endpoint. Thanks, @bobbyshaw! ## Anything else? * Original PR [bigcommerce/api-specs 1469](bigcommerce/api-specs#1469) * Related Issue [bigcommerce/api-specs 1143](bigcommerce/api-specs#1143) * Tag for last commit before this -- https://github.com/bigcommerce/docs/releases/tag/before-operation-id-change --------- Co-authored-by: Tom Robertshaw <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DEVDOCS-4878
What changed?
Release notes draft
Anything else?
ping @bobbyshaw @bc-hnbarr @becomevocal @bigcommerce/dev-docs-team