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

[OAS] Refresh Kibana serverless APIs #186853

Merged
merged 11 commits into from
Jul 18, 2024
Merged

[OAS] Refresh Kibana serverless APIs #186853

merged 11 commits into from
Jul 18, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 24, 2024

Summary

Relates to #186671, #186840, #187146

This PR:

  • Updates the introduction to include a technical preview admonition
  • Updates the linting rules to check operation identifiers
  • Re-generates the OpenAPI document to pick up changes to the Bedrock and Gemini connectors and the addition of APM operationIds.

I have omitted the updated kibana.serverless.yaml and deployed it manually for now.

@lcawl lcawl added Team:Docs release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting docs labels Jun 24, 2024
@obltmachine
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

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

@paulRbr
Copy link

paulRbr commented Jun 27, 2024

The API diff check failure relates to #186909

To clarify:

  • the github comment not being sent doesn't make the job fail currently in the Bump.sh github-action.
  • the current failure is due to a “breaking change” identified in the OAS changes because of the addition of operationIds on 3 operations. Bump.sh identifies this as 3 operations removal + 3 operations added:

bump diff --format markdown kibana.serverless.previous.yaml kibana.serverless.current.yam

Added (3)

  • GET /api/apm/services/{serviceName}/annotation/search
  • POST /api/apm/agent_keys
  • POST /api/apm/services/{serviceName}/annotation

Removed (3)

  • [Breaking] GET /api/apm/services/{serviceName}/annotation/search
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • [Breaking] POST /api/apm/agent_keys
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • [Breaking] POST /api/apm/services/{serviceName}/annotation
    • Removing a resource is always breaking unless it was deprecated before [Breaking]

@lcawl lcawl marked this pull request as ready for review July 17, 2024 02:12
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@lcawl lcawl requested a review from a team July 17, 2024 21:20
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lcawl lcawl enabled auto-merge (squash) July 18, 2024 16:07
@lcawl lcawl merged commit f4f936f into elastic:main Jul 18, 2024
19 checks passed
@lcawl lcawl deleted the oas-refresh branch July 18, 2024 16:21
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

@lcawl lcawl removed the backport:skip This commit does not require backporting label Jul 18, 2024
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Jul 18, 2024
lcawl added a commit to lcawl/kibana that referenced this pull request Jul 18, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Jul 18, 2024

Backported in 188700

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 docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants