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 OpenTelemetry and Jaeger event intake API to OpenAPI document #13056

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Apr 26, 2024

Relates to #12903

This PR updates the OpenAPI specification to include details from https://www.elastic.co/guide/en/observability/current/apm-api-otlp.html and https://www.elastic.co/guide/en/observability/current/apm-api-jaeger.html

There were no details about the type of request and response received from these APIs, so I've left them generic for now.

NOTE: I've also used the "redocly split" command to split out the source files for the OpenAPI components and paths,etc. so that they can be used to also generate documents for the Serverless APIs

Copy link
Contributor

mergify bot commented Apr 26, 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 26, 2024
@lcawl lcawl marked this pull request as ready for review April 26, 2024 18:42
@lcawl lcawl requested a review from a team as a code owner April 26, 2024 18:42
@lcawl lcawl changed the title [DOCS] Add OpenTelemetry intake API to OpenAPI document [DOCS] Add OpenTelemetry and Jaeger event intake API to OpenAPI document Apr 26, 2024
@lcawl lcawl marked this pull request as draft May 8, 2024 16:47
@lcawl lcawl marked this pull request as ready for review May 8, 2024 20:47
@lcawl
Copy link
Contributor Author

lcawl commented May 8, 2024

@simitt I've added deprecated: true to the Jaeger operations but if you prefer that I remove those paths entirely, I can do that instead.

@simitt
Copy link
Contributor

simitt commented May 13, 2024

@elastic/obs-ds-intake-services please give this PR a review.
@carsonip has #11671 assigned for this iteration to deprecate Jaeger, this should align with this PR.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants