Skip to content

Commit f99ac88

Browse files
[Backport 9.0] Augment description for index name in create index API (#4340)
1 parent d613f5e commit f99ac88

File tree

5 files changed

+97
-44
lines changed

5 files changed

+97
-44
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 23 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 13 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 45 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

Lines changed: 7 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/indices/create/IndicesCreateRequest.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ import { Duration } from '@_types/Time'
4646
*
4747
* You can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`.
4848
* Note that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations.
49-
50-
5149
* @doc_id indices-create-index
5250
* @rest_spec_name indices.create
5351
* @availability stack stability=stable
@@ -64,6 +62,15 @@ export interface Request extends RequestBase {
6462
path_parts: {
6563
/**
6664
* Name of the index you wish to create.
65+
* Index names must meet the following criteria:
66+
*
67+
* * Lowercase only
68+
* * Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#`
69+
* * Indices prior to 7.0 could contain a colon (`:`), but that has been deprecated and will not be supported in later versions
70+
* * Cannot start with `-`, `_`, or `+`
71+
* * Cannot be `.` or `..`
72+
* * Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster)
73+
* * Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins
6774
*/
6875
index: IndexName
6976
}

0 commit comments

Comments
 (0)