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

[Security Solution] Make existing OpenAPI specs for AI Assistant API correct #183826

Open
5 tasks
maximpn opened this issue May 20, 2024 · 1 comment
Open
5 tasks
Labels
8.15 candidate docs Project:Serverless Work as part of the Serverless project for its initial release Team:Security Generative AI Security Generative AI Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.

Comments

@maximpn
Copy link
Contributor

maximpn commented May 20, 2024

Epic: https://github.com/elastic/security-team/issues/9528

Deadline: Jul 29, 2024 (see milestones in https://github.com/elastic/security-team/issues/9400)

Summary

As part of the Serverless project, we need to make sure OpenAPI specs for all public AI Assistant API endpoints are correct. We want all the APIs documented before Serverless GA. Please look for more context in the epic.

During a Security Solution public API research we discovered that for some of the public AI Assistant API endpoints we already have OpenAPI specs. We just need to make sure they are correct. Please see below what needs to be done exactly.

API endpoints

The following public API endpoints were discovered during research, and have OpenAPI specs:

  • POST /api/elastic_assistant/anonymization_fields/_bulk_action
  • GET /api/elastic_assistant/anonymization_fields/_find
  • POST /api/elastic_assistant/prompts/_bulk_action
  • GET /api/elastic_assistant/prompts/_find
  • POST /api/elastic_assistant/prompts/_bulk_action

To do

  • Check if there are any other public endpoints that you own that have OpenAPI specs and add them to the list above.
  • Make sure your specs (including those above) are valid OpenAPI documents.
  • Make sure your specs (including those above) match the actual API contracts defined in the code.
  • Mark the endpoints as available in ESS, or Serverless, or in both offerings (depends on: https://github.com/elastic/security-team/issues/9516).
@maximpn maximpn added docs Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Project:Serverless Work as part of the Serverless project for its initial release Team:Security Generative AI Security Generative AI 8.15 candidate labels May 20, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.15 candidate docs Project:Serverless Work as part of the Serverless project for its initial release Team:Security Generative AI Security Generative AI Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
Projects
None yet
Development

No branches or pull requests

2 participants