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

[Request] Automatic Import - OpenAPI/CEL #6383

Open
jamiehynds opened this issue Jan 3, 2025 · 0 comments
Open

[Request] Automatic Import - OpenAPI/CEL #6383

jamiehynds opened this issue Jan 3, 2025 · 0 comments

Comments

@jamiehynds
Copy link

Description

When users build integrations with Automatic Import, they can specify how they want to ingest the data - e.g. from a file, an S3 bucket or via an API. While some data collection methods are straight forward (e.g. you can point to a file by entering a file path), ingesting data via an API is a challenge.

When a users wants to ingest data via an API, they need to be familiar with the Common Event Language , as this is what our integrations use to interact with API's. CEL is very developer focused and our users typically have no knowledge of it. They end up creating an integration with Automatic Import, but get stuck on how to actually start ingesting that data using CEL.

Our goal is to ask a user for some information about the API they want to integrate with, and use GenAI to build the required CEL configuration in order to start ingesting events. This ensure users can successfully use Automatic Import integrations to ingest via API's, without needing to build CEL code.

What information do we require in order to automatically build the required CEL code? OpenAPI spec files. These OpenAPI spec files, tell us (or an LLM) everything we need to know about an API in order to build out the code on our end. The spec file will include which API endpoints are available, how we authenticate, rate limits etc. A user needs to locate the OpenAPI spec file (if one exists) for the API they are integrating with, and provide it to Auto Import as they're building out the integration. Once complete, Auto Import will provide the CEL code needed to interact withe API.

Background & resources

Which documentation set does this change impact?

ESS and serverless

ESS release

8.18

Serverless release

TBD

Feature differences

n/a

API docs impact

n/a

Prerequisites, privileges, feature flags

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant