Updated API from documentation release

commercetools · Oct 13, 2023 · cfb34c1 · cfb34c1
1 parent 72d0e82
commit cfb34c1
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 7 deletions.
diff --git a/api-specs/api/ruleset.xml b/api-specs/api/ruleset.xml
@@ -84,6 +84,7 @@
                 <option type="exclude">Sort</option>
                 <option type="exclude">OrderSearchQuery</option>
                 <option type="exclude">OrderSearchSorting</option>
+                <option type="exclude">Locale</option>
           </options>
         </rule>
         <rule>

diff --git a/api-specs/api/types/common/Locale.raml b/api-specs/api/types/common/Locale.raml
@@ -3,5 +3,4 @@
 displayName: Locale
 type: string
 description: |
-  String matching the pattern `^[a-z]{2}(-[A-Z]{2})?$` representing an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag).
-pattern: ^[a-z]{2}(-[A-Z]{2})?$
+  String value specifying linguistic and regional preferences using the [IETF language tag format](https://en.wikipedia.org/wiki/IETF_language_tag), as described in [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). The format combines language, script, and region using hyphen-separated subtags. For example: `en`, `en-US`, `zh-Hans-SG`.
diff --git a/api-specs/frontend-api/types/Locale.raml b/api-specs/frontend-api/types/Locale.raml
@@ -2,6 +2,5 @@
 (package): Common
 displayName: Locale
 description: |
-  String matching the pattern `^([a-z]{2}_[A-Z]{2})|([a-z]{2})$` representing an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) that can be followed by an underscore and a [region subtag](https://en.wikipedia.org/wiki/IETF_language_tag#ISO_3166-1_and_UN_M.49).
+  String value specifying linguistic and regional preferences using the [IETF language tag format](https://en.wikipedia.org/wiki/IETF_language_tag), as described in [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). The format combines language, script, and region using hyphen-separated subtags. For example: `en`, `en-US`, `zh-Hans-SG`.
 type: string
-pattern: ^([a-z]{2}_[A-Z]{2})|([a-z]{2})$
diff --git a/api-specs/history/ruleset.xml b/api-specs/history/ruleset.xml
@@ -69,6 +69,7 @@
                 <option type="exclude">Expansion</option>
                 <option type="exclude">QueryPredicate</option>
                 <option type="exclude">Sort</option>
+                <option type="exclude">Locale</option>
             </options>
         </rule>
         <rule severity="warn">

diff --git a/api-specs/history/types/common/Locale.raml b/api-specs/history/types/common/Locale.raml
@@ -2,6 +2,5 @@
 (package): Common
 type: string
 displayName: Locale
-description: A locale of [IETF language
-  tag](https://en.wikipedia.org/wiki/IETF_language_tag).
-pattern: ^[a-z]{2}(-[A-Z]{2})?$
+description: |
+  String value specifying linguistic and regional preferences using the [IETF language tag format](https://en.wikipedia.org/wiki/IETF_language_tag), as described in [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). The format combines language, script, and region using hyphen-separated subtags. For example: `en`, `en-US`, `zh-Hans-SG`.