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

[Obs AI Assistant] OpenAPI spec for public API #183151

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dgieselaar
Copy link
Member

Adds an OpenAPI spec for the public API.

@dgieselaar dgieselaar added release_note:skip Skip the PR/issue when compiling release notes v8.14.0 v8.15.0 labels May 10, 2024
@dgieselaar dgieselaar self-assigned this May 10, 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.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@dgieselaar dgieselaar force-pushed the obs-ai-assistant-openapi-docs branch from b657fd9 to b30d428 Compare May 10, 2024 13:05
title: Elastic AI Assistant for Observability
version: 1.0.0
paths:
"/api/observability_ai_assistant/chat/complete":
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice! Not sure it's in this PR code, what generated this spec?

Copy link
Member Author

Choose a reason for hiding this comment

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

it's here: https://github.com/elastic/kibana/pull/183151/files#diff-012b20f075e09f40a1839b759082ffea0122aeb79d6b5fd5e642f9abee2435e2, from there it's mostly JSON to YML if needed which is fairly trivial

Copy link
Member Author

Choose a reason for hiding this comment

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

we can do it automatically if we have an API from core, but I'm not sure if we can get to full coverage. custom io-ts types are ignored for instance.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh sorry, my q was not clear: I meant the entire OAS document. The schema parts were generated, but the openapi, info parts were manually added by you?

@dgieselaar
Copy link
Member Author

dgieselaar commented May 10, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes v8.14.0 v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants