Skip to content

Commit aeba8d7

Browse files
[Auto] Update docs for 'data-extensions.svc' from commit 'a8d25af6' in branch 'main'
1 parent df21964 commit aeba8d7

File tree

1 file changed

+20
-21
lines changed

1 file changed

+20
-21
lines changed

openapispecs/commerceextensions/OpenAPISpec.yaml

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -98,28 +98,27 @@ tags:
9898
\ that API clients use either the `integer` field_type if applicable , or the\
9999
\ `string` data type if perfect precision or recall is required.\n\n### String\
100100
\ Validation\n- `min_length`: Specifies the minimum number of characters that\
101-
\ can be stored. If set, it must be less than 0 and less than `max_length`.\n\
101+
\ can be stored. If set, it must be greater than 0 and less than `max_length`.\n\
102102
- `max_length`: Specifies the maximum number of characters that can be stored.\
103-
\ If set, it must be greater than 0 and `min_length`.\n- `regex`: [RE2](https://github.com/google/re2/wiki/Syntax)\
104-
\ regular expression that used to restrict the specific characters that can\
105-
\ be stored. This must be less than 1024 characters.\n- `unique`: Specifies\
106-
\ whether the field must have unique constraint or not. It must be `yes` or\
107-
\ `no`. \n- `unique_case_insensitivity`: For fields with `unique` set to\
108-
\ `yes`, controls whether or not values with different cases (e.g., `ABC` and\
109-
\ `abc`) should conflict. It must be true or false.\nsample string validation\
110-
\ object:\n\n```json\n{\n \"validation\": {\n \"string\": {\n \"min_length\"\
111-
: 0,\n \"max_length\": 64,\n \"regex\": \"^.+\\\\.(jpg|jpeg|png|gif|pdf)$\"\
112-
,\n \"unique\": \"yes\"\n \"unique_case_insensitivity\": true\n \
113-
\ }\n }\n}\n```\nEven if no validation is set, field_type `string` only supports\
114-
\ values that are up to `65535` characters long.\n\n\n### Null Values\n\nAll\
115-
\ Custom Fields can be configured to restrict the storage of `null` values for\
116-
\ that field on a Custom API Entry. By default, this is `true`.\n\nsample validation\
117-
\ object :\n \n```json\n{\n \"validation\": {\n \"boolean\": {\n \"\
118-
allow_null_values\": false,\n \"immutable\": false\n }\n }\n}\n ```\n\
119-
\n## Reserved Slugs\n\nThe following values cannot be used as a `slug` in a\
120-
\ Custom Field.\n\n- slug\n- type\n- id\n- meta\n- created_at\n- updated_at\n\
121-
- links\n- relationships\n- attributes\n- attribute\n- dimension\n- dimensions\n\
122-
- weight\n- weights\n"
103+
\ If set, it must be greater than 0 and `min_length`.\n- `regex`: A [RE2](https://github.com/google/re2/wiki/Syntax)\
104+
\ regular expression used to restrict the specific characters that can be stored.\
105+
\ It must be less than 1024 characters.\n- `unique`: Specifies whether the field\
106+
\ must have unique constraint or not. It must be `yes` or `no`. \n- `unique_case_insensitivity`:\
107+
\ Applies when `unique` is set to `yes`. It controls whether values with different\
108+
\ cases (for example, `ABC` and `abc`) should conflict. It must be `true` or\
109+
\ `false`.\nsample string validation object:\n\n```json\n{\n \"validation\"\
110+
: {\n \"string\": {\n \"min_length\": 0,\n \"max_length\": 64,\n\
111+
\ \"regex\": \"^.+\\\\.(jpg|jpeg|png|gif|pdf)$\",\n \"unique\": \"\
112+
yes\"\n \"unique_case_insensitivity\": true\n }\n }\n}\n```\nEven if\
113+
\ no validation is set, field_type `string` only supports values that are up\
114+
\ to `65535` characters long.\n\n\n### Null Values\n\nAll Custom Fields can\
115+
\ be configured to restrict the storage of `null` values for that field on a\
116+
\ Custom API Entry. By default, this is `true`.\n\nsample validation object\
117+
\ :\n \n```json\n{\n \"validation\": {\n \"boolean\": {\n \"allow_null_values\"\
118+
: false,\n \"immutable\": false\n }\n }\n}\n ```\n\n## Reserved Slugs\n\
119+
\nThe following values cannot be used as a `slug` in a Custom Field.\n\n- slug\n\
120+
- type\n- id\n- meta\n- created_at\n- updated_at\n- links\n- relationships\n\
121+
- attributes\n- attribute\n- dimension\n- dimensions\n- weight\n- weights\n"
123122
- name: Custom API Entries
124123
description: "A **Custom API Entry** is a specific instance of a resource, such\
125124
\ as a single wishlist in a Custom API for wishlists.\n\nCustom API Entries\

0 commit comments

Comments
 (0)