[Docs] Documents constraints of space id in create space API (#150379)

closes #150311

Adds wording to clarify that the space ID must be lowercase
alphanumeric, but can include underscores and hyphens. Previously this
restriction was not documented, but if these requirements are not met
the API will respond with a 400.
This commit is contained in:
Jeramy Soucy 2023-02-06 16:31:35 -05:00 committed by GitHub
parent b37eefce2d
commit 01a18df436
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -15,7 +15,7 @@ experimental[] Create a {kib} space.
==== Request body
`id`::
(Required, string) The space ID that is part of the Kibana URL when inside the space. You are unable to change the ID with the update operation.
(Required, string) The space ID that is part of the Kibana URL when inside the space. Space IDs are limited to lowercase alphanumeric, underscore, and hyphen characters (a-z, 0-9, '_', and '-'). You are unable to change the ID with the update operation.
`name`::
(Required, string) The display name for the space.