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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Add openAPI specification for APM server information API #12862

Merged
merged 8 commits into from
Mar 28, 2024
Merged

[DOCS] Add openAPI specification for APM server information API #12862

merged 8 commits into from
Mar 28, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Mar 25, 2024

This PR creates an openAPI specification for documentation purposes to replace https://www.elastic.co/guide/en/observability/current/api-info.html

@mergify Mergify
Copy link
Contributor

mergify bot commented Mar 25, 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 Mar 25, 2024
axw
axw reviewed Mar 26, 2024
View reviewed changes
docs/spec/openapi/apm-openapi.yaml Outdated Show resolved Hide resolved
docs/spec/openapi/apm-openapi.yaml Show resolved Hide resolved
@lcawl lcawl marked this pull request as ready for review March 26, 2024 16:32
@lcawl lcawl requested a review from a team as a code owner March 26, 2024 16:32
@lcawl lcawl requested a review from simitt March 26, 2024 16:32
axw
axw previously approved these changes Mar 27, 2024
View reviewed changes
docs/spec/openapi/apm-openapi.yaml Show resolved Hide resolved
@lcawl lcawl added the docs label Mar 27, 2024
@kruskall kruskall merged commit 2dcfaa9 into elastic:main Mar 28, 2024
8 checks passed
@lcawl lcawl mentioned this pull request Apr 2, 2024
Closed
6 tasks
@simitt simitt mentioned this pull request Apr 3, 2024
Closed
@lcawl lcawl deleted the apm-server-oas branch April 9, 2024 19:42
lcawl added a commit to lcawl/apm-server that referenced this pull request Apr 9, 2024
@lcawl
[DOCS] Add openAPI specification for APM server information API (elas…
6191ad3 
…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
@lcawl lcawl mentioned this pull request Apr 9, 2024
Merged
carsonip pushed a commit that referenced this pull request Apr 12, 2024
@lcawl
[DOCS] Add openAPI specification for APM agent configuration endpoints (
95a29b6 
#12948)

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@axw axw axw approved these changes

@simitt simitt Awaiting requested review from simitt

Assignees
No one assigned
Labels
backport-skip Skip notification from the automated backport with mergify docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lcawl @axw @kruskall