Added examples for necessary Entity Analytics OpenAPI docs #205439
Merged
+215
−5
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
jaredburgettelastic
added
backport:skip
jaredburgettelastic
added
backport:version
machadoum
reviewed
Jan 3, 2025
| @@ -55,11 +55,24 @@ paths: | |||
| description: The kuery to filter by. | |||
| responses: | |||
| '200': | |||
| description: Bulk upload successful | |||
machadoum
approved these changes
Jan 3, 2025
There was a problem hiding this comment.
Thanks for adding these, @jaredburgettelastic, LGTM! Just one question: in the response schemas for GET, POST, DELETE asset_criticality and GET asset_criticality/list, there is an asset object (example here) marked as required, but it’s not included in the added response examples for those endpoints. Should it be included, or should it not be marked as required?
@natasha-moore-elastic great catch! I think that change was introduced after we initially wrote the asciidoc version, so they got out-of-sync. I'll test and update. |
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
|
Starting backport for target branches: 8.16, 8.17, 8.x |
💚 Build Succeeded
Metrics [docs]
History
|
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jan 15, 2025
…05439) # Summary As part of the effort to add missing content for Security APIs, this PR introduces a few missing request, response, and parameter examples for Security Entity Analytics APIs. All of the affected APIs are the Asset Criticality APIs. # How to Test Until the docs are deployed, this can be tested by navigating to https://editor.swagger.io/ and pasting in the fully bundled file, which can be found [here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml) in the PR --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]> (cherry picked from commit f2c0ee8)
💔 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
Jan 16, 2025
…5439) (#206877) # Backport This will backport the following commits from `main` to `8.x`: - [Added examples for necessary Entity Analytics OpenAPI docs (#205439)](#205439) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Jared Burgett","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-01-15T23:17:19Z","message":"Added examples for necessary Entity Analytics OpenAPI docs (#205439)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nSecurity Entity Analytics APIs.\r\n\r\nAll of the affected APIs are the Asset Criticality APIs.\r\n\r\n# How to Test\r\n\r\nUntil the docs are deployed, this can be tested by navigating to\r\nhttps://editor.swagger.io/ and pasting in the fully bundled file, which\r\ncan be found\r\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\r\nin the PR\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","v8.16.0","backport:version","v8.17.0","v8.18.0"],"title":"Added examples for necessary Entity Analytics OpenAPI docs","number":205439,"url":"https://github.com/elastic/kibana/pull/205439","mergeCommit":{"message":"Added examples for necessary Entity Analytics OpenAPI docs (#205439)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nSecurity Entity Analytics APIs.\r\n\r\nAll of the affected APIs are the Asset Criticality APIs.\r\n\r\n# How to Test\r\n\r\nUntil the docs are deployed, this can be tested by navigating to\r\nhttps://editor.swagger.io/ and pasting in the fully bundled file, which\r\ncan be found\r\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\r\nin the PR\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.17","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205439","number":205439,"mergeCommit":{"message":"Added examples for necessary Entity Analytics OpenAPI docs (#205439)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nSecurity Entity Analytics APIs.\r\n\r\nAll of the affected APIs are the Asset Criticality APIs.\r\n\r\n# How to Test\r\n\r\nUntil the docs are deployed, this can be tested by navigating to\r\nhttps://editor.swagger.io/ and pasting in the fully bundled file, which\r\ncan be found\r\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\r\nin the PR\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27"}},{"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.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Jared Burgett <[email protected]>
viduni94
pushed a commit
to viduni94/kibana
that referenced
this pull request
Jan 23, 2025
…05439) # Summary As part of the effort to add missing content for Security APIs, this PR introduces a few missing request, response, and parameter examples for Security Entity Analytics APIs. All of the affected APIs are the Asset Criticality APIs. # How to Test Until the docs are deployed, this can be tested by navigating to https://editor.swagger.io/ and pasting in the fully bundled file, which can be found [here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml) in the PR --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>
This was referenced Jan 24, 2025
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
hop-dev
pushed a commit
to hop-dev/kibana
that referenced
this pull request
Jan 24, 2025
…05439) # Summary As part of the effort to add missing content for Security APIs, this PR introduces a few missing request, response, and parameter examples for Security Entity Analytics APIs. All of the affected APIs are the Asset Criticality APIs. # How to Test Until the docs are deployed, this can be tested by navigating to https://editor.swagger.io/ and pasting in the fully bundled file, which can be found [here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml) in the PR --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]> (cherry picked from commit f2c0ee8) # Conflicts: # oas_docs/output/kibana.serverless.yaml
hop-dev
pushed a commit
to hop-dev/kibana
that referenced
this pull request
Jan 24, 2025
…05439) As part of the effort to add missing content for Security APIs, this PR introduces a few missing request, response, and parameter examples for Security Entity Analytics APIs. All of the affected APIs are the Asset Criticality APIs. Until the docs are deployed, this can be tested by navigating to https://editor.swagger.io/ and pasting in the fully bundled file, which can be found [here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml) in the PR --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]> (cherry picked from commit f2c0ee8)
hop-dev
added a commit
that referenced
this pull request
Jan 24, 2025
…05439) (#208231) # Backport This will backport the following commits from `main` to `8.17`: - [Added examples for necessary Entity Analytics OpenAPI docs (#205439)](#205439) <!--- Backport version: 9.6.4 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Jared Burgett","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-01-15T23:17:19Z","message":"Added examples for necessary Entity Analytics OpenAPI docs (#205439)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nSecurity Entity Analytics APIs.\r\n\r\nAll of the affected APIs are the Asset Criticality APIs.\r\n\r\n# How to Test\r\n\r\nUntil the docs are deployed, this can be tested by navigating to\r\nhttps://editor.swagger.io/ and pasting in the fully bundled file, which\r\ncan be found\r\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\r\nin the PR\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","v8.16.0","backport:version","v8.17.0","v8.18.0"],"title":"Added examples for necessary Entity Analytics OpenAPI docs","number":205439,"url":"https://github.com/elastic/kibana/pull/205439","mergeCommit":{"message":"Added examples for necessary Entity Analytics OpenAPI docs (#205439)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nSecurity Entity Analytics APIs.\r\n\r\nAll of the affected APIs are the Asset Criticality APIs.\r\n\r\n# How to Test\r\n\r\nUntil the docs are deployed, this can be tested by navigating to\r\nhttps://editor.swagger.io/ and pasting in the fully bundled file, which\r\ncan be found\r\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\r\nin the PR\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.17"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205439","number":205439,"mergeCommit":{"message":"Added examples for necessary Entity Analytics OpenAPI docs (#205439)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nSecurity Entity Analytics APIs.\r\n\r\nAll of the affected APIs are the Asset Criticality APIs.\r\n\r\n# How to Test\r\n\r\nUntil the docs are deployed, this can be tested by navigating to\r\nhttps://editor.swagger.io/ and pasting in the fully bundled file, which\r\ncan be found\r\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\r\nin the PR\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27"}},{"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.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/206877","number":206877,"state":"MERGED","mergeCommit":{"sha":"8b0c892c6ac1382b86fb4fe71dcede3097d91f62","message":"[8.x] Added examples for necessary Entity Analytics OpenAPI docs (#205439) (#206877)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.x`:\n- [Added examples for necessary Entity Analytics OpenAPI docs\n(#205439)](https://github.com/elastic/kibana/pull/205439)\n\n<!--- Backport version: 9.4.3 -->\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT [{\"author\":{\"name\":\"Jared\nBurgett\",\"email\":\"[email protected]\"},\"sourceCommit\":{\"committedDate\":\"2025-01-15T23:17:19Z\",\"message\":\"Added\nexamples for necessary Entity Analytics OpenAPI docs (#205439)\\n\\n#\nSummary\\r\\n\\r\\nAs part of the effort to add missing content for Security\nAPIs, this PR\\r\\nintroduces a few missing request, response, and\nparameter examples for\\r\\nSecurity Entity Analytics APIs.\\r\\n\\r\\nAll of\nthe affected APIs are the Asset Criticality APIs.\\r\\n\\r\\n# How to\nTest\\r\\n\\r\\nUntil the docs are deployed, this can be tested by\nnavigating to\\r\\nhttps://editor.swagger.io/ and pasting in the fully\nbundled file, which\\r\\ncan be\nfound\\r\\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\\r\\nin\nthe PR\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<[email protected]>\\r\\nCo-authored-by:\nElastic Machine\n<[email protected]>\",\"sha\":\"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27\",\"branchLabelMapping\":{\"^v9.0.0$\":\"main\",\"^v8.18.0$\":\"8.x\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"release_note:skip\",\"v9.0.0\",\"v8.16.0\",\"backport:version\",\"v8.17.0\",\"v8.18.0\"],\"title\":\"Added\nexamples for necessary Entity Analytics OpenAPI\ndocs\",\"number\":205439,\"url\":\"https://github.com/elastic/kibana/pull/205439\",\"mergeCommit\":{\"message\":\"Added\nexamples for necessary Entity Analytics OpenAPI docs (#205439)\\n\\n#\nSummary\\r\\n\\r\\nAs part of the effort to add missing content for Security\nAPIs, this PR\\r\\nintroduces a few missing request, response, and\nparameter examples for\\r\\nSecurity Entity Analytics APIs.\\r\\n\\r\\nAll of\nthe affected APIs are the Asset Criticality APIs.\\r\\n\\r\\n# How to\nTest\\r\\n\\r\\nUntil the docs are deployed, this can be tested by\nnavigating to\\r\\nhttps://editor.swagger.io/ and pasting in the fully\nbundled file, which\\r\\ncan be\nfound\\r\\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\\r\\nin\nthe PR\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<[email protected]>\\r\\nCo-authored-by:\nElastic Machine\n<[email protected]>\",\"sha\":\"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[\"8.16\",\"8.17\",\"8.x\"],\"targetPullRequestStates\":[{\"branch\":\"main\",\"label\":\"v9.0.0\",\"branchLabelMappingKey\":\"^v9.0.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/205439\",\"number\":205439,\"mergeCommit\":{\"message\":\"Added\nexamples for necessary Entity Analytics OpenAPI docs (#205439)\\n\\n#\nSummary\\r\\n\\r\\nAs part of the effort to add missing content for Security\nAPIs, this PR\\r\\nintroduces a few missing request, response, and\nparameter examples for\\r\\nSecurity Entity Analytics APIs.\\r\\n\\r\\nAll of\nthe affected APIs are the Asset Criticality APIs.\\r\\n\\r\\n# How to\nTest\\r\\n\\r\\nUntil the docs are deployed, this can be tested by\nnavigating to\\r\\nhttps://editor.swagger.io/ and pasting in the fully\nbundled file, which\\r\\ncan be\nfound\\r\\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\\r\\nin\nthe PR\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<[email protected]>\\r\\nCo-authored-by:\nElastic Machine\n<[email protected]>\",\"sha\":\"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27\"}},{\"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.x\",\"label\":\"v8.18.0\",\"branchLabelMappingKey\":\"^v8.18.0$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"}]}]\nBACKPORT-->\n\nCo-authored-by: Jared Burgett <[email protected]>"}}]}] BACKPORT--> Co-authored-by: Jared Burgett <[email protected]>
hop-dev
added a commit
that referenced
this pull request
Jan 24, 2025
…05439) (#208232) # Backport This will backport the following commits from `main` to `8.16`: - [Added examples for necessary Entity Analytics OpenAPI docs (#205439)](#205439) <!--- Backport version: 9.6.4 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Jared Burgett","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-01-15T23:17:19Z","message":"Added examples for necessary Entity Analytics OpenAPI docs (#205439)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nSecurity Entity Analytics APIs.\r\n\r\nAll of the affected APIs are the Asset Criticality APIs.\r\n\r\n# How to Test\r\n\r\nUntil the docs are deployed, this can be tested by navigating to\r\nhttps://editor.swagger.io/ and pasting in the fully bundled file, which\r\ncan be found\r\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\r\nin the PR\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","v8.16.0","backport:version","v8.17.0","v8.18.0"],"title":"Added examples for necessary Entity Analytics OpenAPI docs","number":205439,"url":"https://github.com/elastic/kibana/pull/205439","mergeCommit":{"message":"Added examples for necessary Entity Analytics OpenAPI docs (#205439)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nSecurity Entity Analytics APIs.\r\n\r\nAll of the affected APIs are the Asset Criticality APIs.\r\n\r\n# How to Test\r\n\r\nUntil the docs are deployed, this can be tested by navigating to\r\nhttps://editor.swagger.io/ and pasting in the fully bundled file, which\r\ncan be found\r\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\r\nin the PR\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.17"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205439","number":205439,"mergeCommit":{"message":"Added examples for necessary Entity Analytics OpenAPI docs (#205439)\n\n# Summary\r\n\r\nAs part of the effort to add missing content for Security APIs, this PR\r\nintroduces a few missing request, response, and parameter examples for\r\nSecurity Entity Analytics APIs.\r\n\r\nAll of the affected APIs are the Asset Criticality APIs.\r\n\r\n# How to Test\r\n\r\nUntil the docs are deployed, this can be tested by navigating to\r\nhttps://editor.swagger.io/ and pasting in the fully bundled file, which\r\ncan be found\r\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\r\nin the PR\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Elastic Machine <[email protected]>","sha":"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27"}},{"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.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/206877","number":206877,"state":"MERGED","mergeCommit":{"sha":"8b0c892c6ac1382b86fb4fe71dcede3097d91f62","message":"[8.x] Added examples for necessary Entity Analytics OpenAPI docs (#205439) (#206877)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.x`:\n- [Added examples for necessary Entity Analytics OpenAPI docs\n(#205439)](https://github.com/elastic/kibana/pull/205439)\n\n<!--- Backport version: 9.4.3 -->\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT [{\"author\":{\"name\":\"Jared\nBurgett\",\"email\":\"[email protected]\"},\"sourceCommit\":{\"committedDate\":\"2025-01-15T23:17:19Z\",\"message\":\"Added\nexamples for necessary Entity Analytics OpenAPI docs (#205439)\\n\\n#\nSummary\\r\\n\\r\\nAs part of the effort to add missing content for Security\nAPIs, this PR\\r\\nintroduces a few missing request, response, and\nparameter examples for\\r\\nSecurity Entity Analytics APIs.\\r\\n\\r\\nAll of\nthe affected APIs are the Asset Criticality APIs.\\r\\n\\r\\n# How to\nTest\\r\\n\\r\\nUntil the docs are deployed, this can be tested by\nnavigating to\\r\\nhttps://editor.swagger.io/ and pasting in the fully\nbundled file, which\\r\\ncan be\nfound\\r\\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\\r\\nin\nthe PR\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<[email protected]>\\r\\nCo-authored-by:\nElastic Machine\n<[email protected]>\",\"sha\":\"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27\",\"branchLabelMapping\":{\"^v9.0.0$\":\"main\",\"^v8.18.0$\":\"8.x\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"release_note:skip\",\"v9.0.0\",\"v8.16.0\",\"backport:version\",\"v8.17.0\",\"v8.18.0\"],\"title\":\"Added\nexamples for necessary Entity Analytics OpenAPI\ndocs\",\"number\":205439,\"url\":\"https://github.com/elastic/kibana/pull/205439\",\"mergeCommit\":{\"message\":\"Added\nexamples for necessary Entity Analytics OpenAPI docs (#205439)\\n\\n#\nSummary\\r\\n\\r\\nAs part of the effort to add missing content for Security\nAPIs, this PR\\r\\nintroduces a few missing request, response, and\nparameter examples for\\r\\nSecurity Entity Analytics APIs.\\r\\n\\r\\nAll of\nthe affected APIs are the Asset Criticality APIs.\\r\\n\\r\\n# How to\nTest\\r\\n\\r\\nUntil the docs are deployed, this can be tested by\nnavigating to\\r\\nhttps://editor.swagger.io/ and pasting in the fully\nbundled file, which\\r\\ncan be\nfound\\r\\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\\r\\nin\nthe PR\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<[email protected]>\\r\\nCo-authored-by:\nElastic Machine\n<[email protected]>\",\"sha\":\"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[\"8.16\",\"8.17\",\"8.x\"],\"targetPullRequestStates\":[{\"branch\":\"main\",\"label\":\"v9.0.0\",\"branchLabelMappingKey\":\"^v9.0.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/205439\",\"number\":205439,\"mergeCommit\":{\"message\":\"Added\nexamples for necessary Entity Analytics OpenAPI docs (#205439)\\n\\n#\nSummary\\r\\n\\r\\nAs part of the effort to add missing content for Security\nAPIs, this PR\\r\\nintroduces a few missing request, response, and\nparameter examples for\\r\\nSecurity Entity Analytics APIs.\\r\\n\\r\\nAll of\nthe affected APIs are the Asset Criticality APIs.\\r\\n\\r\\n# How to\nTest\\r\\n\\r\\nUntil the docs are deployed, this can be tested by\nnavigating to\\r\\nhttps://editor.swagger.io/ and pasting in the fully\nbundled file, which\\r\\ncan be\nfound\\r\\n[here](https://github.com/elastic/kibana/blob/f905638686cc242416c1d9adf0595c9f56cbc12d/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml)\\r\\nin\nthe PR\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<[email protected]>\\r\\nCo-authored-by:\nElastic Machine\n<[email protected]>\",\"sha\":\"f2c0ee8bd7a09a9b91465eba5d4567ca17e5fd27\"}},{\"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.x\",\"label\":\"v8.18.0\",\"branchLabelMappingKey\":\"^v8.18.0$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"}]}]\nBACKPORT-->\n\nCo-authored-by: Jared Burgett <[email protected]>"}}]}] BACKPORT--> Co-authored-by: Jared Burgett <[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.
Summary
As part of the effort to add missing content for Security APIs, this PR introduces a few missing request, response, and parameter examples for Security Entity Analytics APIs.
All of the affected APIs are the Asset Criticality APIs.
How to Test
Until the docs are deployed, this can be tested by navigating to https://editor.swagger.io/ and pasting in the fully bundled file, which can be found here in the PR