From dd01d60d645a68526383b9c6e247be867dab3fda Mon Sep 17 00:00:00 2001 From: Tony Tam Date: Fri, 8 Apr 2016 06:10:56 -0700 Subject: [PATCH 1/3] added clarification on namespaces, characters in definitions name --- versions/3.0.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/versions/3.0.md b/versions/3.0.md index 1d6a2d02a9..9a592049a4 100644 --- a/versions/3.0.md +++ b/versions/3.0.md @@ -1945,7 +1945,11 @@ An object to hold data types that can be consumed and produced by operations. Th Field Pattern | Type | Description ---|:---:|--- -{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines. +{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines. The following characters are legal in the `definitionsName`: `a-zA-Z0-9.-_()[]\/` + +The following characters are illegal in the `definitionsName`: `"'` + +In addition, high-level characters are not legal in the `definitionsName`. The name may be used to namespace the definitions--it is the tooling vendor's job to ensure that the namespace is honored. ##### Definitions Object Example From 7f1c22984a83605c6f365573c92c6aaae34d6962 Mon Sep 17 00:00:00 2001 From: Tony Tam Date: Mon, 11 Apr 2016 13:31:13 -0700 Subject: [PATCH 2/3] clarified allowable names, removed disallowed names --- versions/3.0.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/versions/3.0.md b/versions/3.0.md index 9a592049a4..5f9a8ff10f 100644 --- a/versions/3.0.md +++ b/versions/3.0.md @@ -1945,11 +1945,7 @@ An object to hold data types that can be consumed and produced by operations. Th Field Pattern | Type | Description ---|:---:|--- -{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines. The following characters are legal in the `definitionsName`: `a-zA-Z0-9.-_()[]\/` - -The following characters are illegal in the `definitionsName`: `"'` - -In addition, high-level characters are not legal in the `definitionsName`. The name may be used to namespace the definitions--it is the tooling vendor's job to ensure that the namespace is honored. +{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines. The following characters are legal in the `definitionsName`: `a-zA-Z0-9.-_()[]\`. All other characters, including high-level characters, are not legal in the `definitionsName`. The name may be used to namespace the definitions--it is the tooling vendor's job to ensure that the namespace is honored. ##### Definitions Object Example From 649d177a79835a4dadbfea3af2026dfdb193cd79 Mon Sep 17 00:00:00 2001 From: Tony Tam Date: Wed, 13 Apr 2016 22:10:26 -0700 Subject: [PATCH 3/3] added examples, removed characters --- versions/3.0.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/versions/3.0.md b/versions/3.0.md index 5f9a8ff10f..fa9a0d7749 100644 --- a/versions/3.0.md +++ b/versions/3.0.md @@ -1945,7 +1945,18 @@ An object to hold data types that can be consumed and produced by operations. Th Field Pattern | Type | Description ---|:---:|--- -{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines. The following characters are legal in the `definitionsName`: `a-zA-Z0-9.-_()[]\`. All other characters, including high-level characters, are not legal in the `definitionsName`. The name may be used to namespace the definitions--it is the tooling vendor's job to ensure that the namespace is honored. +{name} | [Schema Object](#schemaObject) | A single definition, mapping a "name" to the schema it defines. The following characters are legal in the `definitionsName`: `a-zA-Z0-9.-_\`. All other characters, including extended ASCII characters, are not legal in the `definitionsName`. The name may be used to namespace the definitions--it is the tooling vendor's job to ensure that the namespace is honored. + +Examples: + +``` +User +User_1 +User_Name +user-name +my.org.User +my\org\User +``` ##### Definitions Object Example