[EDR Workflows] OpenApi Missing Content - Response Actions #212510
Merged
+2,937
−556
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
szwarckonrad
added
release_note:skip
|
Pinging @elastic/security-defend-workflows (Team:Defend Workflows) |
..._solution/common/api/endpoint/actions/response_actions/kill_process/kill_process.schema.yaml
Outdated
Show resolved
Hide resolved
| allOf: | ||
| - $ref: '../../../model/schema/common.schema.yaml#/components/schemas/BaseActionSchema' | ||
| GetProcessesRouteResponse: |
There was a problem hiding this comment.
We should include a note on this one indicating that for SentinelOne, the results are in a zip file that must be downloaded via the /api/endpoint/action/{action_id}/file/{file_id}/download api
(Future: we can probably improve this response to include the relative URL to the download in the outputs)
There was a problem hiding this comment.
Comment on lines
52
to
53
| description: "The file content to be uploaded or a relative path to the file. Note the path must be preceded with @." | ||
| example: "@fix-malware.sh" |
There was a problem hiding this comment.
Not sure I understand this here... the @ mentions here are very specific to using curl (maybe?) and I would say you probably want to keep this generic. The file param must be the file's binary content and must be sent using Content-Type: multipart/form-data
There was a problem hiding this comment.
You are right, I copied over an example from https://www.elastic.co/guide/en/security/8.17/upload-api.html
I went with more generic description here - c1e8440
| @@ -25,10 +25,12 @@ components: | |||
| example: 10 | |||
| StartDate: | |||
| type: string | |||
| description: Start date | |||
| description: A start date in ISO format or Date Math format. | |||
There was a problem hiding this comment.
Suggestion: add the ISO format type since ISO has many formats: ISO 8601
…/endpoint/actions/response_actions/kill_process/kill_process.schema.yaml Co-authored-by: Paul Tavares <[email protected]>
...tions/security/plugins/security_solution/common/api/endpoint/model/schema/common.schema.yaml
Outdated
Show resolved
Hide resolved
|
|
||
| components: | ||
| schemas: | ||
| UploadRouteRequestBody: | ||
| example: |
There was a problem hiding this comment.
The example doesn't have the parameters object, which is marked as required in the schema. If it's actually optional, we should fix that in the schema.
There was a problem hiding this comment.
Checked and we do require parameters even though it can be empty (overwrite property can be undefined). Added empty parameters to the example to reflect that. - feea112
| format: binary | ||
| UploadRouteResponse: |
There was a problem hiding this comment.
This example looks off in the preview:
There was a problem hiding this comment.
Nice catch, it was supposed to be request, not response 😄 .
About the format - while most of our responses and requests are of type application/json this particular request takes in a file hence the use of multipart/form-data. What we can see on your screenshot is apparently how such data type is being rendered with openapi schemas 🤔 feea112
…/endpoint/model/schema/common.schema.yaml Co-authored-by: natasha-moore-elastic <[email protected]>
natasha-moore-elastic
approved these changes
Feb 28, 2025
|
Starting backport for target branches: 8.16, 8.17, 8.18, 8.x, 9.0 |
💚 Build Succeeded
Metrics [docs]
History
|
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Feb 28, 2025
…12510) ## For reviewers: Only `*.schema.yml` files were edited (excluding `*.bundled.schema.yml`). Rest of the changes comes from auto generation and can be ignored. ## Description Part of DW team effort - elastic/security-team#11804 This PR aligns the property/schema descriptions and examples in AsciiDocs with OpenAPI schemas. The primary goal of this PR was not to extend or enhance the documentation but to migrate from one system to another. Ascii docs - https://www.elastic.co/guide/en/security/8.17/management-api-overview.html OpenApi generated docs - https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist Changes: Copied missing property descriptions from AsciiDoc to OpenApi properties Copied existing AsciiDoc examples for both requests and responses Fixed falsy query object in some GET requests - in OpenApi it was defined as an object, not as path query params. --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Paul Tavares <[email protected]> Co-authored-by: natasha-moore-elastic <[email protected]> (cherry picked from commit 2700a2a)
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Mar 1, 2025
…2510) (#212794) # Backport This will backport the following commits from `main` to `9.0`: - [[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)](#212510) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Konrad Szwarc","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-02-28T16:44:00Z","message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Defend Workflows","backport:prev-minor","backport:prev-major","v8.16.0","v8.17.0","v8.18.0","v9.1.0"],"title":"[EDR Workflows] OpenApi Missing Content - Response Actions","number":212510,"url":"https://github.com/elastic/kibana/pull/212510","mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.16","8.17","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/212510","number":212510,"mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310"}}]}] BACKPORT--> Co-authored-by: Konrad Szwarc <[email protected]>
This was referenced Mar 3, 2025
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
szwarckonrad
added a commit
that referenced
this pull request
Mar 3, 2025
…12510) (#212870) # Backport This will backport the following commits from `main` to `8.17`: - [[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)](#212510) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Konrad Szwarc","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-02-28T16:44:00Z","message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Defend Workflows","backport:prev-minor","backport:prev-major","v8.16.0","v8.17.0","v8.18.0","v9.1.0"],"title":"[EDR Workflows] OpenApi Missing Content - Response Actions","number":212510,"url":"https://github.com/elastic/kibana/pull/212510","mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.17","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/212794","number":212794,"state":"MERGED","mergeCommit":{"sha":"3ceba17cbd76f89b72986190b8c77f5079706282","message":"[9.0] [EDR Workflows] OpenApi Missing Content - Response Actions (#212510) (#212794)\n\n# Backport\n\nThis will backport the following commits from `main` to `9.0`:\n- [[EDR Workflows] OpenApi Missing Content - Response Actions\n(#212510)](https://github.com/elastic/kibana/pull/212510)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\nCo-authored-by: Konrad Szwarc <[email protected]>"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/212510","number":212510,"mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310"}}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
szwarckonrad
added a commit
that referenced
this pull request
Mar 3, 2025
…2510) (#212867) # Backport This will backport the following commits from `main` to `8.x`: - [[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)](#212510) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Konrad Szwarc","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-02-28T16:44:00Z","message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Defend Workflows","backport:prev-minor","backport:prev-major","v8.16.0","v8.17.0","v8.18.0","v9.1.0"],"title":"[EDR Workflows] OpenApi Missing Content - Response Actions","number":212510,"url":"https://github.com/elastic/kibana/pull/212510","mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.17","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/212794","number":212794,"state":"MERGED","mergeCommit":{"sha":"3ceba17cbd76f89b72986190b8c77f5079706282","message":"[9.0] [EDR Workflows] OpenApi Missing Content - Response Actions (#212510) (#212794)\n\n# Backport\n\nThis will backport the following commits from `main` to `9.0`:\n- [[EDR Workflows] OpenApi Missing Content - Response Actions\n(#212510)](https://github.com/elastic/kibana/pull/212510)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\nCo-authored-by: Konrad Szwarc <[email protected]>"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/212510","number":212510,"mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310"}}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
szwarckonrad
added a commit
that referenced
this pull request
Mar 3, 2025
…12510) (#212868) # Backport This will backport the following commits from `main` to `8.18`: - [[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)](#212510) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Konrad Szwarc","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-02-28T16:44:00Z","message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Defend Workflows","backport:prev-minor","backport:prev-major","v8.16.0","v8.17.0","v8.18.0","v9.1.0"],"title":"[EDR Workflows] OpenApi Missing Content - Response Actions","number":212510,"url":"https://github.com/elastic/kibana/pull/212510","mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.17","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/212794","number":212794,"state":"MERGED","mergeCommit":{"sha":"3ceba17cbd76f89b72986190b8c77f5079706282","message":"[9.0] [EDR Workflows] OpenApi Missing Content - Response Actions (#212510) (#212794)\n\n# Backport\n\nThis will backport the following commits from `main` to `9.0`:\n- [[EDR Workflows] OpenApi Missing Content - Response Actions\n(#212510)](https://github.com/elastic/kibana/pull/212510)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\nCo-authored-by: Konrad Szwarc <[email protected]>"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/212510","number":212510,"mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Response Actions (#212510)\n\n## For reviewers:\nOnly `*.schema.yml` files were edited (excluding\n`*.bundled.schema.yml`). Rest of the changes comes from auto generation\nand can be ignored.\n\n## Description\n\nPart of DW team effort - elastic/security-team#11804\n\nThis PR aligns the property/schema descriptions and examples in\nAsciiDocs with OpenAPI schemas. The primary goal of this PR was not to\nextend or enhance the documentation but to migrate from one system to\nanother.\n\nAscii docs -\nhttps://www.elastic.co/guide/en/security/8.17/management-api-overview.html\nOpenApi generated docs -\nhttps://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist\n\nChanges:\n\nCopied missing property descriptions from AsciiDoc to OpenApi properties\nCopied existing AsciiDoc examples for both requests and responses\nFixed falsy query object in some GET requests - in OpenApi it was\ndefined as an object, not as path query params.\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>\nCo-authored-by: Paul Tavares <[email protected]>\nCo-authored-by: natasha-moore-elastic <[email protected]>","sha":"2700a2a95158dc5d5a77ff074119b1b61f949310"}}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For reviewers:
Only
*.schema.ymlfiles were edited (excluding*.bundled.schema.yml). Rest of the changes comes from auto generation and can be ignored.Description
Part of DW team effort - elastic/security-team#11804
This PR aligns the property/schema descriptions and examples in AsciiDocs with OpenAPI schemas. The primary goal of this PR was not to extend or enhance the documentation but to migrate from one system to another.
Ascii docs - https://www.elastic.co/guide/en/security/8.17/management-api-overview.html
OpenApi generated docs - https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointgetactionslist
Changes:
Copied missing property descriptions from AsciiDoc to OpenApi properties
Copied existing AsciiDoc examples for both requests and responses
Fixed falsy query object in some GET requests - in OpenApi it was defined as an object, not as path query params.