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

[HTTP/OAS] Add operation tags for APM APIs #181353

Merged
merged 4 commits into from
Jun 13, 2024
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Apr 22, 2024

Summary

Relates to #180056

This PR adds tags for the APM agent key and annotation APIs in the manually-maintained and automatically-generated API documents.

NOTE: I used "APM annotations" and "APM agent keys" as the tags to align with https://www.elastic.co/guide/en/kibana/current/apm-annotation-api.html and https://www.elastic.co/guide/en/kibana/current/agent-key-api.html, but if you prefer to group them all under a tag called "APM" that's okay too.

How to test

Per #181277:

  1. Start Elasticsearch (e.g. yarn es snapshot --license trial)
  2. Add server.oas.enabled: true to kibana.dev.yml
  3. Start Kibana (e.g. yarn start --no-base-path)
  4. curl -s -u elastic http://localhost:5601/api/oas\?pathStartsWith\=/api/apm | jq > test.json
    "paths": {
    "/api/apm/agent_keys": {
      "post": {
        "summary": "",
        "tags": [
          "APM agent keys"
        ]

...
    "/api/apm/services/{serviceName}/annotation/search": {
      "get": {
        "summary": "",
        "tags": [
          "APM annotations"
        ],

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting docs labels Apr 22, 2024
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl added the v8.15.0 label Jun 12, 2024
@lcawl lcawl changed the title [OAS] Serverless OpenAPI document edits [HTTP/OAS] Add operation tags for APM APIs Jun 12, 2024
@lcawl lcawl marked this pull request as ready for review June 12, 2024 20:01
@lcawl lcawl requested a review from a team as a code owner June 12, 2024 20:01
@botelastic botelastic bot added ci:project-deploy-observability Create an Observability project Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team labels Jun 12, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

@lcawl lcawl enabled auto-merge (squash) June 12, 2024 22:37
@kibana-ci
Copy link
Collaborator

kibana-ci commented Jun 12, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@lcawl lcawl merged commit 1c8fc1f into elastic:main Jun 13, 2024
26 checks passed
saikatsarkar056 pushed a commit to saikatsarkar056/kibana that referenced this pull request Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting ci:project-deploy-observability Create an Observability project docs release_note:skip Skip the PR/issue when compiling release notes Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants