KEkeboola
Webalize

Webalize Display Name

Webalize string which you want to use as displayName for tables (PUT /tables/{tableId}) and buckets (PUT /buckets/{bucketId}).

post/v2/storage/webalize/display-name

Request

Request body

displayNamestring required

Display name to webalize.

Example request

{
  "displayName": "My$$Display-Name"
}

Response

Webalized display name.

displayNamestring required

The name of a bucket or a table.

  • Allowed characters: A-Z, a-z, 0-9, dash - and underscore _. Anything else — a space, a dot, an accented letter — is rejected, not transliterated.
  • 1 to 96 characters.
  • Cannot start with an underscore. A dash or a digit as the first character is fine.
  • Registered (external) buckets follow this same rule, dashes included.
  • Uniqueness is case-insensitive within a stage: creating MyBucket next to mybucket fails with storage.buckets.alreadyExists, and for tables with storage.buckets.tableAlreadyExists or storage.validation.tableAlreadyExists.
  • To turn arbitrary user input into a name that satisfies this rule, call POST /v2/storage/webalize/display-name instead of reimplementing the transformation. It unaccents the input, replaces every run of disallowed characters with a single -, trims - from both ends, strips leading underscores, and truncates to 96 characters.

Example response

{
  "displayName": "my-bucket"
}

Changes

No recorded changes to this operation across all 1 revision of this API.