Skip to content

Commit

Permalink
Update description of the field
Browse files Browse the repository at this point in the history
  • Loading branch information
achyutjhunjhunwala committed Jun 26, 2024
1 parent 445c9f4 commit a68a527
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 22 deletions.
2 changes: 1 addition & 1 deletion output/openapi/elasticsearch-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -72603,7 +72603,7 @@
"type": "number"
},
"ignore_dynamic_beyond_limit": {
"description": "A flag to ignore fields beyond the limit set for the maximum number of fields in an index.\nIf set to true, fields exceeding the limit will be ignored instead of causing an error.\nThis can be useful in scenarios where the data is dynamic and, it's acceptable to overlook extra fields.\nHowever, use this setting with caution as ignoring additional fields might lead to loss of data or unexpected search results.",
"description": "This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set\nto false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail\nwith the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.\nInstead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.\nThe fields that were not added to the mapping will be added to the _ignored field.",
"type": "boolean"
}
}
Expand Down
2 changes: 1 addition & 1 deletion output/openapi/elasticsearch-serverless-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 16 additions & 16 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 5 additions & 4 deletions specification/indices/_types/IndexSettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -430,10 +430,11 @@ export class MappingLimitSettingsTotalFields {
*/
limit?: long
/**
* A flag to ignore fields beyond the limit set for the maximum number of fields in an index.
* If set to true, fields exceeding the limit will be ignored instead of causing an error.
* This can be useful in scenarios where the data is dynamic and, it's acceptable to overlook extra fields.
* However, use this setting with caution as ignoring additional fields might lead to loss of data or unexpected search results.
* This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set
* to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail
* with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail.
* Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false.
* The fields that were not added to the mapping will be added to the _ignored field.
* @server_default false
*/
ignore_dynamic_beyond_limit?: boolean
Expand Down

0 comments on commit a68a527

Please sign in to comment.