-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
# Backport This will backport the following commits from `main` to `8.15`: - [[Discover] Update data view API docs (#187146)](#187146) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Julia Rechkunova","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-07-11T09:33:52Z","message":"[Discover] Update data view API docs (#187146)\n\n- Closes https://github.com/elastic/kibana/issues/187075\r\n\r\n## Summary\r\n\r\nThis PR updates data view API docs. `customDescription` was added in\r\nhttps://github.com//pull/168577\r\n\r\n---------\r\n\r\nCo-authored-by: Lisa Cawley <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"cd4a782cac7689b12087d2cdb0b2c9bcc676728e","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:DataDiscovery","backport:prev-minor","v8.16.0"],"title":"[Discover] Update data view API docs","number":187146,"url":"https://github.com/elastic/kibana/pull/187146","mergeCommit":{"message":"[Discover] Update data view API docs (#187146)\n\n- Closes https://github.com/elastic/kibana/issues/187075\r\n\r\n## Summary\r\n\r\nThis PR updates data view API docs. `customDescription` was added in\r\nhttps://github.com//pull/168577\r\n\r\n---------\r\n\r\nCo-authored-by: Lisa Cawley <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"cd4a782cac7689b12087d2cdb0b2c9bcc676728e"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/187146","number":187146,"mergeCommit":{"message":"[Discover] Update data view API docs (#187146)\n\n- Closes https://github.com/elastic/kibana/issues/187075\r\n\r\n## Summary\r\n\r\nThis PR updates data view API docs. `customDescription` was added in\r\nhttps://github.com//pull/168577\r\n\r\n---------\r\n\r\nCo-authored-by: Lisa Cawley <[email protected]>\r\nCo-authored-by: Davis McPhee <[email protected]>","sha":"cd4a782cac7689b12087d2cdb0b2c9bcc676728e"}}]}] BACKPORT--> Co-authored-by: Julia Rechkunova <[email protected]>
- Loading branch information
1 parent
8bba594
commit e0c1e4b
Showing
9 changed files
with
92 additions
and
23 deletions.
There are no files selected for viewing
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
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
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
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
11 changes: 8 additions & 3 deletions
11
src/plugins/data_views/docs/openapi/components/examples/update_field_metadata_request.yaml
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,14 @@ | ||
summary: Set popularity count for field foo. | ||
summary: Update metadata for multiple fields. | ||
value: | ||
{ | ||
"fields": { | ||
"foo": { | ||
"count": 123 | ||
"field1": { | ||
"count": 123, | ||
"customLabel": "Field 1 label" | ||
}, | ||
"field2": { | ||
"customLabel": "Field 2 label", | ||
"customDescription": "Field 2 description" | ||
} | ||
} | ||
} |
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
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
13 changes: 12 additions & 1 deletion
13
src/plugins/data_views/docs/openapi/components/schemas/fieldattrs.yaml
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,13 @@ | ||
type: object | ||
description: A map of field attributes by field name. | ||
description: A map of field attributes by field name. | ||
properties: | ||
count: | ||
type: integer | ||
description: Popularity count for the field. | ||
customDescription: | ||
type: string | ||
description: Custom description for the field. | ||
maxLength: 300 | ||
customLabel: | ||
type: string | ||
description: Custom label for the field. |
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