[8.18] [EDR Workflows] OpenApi Missing Content - Endpoint Management (#212205) #212373
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
…c#212205) 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/kibana/8.17/osquery-manager-api.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: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com> (cherry picked from commit 3492f12)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]
|
szwarckonrad
added a commit
that referenced
this pull request
Feb 26, 2025
…212205) (#212491) # Backport This will backport the following commits from `main` to `8.x`: - [[EDR Workflows] OpenApi Missing Content - Endpoint Management (#212205)](#212205) <!--- 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-25T13:18:56Z","message":"[EDR Workflows] OpenApi Missing Content - Endpoint Management (#212205)\n\nPart of DW team effort -\nhttps://github.com/elastic/security-team/issues/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/kibana/8.17/osquery-manager-api.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: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>","sha":"3492f12c6c47d36de200682e43fae5684dbf49bb","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-major","v8.16.0","v8.17.0","v8.18.0","v9.1.0","v8.17.3","v8.16.5"],"title":"[EDR Workflows] OpenApi Missing Content - Endpoint Management","number":212205,"url":"https://github.com/elastic/kibana/pull/212205","mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Endpoint Management (#212205)\n\nPart of DW team effort -\nhttps://github.com/elastic/security-team/issues/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/kibana/8.17/osquery-manager-api.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: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>","sha":"3492f12c6c47d36de200682e43fae5684dbf49bb"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/212374","number":212374,"state":"MERGED","mergeCommit":{"sha":"b04883c3bd71119437692d8b679c1d2941d6ee8c","message":"[9.0] [EDR Workflows] OpenApi Missing Content - Endpoint Management (#212205) (#212374)\n\n# Backport\n\nThis will backport the following commits from `main` to `9.0`:\n- [[EDR Workflows] OpenApi Missing Content - Endpoint Management\n(#212205)](https://github.com/elastic/kibana/pull/212205)\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,"url":"https://github.com/elastic/kibana/pull/212389","number":212389,"state":"MERGED","mergeCommit":{"sha":"279b42370ee6166bb03fb993ee8682c4b7181876","message":"[8.16] [EDR Workflows] OpenApi Missing Content - Endpoint Management (#212205) (#212389)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.16`:\n- [[EDR Workflows] OpenApi Missing Content - Endpoint Management\n(#212205)](https://github.com/elastic/kibana/pull/212205)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>"}},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/212387","number":212387,"state":"MERGED","mergeCommit":{"sha":"83391ca5d980c6d26f0337be63454116c319bbf1","message":"[8.17] [EDR Workflows] OpenApi Missing Content - Endpoint Management (#212205) (#212387)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.17`:\n- [[EDR Workflows] OpenApi Missing Content - Endpoint Management\n(#212205)](https://github.com/elastic/kibana/pull/212205)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>"}},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/212373","number":212373,"state":"MERGED","mergeCommit":{"sha":"d371f5cf34bfcea45e8316d2d99e361ab5527f7b","message":"[8.18] [EDR Workflows] OpenApi Missing Content - Endpoint Management (#212205) (#212373)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.18`:\n- [[EDR Workflows] OpenApi Missing Content - Endpoint Management\n(#212205)](https://github.com/elastic/kibana/pull/212205)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\n---------\n\nCo-authored-by: Konrad Szwarc <[email protected]>"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/212205","number":212205,"mergeCommit":{"message":"[EDR Workflows] OpenApi Missing Content - Endpoint Management (#212205)\n\nPart of DW team effort -\nhttps://github.com/elastic/security-team/issues/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/kibana/8.17/osquery-manager-api.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: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>","sha":"3492f12c6c47d36de200682e43fae5684dbf49bb"}}]}] 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.
Backport
This will backport the following commits from
mainto8.18:Questions ?
Please refer to the Backport tool documentation