[Cases] Custom fields types #165671
Merged
[Cases] Custom fields types #165671
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
adcoelho
added
release_note:skip
Allow custom fields to be null.
|
Pinging @elastic/response-ops (Team:ResponseOps) |
|
Pinging @elastic/response-ops-cases (Feature:Cases) |
adcoelho
commented
Sep 5, 2023
afharo
requested changes
Sep 5, 2023
There was a problem hiding this comment.
Destructive mapping changes are not allowed since 8.9.
CI also claimed that https://buildkite.com/elastic/kibana-pull-request/builds/156536#018a661a-466f-4416-a98d-5eee69e13ea5 😇
afharo
approved these changes
Sep 6, 2023
cnasikas
reviewed
Sep 7, 2023
cnasikas
reviewed
Sep 11, 2023
2 tasks
cnasikas
approved these changes
Sep 12, 2023
| @@ -174,6 +178,9 @@ export function transformSavedObjectToExternalModel( | |||
| SEVERITY_ESMODEL_TO_EXTERNAL[caseSavedObjectAttributes.severity] ?? CaseSeverity.LOW; | |||
| const status = STATUS_ESMODEL_TO_EXTERNAL[caseSavedObjectAttributes.status] ?? CaseStatuses.open; | |||
| const category = !caseSavedObjectAttributes.category ? null : caseSavedObjectAttributes.category; | |||
| const customFields = !caseSavedObjectAttributes.customFields | |||
| ? [] | |||
| : (caseSavedObjectAttributes.customFields as unknown as CaseCustomFields); | |||
|
Nah, thank you for finding all those things @cnasikas :D |
💔 Build FailedFailed CI Steps
Test Failures
Metrics [docs]Page load bundle
History
To update your PR or re-run it, just comment with: cc @adcoelho |
adcoelho
merged commit a5eaad9
into
elastic:cases-custom-fields-feature-branch
1 check passed
adcoelho
added a commit
that referenced
this pull request
Sep 14, 2023
## Summary This was missing in my previous PR #165671
This was referenced Sep 28, 2023
js-jankisalvi
added a commit
that referenced
this pull request
Oct 2, 2023
## Summary
This PR implements an MPV for custom fields in Cases. Specifically:
- Users can add, delete, or edit custom fields from the configuration
page
- Users can set custom fields when creating a case
- Users can set custom fields when editing a case
- Only the `Text` custom field type is supported. The `Toggle` is
implemented to test the framework.
- Users with a basic license can enter the configuration page and set
custom fields
- The configuration page header changed to "Settings"
- The "Edit external connection" button changed to "Settings"
- APIs:
- Users cannot post custom fields with duplicate keys
- Users cannot change the type of the custom field
- Users cannot add custom fields that are not configured
- Required fields should be present
- If some of the custom fields are omitted from the request the backend
will fill them with `null` values
- Limits:
- Maximum 10 custom fields configured
- Maximum 50 chars in custom field labels
- Maximum 160 chars for the value of the `Text` custom field type
- Users cannot change the type of a custom field
- The key of the custom fields should contain only lowercase letters
(a-z), numbers (0-9), '_', and '-'
- Required fields needs a value
## Testing
- Cases created before custom fields are working as expected (create
some on `main` before switching to the feature branch)
- Environments without configuration are working as expected (clear ES
data)
- Environments with existing configurations are working as expected
- Try to create cases with custom fields (required & optional) and
delete some of them
- Try to create cases with custom fields (required & optional) and then
configure new custom fields. Existing cases with old custom fields
should work as expected
- User actions are working as expected especially with the combinations
described in the previous two bullets
- Users with a basic license can configure custom fields but cannot
configure connectors
- Users with a gold+ license can configure custom fields and connectors
- Users with read access cannot configure or edit custom fields
Resolves: #160236
PRs:
- #165671
- #166353
- #166439
- #166483
- #166815
- #166940
- #166962
- #166969
- #166975
- #167029
- #167047
- #167105
- #167131
- #167144
- #167166
- #167167
- #167310
- #167386
- #167481
- #167495
- #167398
- #167472
### 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
### 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)
## Release notes
Allow users to configure custom fields in Cases. Supported field types:
Text. Coming soon: Multi-text, List, Number, Toggle, Date, IP, Email,
etc.
---------
Co-authored-by: adcoelho <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Christos Nasikas <[email protected]>
Co-authored-by: Julian Gernun <[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.
Connected with #160236
Merging into a Feature Branch
Summary
This PR defines the
customFieldin the Cases API and Domain types.For now, we only allow the custom fields
string,boolean, andlist.This PR does not include the case configuration types.
The default value for the field is
[].