openstack
/
keystone
Code Issues Proposed changes

[api] add a note about project name restrictions 

Mention that project names are limited to domain, 64 characters,
and utf8 support depends on the given backend.

Change-Id: Idc266d693c9e81d2bc9b51f20ad5f1282bda5721
Closes-Bug: 1631517
This commit is contained in:
Steve Martinelli 2016-10-11 22:46:10 -04:00
parent abe6157e5a
commit 1974f2d5dc
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api-ref/source/v3/projects.inc
View File

@ -27,6 +27,17 @@ A project acting as a domain can potentially also act as a container for
OpenStack resources, although this depends on whether the policy rule for the
relevant resource creation allows this.
.. note::
A project's name must be unique within a domain and no more than 64 characters.
A project's name must be able to be sent within valid JSON, which could be any
UTF-8 character. However, this is constrained to the given backend where project
names are stored. For instance, MySQL's restrictions states that UTF-8 support
is constrained to the characters in the Basic Multilingual Plane (BMP).
Supplementary characters are not permitted. Note that this last restriction is
generally true for all ``names`` within resources of the Identity API.
List projects
=============