Skip to content

[APM] Add documentation for APM APIs  #129061

@dannycroft

Description

@dannycroft

In order to provide users with the best and most accurate documentation, all APM app API endpoints must be documented with the OpenAPI specification.

Initial support was added in #180096, but these are manually generated and incomplete.

We should probably stay as close as possible to the implementation for the SLO APIs: https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability_solution/slo/docs/openapi/slo

Consult with @elastic/obs-ux-management-team to determine observability standards for generating, maintaining, and publishing OpenAPI specs.

✅ Acceptance criteria

  • Steps to find and add OpenAPI documentation to a public Kibana API in observability are published (undecided: where? In the observability_solution plugin maybe?)
  • APM app API documentation is complete and accurate for all endpoints
  • Steps for updating documentation are published (ideally we would want everything automatically updated when we changed the code, but that's not required initially as long as process to update docs is documented and straightforward)
  • Notify docs team about availability of specs (@smith is tracking the internal issue to do this)

Sub-issues

Metadata

Metadata

Assignees

Labels

Team:obs-ux-infra_servicesObservability Infrastructure & Services User Experience Teamdocumentationneeds-refinementA reason and acceptance criteria need to be defined for this issuetechnical debtImprovement of the software architecture and operational architecture

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions