github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
# Backport

This will backport the following commits from `main` to `8.6`:
- [[Docs] Documents constraints of space id in create space API
(#150379)](https://github.com/elastic/kibana/pull/150379)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Jeramy
Soucy","email":"jeramy.soucy@elastic.co"},"sourceCommit":{"committedDate":"2023-02-06T21:31:35Z","message":"[Docs]
Documents constraints of space id in create space API
(#150379)\n\ncloses #150311\r\n\r\nAdds wording to clarify that the
space ID must be lowercase\r\nalphanumeric, but can include underscores
and hyphens. Previously this\r\nrestriction was not documented, but if
these requirements are not met\r\nthe API will respond with a
400.","sha":"01a18df4365d412f5d05f98beafd72c0f3feabe9","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Security","release_note:skip","APIDocs","backport:all-open","v8.7.0"],"number":150379,"url":"https://github.com/elastic/kibana/pull/150379","mergeCommit":{"message":"[Docs]
Documents constraints of space id in create space API
(#150379)\n\ncloses #150311\r\n\r\nAdds wording to clarify that the
space ID must be lowercase\r\nalphanumeric, but can include underscores
and hyphens. Previously this\r\nrestriction was not documented, but if
these requirements are not met\r\nthe API will respond with a
400.","sha":"01a18df4365d412f5d05f98beafd72c0f3feabe9"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/150379","number":150379,"mergeCommit":{"message":"[Docs]
Documents constraints of space id in create space API
(#150379)\n\ncloses #150311\r\n\r\nAdds wording to clarify that the
space ID must be lowercase\r\nalphanumeric, but can include underscores
and hyphens. Previously this\r\nrestriction was not documented, but if
these requirements are not met\r\nthe API will respond with a
400.","sha":"01a18df4365d412f5d05f98beafd72c0f3feabe9"}}]}] BACKPORT-->

Co-authored-by: Jeramy Soucy <jeramy.soucy@elastic.co>
This commit is contained in:
Kibana Machine 2023-02-06 16:51:28 -05:00 • committed by GitHub
parent d9f90aaf24
commit 355493b6e0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/api/spaces-management/post.asciidoc
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.