Skip to content

[Backport 9.0] Augment description for index name in create index API #4340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 30, 2025
Merged

[Backport 9.0] Augment description for index name in create index API #4340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0addeeb
Augment description for index name in create index API (#4333)
lcawl Apr 30, 2025
8030e98
Regenerate output
lcawl Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

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

22 changes: 13 additions & 9 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

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

62 changes: 45 additions & 17 deletions output/schema/schema.json
View file
Open in desktop

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

12 changes: 7 additions & 5 deletions output/typescript/types.ts
View file
Open in desktop

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

11 changes: 9 additions & 2 deletions specification/indices/create/IndicesCreateRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@ import { Duration } from '@_types/Time'
*
* You can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`.
* Note that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations.


* @doc_id indices-create-index
* @rest_spec_name indices.create
* @availability stack stability=stable
Expand All @@ -64,6 +62,15 @@ export interface Request extends RequestBase {
path_parts: {
/**
* Name of the index you wish to create.
* Index names must meet the following criteria:
*
* * Lowercase only
* * Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#`
* * Indices prior to 7.0 could contain a colon (`:`), but that has been deprecated and will not be supported in later versions
* * Cannot start with `-`, `_`, or `+`
* * Cannot be `.` or `..`
* * Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster)
* * Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins
*/
index: IndexName
}
Expand Down