From 1974f2d5dc1e24d1c67258c48f2a5da0dd846cd1 Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Tue, 11 Oct 2016 22:46:10 -0400 Subject: [PATCH] [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 --- api-ref/source/v3/projects.inc | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/api-ref/source/v3/projects.inc b/api-ref/source/v3/projects.inc index b926188a1c..1db6814e32 100644 --- a/api-ref/source/v3/projects.inc +++ b/api-ref/source/v3/projects.inc @@ -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 =============