Add APM OpenAPI spec #180096
Add APM OpenAPI spec #180096
Conversation
botelastic
bot
added
the
Team:obs-ux-infra_services
|
Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services) |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
smith
added
release_note:skip
There was a problem hiding this comment.
Just a few notes, but since it's going to be replaced with automatically-generated content, most of it should be fine when that happens.
I wonder if we'll use something like tsoa to generate the openapi spec. I hope the solution also provides examples of usage.
| enum: | ||
| - event:write | ||
| - config_agent:read | ||
| responses: |
There was a problem hiding this comment.
This endpoint also returns 400 and 403. Should we doc that too?
There was a problem hiding this comment.
Not at this time. These specs are incomplete and we're going to be updating them.
| type: string | ||
|
|
||
| responses: | ||
| '200': |
There was a problem hiding this comment.
It also responds with 404
| schema: | ||
| type: string | ||
| responses: | ||
| "200": |
There was a problem hiding this comment.
This one seems to return 500 when business logic error happens - should be 400 though.
Add a YAML OpenAPI spec for some of the APM APIs.
This spec was artisanally crafted by @sorenlouv and previously published https://gist.github.com/sorenlouv/19fb1ffc0b7552fb41b193462d6ee9db. It has been copied here to fulfill some requirements for https://github.com/elastic/docs-projects/issues/175.
We will prioritize the existing issue #129061 to replace the contents with automatically-generated and complete specs.