As part of the Serverless project, we need to make sure OpenAPI specs for all public AI Assistant API endpoints are polished and ready to be published on a documentation website. Please look for more context in the epic, and please find below what needs to be done exactly.
API endpoints
The following public API endpoints were discovered during research:
[ ] 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
[ ] POST /api/elastic_assistant/current_user/conversations/{id}/messages
[ ] POST /api/elastic_assistant/current_user/conversations
[ ] GET /api/elastic_assistant/current_user/conversations/_find
Make sure the generated API reference documentation looks nice and correct on bump.sh.
Make sure the generated Serverless API reference documentation doesn't contain available only in ESS API endpoints.
Ask @maximpn to provide you with an example of a polished and documentation-ready OpenAPI spec. Please also ask @maximpn for a link to the generated API reference documentation (at the time of creating this ticket, it didn't exist).
Epic: https://github.com/elastic/security-team/issues/9528 Depends on: https://github.com/elastic/kibana/issues/183825, https://github.com/elastic/kibana/issues/183826
Deadline: Sep 24, 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 polished and ready to be published on a documentation website. Please look for more context in the epic, and please find below what needs to be done exactly.
API endpoints
The following public API endpoints were discovered during research:
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
POST /api/elastic_assistant/current_user/conversations/{id}/messages
POST /api/elastic_assistant/current_user/conversations
GET /api/elastic_assistant/current_user/conversations/_find
DELETE /api/elastic_assistant/current_user/conversations/{id}
GET /api/elastic_assistant/current_user/conversations/{id}
PUT /api/elastic_assistant/current_user/conversations/{id}
To do
For all the AI Assistant API endpoints (including those above), in the corresponding OpenAPI specification files, please:
Ask @maximpn to provide you with an example of a polished and documentation-ready OpenAPI spec. Please also ask @maximpn for a link to the generated API reference documentation (at the time of creating this ticket, it didn't exist).