-
Notifications
You must be signed in to change notification settings - Fork 525
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
[DOCS] Add openAPI specification for APM agent configuration endpoints #12948
Conversation
…tic#12862) * [DOCS] Add openAPI specification for APM server information API * [DOCS] Fix responses * [DOCS] Add text/plain response and examples * Remove invalid text/plain example
This pull request does not have a backport label. Could you fix it @lcawl? 🙏
NOTE: |
description: APM Server is configured to fetch agent configuration from Elasticsearch but the configuration is invalid. | ||
'503': | ||
description: APM Server is starting up or Elasticsearch is unreachable. | ||
/config/v1/rum/agents: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought rum agentcfg endpoint is almost identical to the regular one, with the exception of auth check and the actual endpoint
And thanks for translating it from docs to openAPI spec. It really shows how much is missing from the existing docs. |
I wonder if you'd be willing to accept the document in this current state so we have minimal parity with the existing docs. Then I can finish doing the rest of the endpoints and circle back to help add more descriptions and missing values. We want to ensure it's at least as good as the existing docs before we start migrating the rest of the Observabilty docs to the new docs system. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's merge on parity and revisit these suggestions later.
Relates to #12903
This PR updates the OpenAPI specification to include details from https://www.elastic.co/guide/en/observability/current/apm-api-config.html
Related to the outstanding issue #12904, this PR re-adds the original file from #12862