Skip to content
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

Merged
merged 9 commits into from
Apr 12, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Apr 9, 2024

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

…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
Copy link
Contributor

mergify bot commented Apr 9, 2024

This pull request does not have a backport label. Could you fix it @lcawl? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-7.17 is the label to automatically backport to the 7.17 branch.
  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit.

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Apr 9, 2024
@lcawl lcawl added the docs label Apr 9, 2024
@lcawl lcawl marked this pull request as ready for review April 9, 2024 22:43
@lcawl lcawl requested a review from a team as a code owner April 9, 2024 22:43
docs/spec/openapi/apm-openapi.yaml Show resolved Hide resolved
docs/spec/openapi/apm-openapi.yaml Show resolved Hide resolved
docs/spec/openapi/apm-openapi.yaml Show resolved Hide resolved
docs/spec/openapi/apm-openapi.yaml Outdated Show resolved Hide resolved
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:
Copy link
Member

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

@carsonip
Copy link
Member

And thanks for translating it from docs to openAPI spec. It really shows how much is missing from the existing docs.

@lcawl
Copy link
Contributor Author

lcawl commented Apr 11, 2024

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.

docs/spec/openapi/apm-openapi.yaml Outdated Show resolved Hide resolved
Copy link
Member

@carsonip carsonip left a 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.

@carsonip carsonip enabled auto-merge (squash) April 12, 2024 07:57
@carsonip carsonip merged commit 95a29b6 into elastic:main Apr 12, 2024
8 checks passed
@lcawl lcawl deleted the apm-agent-config-oas branch April 12, 2024 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-skip Skip notification from the automated backport with mergify docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants