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

[EDR Workflows] Create missing OpenAPI specs for Endpoint management API #187261

Merged
merged 7 commits into from
Jul 5, 2024

Conversation

szwarckonrad
Copy link
Contributor

@szwarckonrad szwarckonrad commented Jul 1, 2024

This PR adds OpenAPI schemas for Defend Workflows API endpoints that previously didn't have them. Here are the changes made:

  1. Added a schema for /api/endpoint/isolate, which is deprecated and now redirects as a 308 to the new path (/api/endpoint/action/isolate). It's tagged with x-labels as ess only.
  2. Added a schema for /api/endpoint/unisolate, which is deprecated and now redirects as a 308 to the new path (/api/endpoint/action/unisolate). It's tagged with x-labels as ess only.
  3. Added a schema for /api/endpoint/protection_updates_note/{package_policy_id}.
  4. Added x-labels field to all existing Defend Workflows API paths for proper tagging.

For more information on x-labels, please refer to #184348

@szwarckonrad szwarckonrad added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:Defend Workflows “EDR Workflows” sub-team of Security Solution v8.16.0 labels Jul 1, 2024
@szwarckonrad szwarckonrad self-assigned this Jul 1, 2024
@szwarckonrad szwarckonrad linked an issue Jul 1, 2024 that may be closed by this pull request
6 tasks
@szwarckonrad
Copy link
Contributor Author

/ci

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @szwarckonrad

schema:
type: string
example: "/api/endpoint/action/unisolate"
'200':
Copy link
Contributor Author

Choose a reason for hiding this comment

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

'200' status being present is required in generator

schema:
type: string
example: "/api/endpoint/action/isolate"
'200':
Copy link
Contributor Author

Choose a reason for hiding this comment

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

'200' status being present is required in generator

@szwarckonrad szwarckonrad marked this pull request as ready for review July 2, 2024 14:06
@szwarckonrad szwarckonrad requested a review from a team as a code owner July 2, 2024 14:06
@szwarckonrad szwarckonrad requested review from pzl and paul-tavares July 2, 2024 14:06
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-defend-workflows (Team:Defend Workflows)

@szwarckonrad szwarckonrad requested review from tomsonpl and removed request for pzl July 2, 2024 14:06
Copy link
Contributor

@tomsonpl tomsonpl left a comment

Choose a reason for hiding this comment

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

🚀

@szwarckonrad szwarckonrad enabled auto-merge (squash) July 5, 2024 12:59
@szwarckonrad szwarckonrad merged commit 68d5370 into elastic:main Jul 5, 2024
38 of 39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Defend Workflows “EDR Workflows” sub-team of Security Solution v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Security Solution] Create missing OpenAPI specs for Endpoint management API
5 participants