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.

Sign up for GitHub

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

Jump to bottom

[Security Solution] Improve OpenAPI specs for Detections API #183702

Open
30 tasks
Tracked by #200310
maximpn opened this issue May 17, 2024 · 6 comments
Open
30 tasks
Tracked by #200310

[Security Solution] Improve OpenAPI specs for Detections API #183702

maximpn opened this issue May 17, 2024 · 6 comments
Assignees
@yctercero
Labels
docs Team:Detection Engine Security Solution Detection Engine Area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.

Comments

@maximpn
Copy link
Contributor

maximpn commented May 17, 2024 •
edited by banderror
Loading

Epic: #200310

Summary

We need to make our API reference docs for Detections API more user-friendly and usable. For that, we need to improve and polish the corresponding OpenAPI specs: enrich them with summaries, descriptions, examples of usage, etc:

  • Add summaries for:
    • API endpoints
    • HTTP methods
  • Add descriptions for:
    • API endpoints
    • HTTP methods
    • endpoint's parameters
    • requests
    • responses
    • shared schemas
  • Add examples of usage of each API endpoint.
  • Make sure the generated API reference documentation looks nice and correct on bump.sh.

API endpoints

The following public API endpoints are available in both Serverless and ESS:

  • GET /api/detection_engine/rules
  • POST /api/detection_engine/rules
  • PUT /api/detection_engine/rules
  • PATCH /api/detection_engine/rules
  • DELETE /api/detection_engine/rules
  • POST /api/detection_engine/rules/_bulk_action
  • POST /api/detection_engine/rules/_export
  • POST /api/detection_engine/rules/_import
  • GET /api/detection_engine/rules/_find
  • GET /api/detection_engine/tags
  • GET /api/detection_engine/rules/prepackaged/_status
  • PUT /api/detection_engine/rules/prepackaged
  • POST /api/detection_engine/rules/preview
  • POST /api/detection_engine/signals/status
  • POST /api/detection_engine/signals/tags
  • POST /api/detection_engine/signals/search
  • POST /api/detection_engine/signals/assignees
  • GET /api/detection_engine/privileges
  • POST /api/detection_engine/rules/{id}/exceptions

The following public API endpoints are available in ESS only:

  • POST /api/detection_engine/rules/_bulk_create
  • PUT /api/detection_engine/rules/_bulk_update
  • PATCH /api/detection_engine/rules/_bulk_update
  • DELETE /api/detection_engine/rules/_bulk_delete
  • POST /api/detection_engine/rules/_bulk_delete
  • GET /api/detection_engine/signals/migration_status
  • POST /api/detection_engine/signals/migration
  • POST /api/detection_engine/signals/finalize_migration
  • POST /api/detection_engine/index
  • GET /api/detection_engine/index
  • DELETE /api/detection_engine/index
@maximpn maximpn added docs Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Rule Management Security Detection Rule Management Team Project:Serverless Work as part of the Serverless project for its initial release Team:Detection Engine Security Solution Detection Engine Area labels May 17, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)

@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detection-engine (Team:Detection Engine)

@banderror banderror changed the title [Security Solution] Make existing OpenAPI specs for Detection Engine API documentation-ready [Security Solution] Make existing OpenAPI specs for Detections API documentation-ready May 17, 2024
@banderror banderror removed the Project:Serverless Work as part of the Serverless project for its initial release label Jun 4, 2024
@maximpn maximpn mentioned this issue Jun 7, 2024
Merged
Merged
@natasha-moore-elastic
Copy link
Contributor

Hi @banderror & @maximpn, as part of a Docs OnWeek project, I made some editorial suggestions to the Detections API specs, mostly adding missing operation summaries and descriptions, or making changes to existing ones to align with our guidelines. Letting you know as this partially addresses some of the work planned in this issue. Here's the related PR: #187224.

@banderror
Copy link
Contributor

@natasha-moore-elastic Thanks for this contribution, I might be able to take a quick look this week, and @maximpn will review the PR in detail when he's back from PTO.

natasha-moore-elastic added a commit that referenced this issue Jul 18, 2024
@natasha-moore-elastic @kibanamachine
[DOCS] Improves Detections API docs content (#187224)
ac5beb6 
## Summary

Resolves elastic/docs-projects#219 by
improving the Detections API docs content. Adds missing and improves
existing operation summaries and operation descriptions.

Also addresses some of the work planned in
#183702.

---------

Co-authored-by: kibanamachine <[email protected]>
@maximpn maximpn mentioned this issue Aug 7, 2024
Closed
4 tasks
@banderror banderror mentioned this issue Nov 15, 2024
Open
@banderror banderror changed the title [Security Solution] Make existing OpenAPI specs for Detections API documentation-ready [Security Solution] Improve OpenAPI specs for Detections API Nov 15, 2024
@yctercero yctercero self-assigned this Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yctercero yctercero

Labels
docs Team:Detection Engine Security Solution Detection Engine Area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@maximpn @banderror @yctercero @elasticmachine @natasha-moore-elastic