Document workspace-name length restriction

LayerManager · Jan 15, 2024 · c046a04 · c046a04
1 parent 660fc20
commit c046a04
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/doc/models.md b/doc/models.md
@@ -73,7 +73,7 @@
 
 ## Username
 - Username is a string identifying one [user](#user), so it is unique among all users.
-- The string is lower-case (in contrast with [role name](#role)).
+- The string is lower-case (in contrast with [role name](#role)), maximum length is 59 characters.
 - Each user is represented by max. one username.
 - Username is also used to identify user's [personal workspace](#personal-workspace) when communicating with [Layman REST API](rest.md).
 - Username can be reserved by [PATCH Current User](rest.md#patch-current-user).
@@ -92,6 +92,7 @@
 ## Workspace
 - Workspace is folder for [publications](#publication).
 - Each workspace is identified by name that is unique among all workspaces.
+- The name is lower-case, maximum length is 59 characters.
 - Workspace name is sometimes used for structuring publication-related data. For example, it's part of REST API URL (`/rest/workspaces/<workspace_name>/...`), directory names (`<LAYMAN_DATA_DIR>/workspaces/<workspace_name>/...`), DB schemas, or OGC Web Services (`/geoserver/<workspace_name>/...`, `/geoserver/<workspace_name>_wms/...`).
 - Workspace's REST API consists of all [map and layer endpoints](rest.md) endpoints.
 - There are following types of workspaces:

diff --git a/doc/rest.md b/doc/rest.md
@@ -834,7 +834,7 @@ Query parameters:
   - `true`: If `username` sent in body parameter is already reserved by another user or `username` is an empty string, layman will definitely reserve some `username`, preferably similar to the value sent in `username` body parameter or to one of claims.
 
 Body parameters:
-- *username*: String. [Username](models.md#username) that should be reserved for current user. Username can be reserved only once and it cannot be changed. See URL parameter `adjust_username` for other details.
+- *username*: String. [Username](models.md#username) that should be reserved for current user (maximum length is 59 characters). Username can be reserved only once and cannot be changed. See URL parameter `adjust_username` for other details.
 
 #### Response
 Content-Type: `application/json`