Skip to content

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 10, 2026

Summary

Relates to #244878

The curl example in https://www.elastic.co/docs/api/doc/kibana/operation/operation-deletecasedefaultspace is invalid:

curl \
 --request DELETE 'https://localhost:5601/api/cases?ids=d4e7abb0-b462-11ec-9a8d-698504725a43' \
 --header "Authorization: $API_KEY" \
 --header "kbn-xsrf: string"

In curl, the query parameter value must have URL-encoded square brackets and quotes.

This PR overrides the automatically-generated curl example with a custom code sample. It also adds some examples to the description so it's clearer how the query parameter syntax varies in curl and Console.

I've also fixed the following linting errors in the case APIs:

[26] bundled.yaml:1411:16 at #/components/parameters/user_action_types/example

Example value must conform to the schema: type must be array.

1409 |           - title
1410 |           - user
1411 |     example: create_case
1412 | schemas:
1413 |   assignees:

referenced from bundled.yaml:1388:7 at #/components/parameters/user_action_types 

Warning was generated by the no-invalid-parameter-examples rule.

...
[27] bundled.yaml:3059:15 at #/components/schemas/payload_create_case/properties/tags/items/example

Example value must conform to the schema: type must be string.

3057 |         type: string
3058 |         example:
3059 |           - tag-1
3060 |     title:
3061 |       type: string
3062 | payload_delete:

referenced from bundled.yaml:3057:13 at #/components/schemas/payload_create_case/properties/tags/items 

Warning was generated by the no-invalid-schema-examples rule.

...
[29] bundled.yaml:4061:24 at #/components/examples/find_case_activity_response/value/userActions/1/payload/comment

Example value must conform to the schema: `comment` property type must be object.

4059 | owner: cases
4060 | payload:
4061 |   comment: A new comment
4062 |   owner: cases
4063 |   type: user

referenced from bundled.yaml:1058:15 at #/paths/~1api~1cases~1{caseId}~1user_actions~1_find/get/responses/200/content/application~1json 
...
[31] bundled.yaml:4078:17 at #/components/examples/find_case_activity_response/value/userActions/2/payload/assignees

Example value must conform to the schema: `assignees` property type must be array.

4076 | payload:
4077 |   assignees:
4078 |     uid: u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0
4079 | version: WzM1ODg4LDFb
4080 | type: assignees

referenced from bundled.yaml:1058:15 at #/paths/~1api~1cases~1{caseId}~1user_actions~1_find/get/responses/200/content/application~1json 

Warning was generated by the no-invalid-media-type-examples rule.

Screenshots

The updated description and examples look like this in a Bump.sh preview:

image

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
    - [ ] Documentation was added for features that require explanation or tutorials
    - [ ] Unit or functional tests were updated or added to match the most common scenarios
    - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
    - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
    - [ ] Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines
  • Review the backport guidelines and apply applicable backport:* labels.

Identify risks

N/A

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

@lcawl lcawl added docs Feature:Cases Cases feature release_note:skip Skip the PR/issue when compiling release notes backport:version Backport to applied version labels v9.3.0 v9.4.0 v9.2.5 v8.19.10 labels Jan 10, 2026
@lcawl lcawl marked this pull request as ready for review January 10, 2026 00:41
@lcawl lcawl requested review from a team as code owners January 10, 2026 00:41
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-cases (Feature:Cases)

@lcawl lcawl requested a review from janmonschke January 10, 2026 02:25
@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #81 / saved objects management apis find with kibana index - relationships hasReference and hasReferenceOperator parameters search for a reference
  • [job] [logs] FTR Configs #48 / Serverless Common UI - Management Index Management Index Details can view index details can add mappings

Metrics [docs]

✅ unchanged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version labels docs Feature:Cases Cases feature release_note:skip Skip the PR/issue when compiling release notes v8.19.10 v9.2.5 v9.3.0 v9.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants