[APM] Version public APIs #158233
Merged
[APM] Version public APIs #158233
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
dgieselaar
added
release_note:skip
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
|
Pinging @elastic/apm-ui (Team:APM) |
yngrdyn
reviewed
May 23, 2023
|
@elasticmachine merge upstream |
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]Async chunks
Unknown metric groupsESLint disabled line counts
Total ESLint disabled count
History
To update your PR or re-run it, just comment with: |
gbamparop
reviewed
May 25, 2023
| > | ||
| )({ | ||
| path: pathname, | ||
| access: pathname.includes('/internal/apm') ? 'internal' : 'public', |
There was a problem hiding this comment.
Is seems that we rely more and more to the naming scheme to distinguish internal / public APIs, wondering if we can improve this. It's also mentioned here #151940
There was a problem hiding this comment.
What do you think needs improvement? You'd rather have an explicit access prop on all routes?
There was a problem hiding this comment.
This might be an idea but not too precious about it
delanni
pushed a commit
to delanni/kibana
that referenced
this pull request
May 25, 2023
Closes elastic#155245 Adds a version to the `endpoint` name for public APIs. It's required for public APIs and enforced via type checks. Example: `GET /api/apm/settings/agent-configuration/environments 2023-05-22`. The reason why it's part of the endpoint is because it's the simplest change to make, requires very little runtime changes and doesn't dramatically change the way we handle type-safety for our server routes. --------- Co-authored-by: kibanamachine <[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.
Closes #155245
Adds a version to the
endpointname for public APIs. It's required for public APIs and enforced via type checks. Example:GET /api/apm/settings/agent-configuration/environments 2023-05-22. The reason why it's part of the endpoint is because it's the simplest change to make, requires very little runtime changes and doesn't dramatically change the way we handle type-safety for our server routes.