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 events intake API #12982

Merged
merged 2 commits into from
Apr 17, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Apr 16, 2024

This PR creates an openAPI specification for documentation purposes to replace:

NOTE:

  1. This PR re-adds the deleted OpenAPI document per outstanding Fix automation, bring back openAPI spec #12904.
  2. The examples for error, span, and transaction events (copied from https://www.elastic.co/guide/en/observability/current/apm-api-event-example.html) are currently commented out because they fail to validate successfully against the specification. I'm assuming it's the examples that are at fault rather than the specification.
  3. I've used redocly bundle command to import the referenced content into bundled.* files, since our API docs hosting site doesn't support the multi-file approach.

@lcawl lcawl added docs backport-skip Skip notification from the automated backport with mergify labels Apr 16, 2024
Copy link
Contributor

mergify bot commented Apr 16, 2024

This pull request is now in conflicts. Could you fix it @lcawl? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b apm-events-intake upstream/apm-events-intake
git merge upstream/main
git push upstream apm-events-intake

@lcawl lcawl force-pushed the apm-events-intake branch from 4a0422d to a520b55 Compare April 16, 2024 21:41
@lcawl lcawl marked this pull request as ready for review April 16, 2024 22:16
@lcawl lcawl requested a review from a team as a code owner April 16, 2024 22:16
@kruskall
Copy link
Member

ugh, sorry about the openapi spec removal :(

I plan to figure out what's wrong with it soon

@kruskall kruskall merged commit 7484b71 into elastic:main Apr 17, 2024
9 checks passed
@lcawl lcawl deleted the apm-events-intake branch April 17, 2024 17:14
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.

2 participants