[Cases] Guardrails in Cases APIs #146945
Labels
Feature:Cases
Cases feature
Project:Serverless
Work as part of the Serverless project for its initial release
Team:ResponseOps
Label for the ResponseOps team (formerly the Cases and Alerting teams)
Comments
cnasikas
added
Team:ResponseOps
|
Pinging @elastic/response-ops (Team:ResponseOps) |
|
Pinging @elastic/response-ops-cases (Feature:Cases) |
30 tasks
cnasikas
added
the
Project:Serverless
This was referenced Jun 28, 2023
adcoelho
added a commit
that referenced
this issue
Jun 28, 2023
Connected with #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of files that can be deleted | 10 | ✅ | No | ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios
2 tasks
2 tasks
adcoelho
added a commit
that referenced
this issue
Jun 30, 2023
Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Maximum number of assignees to filter | 100 | ✅ | Yes | | Maximum number of tags to filter | 100 | ✅ | Yes | | Maximum number of reporters to filter | 100 | ✅ | Yes | - Used schema validation. - Updated documentation. - Added jest and e2e tests. ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release notes The Find Cases API now limits the array fields tags, assignees, and reporters to 100 items.
adcoelho
added a commit
that referenced
this issue
Jun 30, 2023
Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of cases to be deleted | 100 | ✅ | Yes | - Used schema validation. - Updated documentation. - Added jest and e2e tests. ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release notes The Delete cases API now limits the number of cases to be deleted to 100.
js-jankisalvi
added a commit
that referenced
this issue
Jun 30, 2023
… category, tags (#160844) Connected to #146945 ## Summary Description | Limit | Done? | Documented? -- | -- | -- | -- Total number of description characters | 30.000 | ✅ | Yes Total number of tags per case | 200 | ✅ | Yes Total number of characters per tag | 256 | ✅ | Yes - Used schema validation. - Updated documentation. - Added jest and integration tests. **Note:** In this PR, `maximum length of title (160 characters)` and` maximum length of category field (50 characters)` validations are also moved to schema validation. ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release notes The Create Case and Update Case APIs put the following limits: - Total number of characters per description: 30K - Total number of tags per case: 200 - Total number of characters per tag: 256 --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This was referenced Jul 3, 2023
adcoelho
added a commit
that referenced
this issue
Jul 4, 2023
…61088) Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of attachments returned by bulk get API | 100 | ✅ | No (internal) | | Total number of cases returned by bulk get API | 1000 | ✅ | No (internal) | - Replaced the code validation with schema validation. - BulkGet Cases - The minimum of cases that can be returned is now 1(was not validated before). - BulkGet Attachments - The maximum of attachments that can be returned is now 100(was **10000**). - The minimum of attachments that can be returned is now 1(was not validated before). - Updated unit and e2e tests. - The documentation was not updated because these are internal APIs. - Skipping the release notes because these are internal APIs. ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios
2 tasks
adcoelho
added a commit
that referenced
this issue
Jul 5, 2023
Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of cases/user actions/comments per page | 100 | ✅ | No | N/A | | Maximum number of cases/user actions/comments returned from the API | 10.000 | ✅ | No | N/A | ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release Notes Max value for perPage parameter in find Cases API is now 100. Max value for perPage parameter in find User Actions API is now 100. Max value for perPage parameter in find Comments API is now 100. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: lcawl <lcawley@elastic.co>
This was referenced Jul 5, 2023
js-jankisalvi
added a commit
that referenced
this issue
Jul 6, 2023
Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of comment characters | 30.000 | ✅ | Yes | - Tests. - Updated Documentation. ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release Notes Post and Patch comment API limits total number of characters per comment to 30000 --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2 tasks
adcoelho
added a commit
that referenced
this issue
Jul 6, 2023
Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of cases to be updated | 100 | ✅ | Yes | - Also changed the **minimum** of cases that can be updated to 1. - Tests. - Updated Documentation. ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release Notes Patch Cases API is now limited to 100 cases at a time and a minimum of 1.
adcoelho
added a commit
that referenced
this issue
Jul 7, 2023
Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of supported connectors returned | 1000 | ✅ | Yes | ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release Notes The getConnectors API will now limit the number of supported connectors returned to 1000.
1 task
adcoelho
added a commit
that referenced
this issue
Jul 7, 2023
Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of users returned by suggest users API | 10 | ✅ | No (internal) | ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios
js-jankisalvi
added a commit
that referenced
this issue
Jul 7, 2023
…k create API (#161451) Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of attachments that can be created using the bulk create API | 100 | ✅ | No | ### Checklist Delete any items that are not applicable to this PR. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This was referenced Jul 13, 2023
4 tasks
adcoelho
added a commit
that referenced
this issue
Jul 25, 2023
…er case (#162071) Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of attachments (external references and persistable state) per case | 100 | ✅ | No | ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release Notes A case can now only have 100 external references and persistable state(excluding files) attachments combined.
2 tasks
js-jankisalvi
added a commit
that referenced
this issue
Jul 26, 2023
…2411) ## Summary Connected to #146945 This PR adds UI validations for `assignees`, `tags` and `categories` filter on cases list table and cases selector modal: Description | Limit | Done? | Documented? | UI? -- | -- | -- | -- | -- Maximum number of assignees to filter | 100 | ✅ | Yes | :white_check_mark: Maximum number of tags to filter | 100 | ✅ | Yes | :white_check_mark: Maximum number of categories to filter | 100 | ✅ | Yes | :white_check_mark: **Selector modal:**  **Case list table:**    _Note:_ _screenshots are taken with 5 as maximum limit for `assignees`, `tags` and `categories` filter:_ ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
js-jankisalvi
added a commit
that referenced
this issue
Jul 26, 2023
## Summary Connected to #146945 This PR updates API docs for Description | Limit | Done? | Documented? | UI? -- | -- | -- | -- | -- Total assignees per case | 10 | ✅ | Yes | ✅ Maximum number of cases/user actions/comments returned from the API | 10.000 | ✅ | Yes | N/A Total number of cases by alert ID returned from the API | 10.000 | ✅ | Yes | N/A Total number of tags returned from the API | 10.000 | ✅ | Yes | N/A Total number of reporters returned from the API | 10.000 | ✅ | Yes | N/A ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: lcawl <lcawley@elastic.co>
adcoelho
added a commit
that referenced
this issue
Jul 27, 2023
Connected to #146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of user actions and comments combined on a case | 10000 | ✅ | No | ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release Notes Updating a case will now fail if the operation makes it reach more than 10000 user actions.
ThomThomson
pushed a commit
to ThomThomson/kibana
that referenced
this issue
Aug 1, 2023
…er case (elastic#162071) Connected to elastic#146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of attachments (external references and persistable state) per case | 100 | ✅ | No | ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release Notes A case can now only have 100 external references and persistable state(excluding files) attachments combined.
ThomThomson
pushed a commit
to ThomThomson/kibana
that referenced
this issue
Aug 1, 2023
…stic#162411) ## Summary Connected to elastic#146945 This PR adds UI validations for `assignees`, `tags` and `categories` filter on cases list table and cases selector modal: Description | Limit | Done? | Documented? | UI? -- | -- | -- | -- | -- Maximum number of assignees to filter | 100 | ✅ | Yes | :white_check_mark: Maximum number of tags to filter | 100 | ✅ | Yes | :white_check_mark: Maximum number of categories to filter | 100 | ✅ | Yes | :white_check_mark: **Selector modal:**  **Case list table:**    _Note:_ _screenshots are taken with 5 as maximum limit for `assignees`, `tags` and `categories` filter:_ ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
ThomThomson
pushed a commit
to ThomThomson/kibana
that referenced
this issue
Aug 1, 2023
## Summary Connected to elastic#146945 This PR updates API docs for Description | Limit | Done? | Documented? | UI? -- | -- | -- | -- | -- Total assignees per case | 10 | ✅ | Yes | ✅ Maximum number of cases/user actions/comments returned from the API | 10.000 | ✅ | Yes | N/A Total number of cases by alert ID returned from the API | 10.000 | ✅ | Yes | N/A Total number of tags returned from the API | 10.000 | ✅ | Yes | N/A Total number of reporters returned from the API | 10.000 | ✅ | Yes | N/A ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: lcawl <lcawley@elastic.co>
ThomThomson
pushed a commit
to ThomThomson/kibana
that referenced
this issue
Aug 1, 2023
Connected to elastic#146945 ## Summary | Description | Limit | Done? | Documented? | ------------- | ---- | :---: | ---- | | Total number of user actions and comments combined on a case | 10000 | ✅ | No | ### Checklist Delete any items that are not applicable to this PR. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release Notes Updating a case will now fail if the operation makes it reach more than 10000 user actions.
js-jankisalvi
added a commit
that referenced
this issue
Aug 17, 2023
## Summary Added docs for total alerts per case guardrails as per #146945 | Description | Limit | Done? | Documented? | UI? | ------------- | ---- | :---: | ---- | :----: | | Total alerts per case | 1.000 | ✅ | Yes | N/A |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this issue
Aug 17, 2023
## Summary Added docs for total alerts per case guardrails as per elastic#146945 | Description | Limit | Done? | Documented? | UI? | ------------- | ---- | :---: | ---- | :----: | | Total alerts per case | 1.000 | ✅ | Yes | N/A | (cherry picked from commit 18d28fc)
kibanamachine
added a commit
that referenced
this issue
Aug 17, 2023
# Backport This will backport the following commits from `main` to `8.10`: - [[Cases] Add max alerts per case to docs (#164141)](#164141) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Janki Salvi","email":"117571355+js-jankisalvi@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-08-17T10:48:30Z","message":"[Cases] Add max alerts per case to docs (#164141)\n\n## Summary\r\n\r\nAdded docs for total alerts per case guardrails as per\r\nhttps://github.com//issues/146945\r\n\r\n| Description | Limit | Done? | Documented? | UI?\r\n| ------------- | ---- | :---: | ---- | :----: |\r\n| Total alerts per case | 1.000 | ✅ | Yes | N/A |","sha":"18d28fc42c6107bedaf98161c6b2c9e7b522237b","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","Feature:Cases","v8.10.0","v8.11.0"],"number":164141,"url":"https://github.com/elastic/kibana/pull/164141","mergeCommit":{"message":"[Cases] Add max alerts per case to docs (#164141)\n\n## Summary\r\n\r\nAdded docs for total alerts per case guardrails as per\r\nhttps://github.com//issues/146945\r\n\r\n| Description | Limit | Done? | Documented? | UI?\r\n| ------------- | ---- | :---: | ---- | :----: |\r\n| Total alerts per case | 1.000 | ✅ | Yes | N/A |","sha":"18d28fc42c6107bedaf98161c6b2c9e7b522237b"}},"sourceBranch":"main","suggestedTargetBranches":["8.11"],"targetPullRequestStates":[{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/164141","number":164141,"mergeCommit":{"message":"[Cases] Add max alerts per case to docs (#164141)\n\n## Summary\r\n\r\nAdded docs for total alerts per case guardrails as per\r\nhttps://github.com//issues/146945\r\n\r\n| Description | Limit | Done? | Documented? | UI?\r\n| ------------- | ---- | :---: | ---- | :----: |\r\n| Total alerts per case | 1.000 | ✅ | Yes | N/A |","sha":"18d28fc42c6107bedaf98161c6b2c9e7b522237b"}},{"branch":"8.11","label":"v8.11.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Janki Salvi <117571355+js-jankisalvi@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Summary
In various Cases APIs, we do not put guardrails on the number of objects they can be processed or the amount of data the objects can store. We should put the following guardrails:
PRs
References
The text was updated successfully, but these errors were encountered: