[OAS] Add operationId values for APM APIs #186840
Merged
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
lcawl
added
release_note:skip
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
botelastic
bot
added
ci:project-deploy-observability
|
Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services) |
💚 Build Succeeded
Metrics [docs]
HistoryTo update your PR or re-run it, just comment with: |
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.
Summary
Per https://spec.openapis.org/oas/v3.0.3#operation-object, operation IDs are optional, but they're used to generate the unique URL for each operation in Bump.sh. Without them, we get URLs that seem to be derived from the API path and contain a mix of dashes and underscores, e.g. "https://www.elastic.co/docs/api/doc/serverless/operation/operation-post-api-apm-agent_keys". With operation IDs the URL will look like this: ".../operation/operation-createagentkey"