TASK: Updating RAML types, Postman and OAS definition

commercetools · Jul 24, 2024 · c3e19f1 · c3e19f1
1 parent 0a840c3
commit c3e19f1
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 52 deletions.
diff --git a/oas/api/openapi.yaml b/oas/api/openapi.yaml
@@ -72444,46 +72444,59 @@ components:
         - set_reference
       x-annotation-package: "Search"
       x-annotation-enumDescriptions:
-        boolean: "For Boolean fields and [AttributeBooleanType](ctp:api:type:AttributeBooleanType)
-         Attributes.n"
-        text: "For string fields and [AttributeTextType](ctp:api:type:AttributeTextType) Attributes.n"
-        ltext: "For [LocalizedString](types#localizedstring) fields and [AttributeLocalizableTextType](ctp:api:type:AttributeLocalizableTextType)
-         Attributes.n"
-        enum: "For enum fields and [AttributeEnumType](ctp:api:type:AttributeEnumType) Attributes.n"
-        lenum: "For localized enum fields and [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType)
-         Attributes.n"
-        number: "For number fields and [AttributeNumberType](ctp:api:type:AttributeNumberType)
-         Attributes.n"
+        boolean: "For Boolean fields, [AttributeBooleanType](ctp:api:type:AttributeBooleanType)
+         Attributes, and [BooleanType](ctp:api:type:CustomFieldBooleanType) Custom Fields.n"
+        text: "For string fields, [AttributeTextType](ctp:api:type:AttributeTextType) Attributes,
+         and [StringType](ctp:api:type:CustomFieldStringType) Custom Fields.n"
+        ltext: "For [LocalizedString](types#localizedstring) fields, [AttributeLocalizableTextType](ctp:api:type:AttributeLocalizableTextType)
+         Attributes,nand [LocalizedStringType](ctp:api:type:CustomFieldLocalizedStringType)
+         Custom Fields.n"
+        enum: "For enum fields, [AttributeEnumType](ctp:api:type:AttributeEnumType) Attributes,
+         and [EnumType](ctp:api:type:CustomFieldEnumType) Custom Fields.n"
+        lenum: "For localized enum fields, [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType)
+         Attributes, and [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType)
+         Custom Fields.n"
+        number: "For number fields, [AttributeNumberType](ctp:api:type:AttributeNumberType)
+         Attributes, and [NumberType](ctp:api:type:CustomFieldNumberType) Custom Fields.n"
         money: "For [Money](types#money) fields and [AttributeMoneyType](ctp:api:type:AttributeMoneyType)
          Attributes.n"
-        date: "For [Date](types#date) fields and [AttributeDateType](ctp:api:type:AttributeDateType)
-         Attributes.n"
-        datetime: "For [DateTime](types#datetime) fields and [AttributeDateTimeType](ctp:api:type:AttributeDateTimeType)
-         Attributes.n"
-        time: "For [Time](types#time) fields and [AttributeTimeType](ctp:api:type:AttributeTimeType)
-         Attributes.n"
+        date: "For [Date](types#date) fields, [AttributeDateType](ctp:api:type:AttributeDateType)
+         Attributes, and [DateType](ctp:api:type:CustomFieldDateType) Custom Fields.n"
+        datetime: "For [DateTime](types#datetime) fields, [AttributeDateTimeType](ctp:api:type:AttributeDateTimeType)
+         Attributes, and [DateTimeType](ctp:api:type:CustomFieldDateTimeType) Custom Fields.n"
+        time: "For [Time](types#time) fields, [AttributeTimeType](ctp:api:type:AttributeTimeType)
+         Attributes, and [TimeType](ctp:api:type:CustomFieldTimeType) Custom Fields.n"
         reference: "For [Reference](types#reference) fields and [AttributeReferenceType](ctp:api:type:AttributeReferenceType)
          Attributes.n"
-        set_boolean: "For Set of Boolean fields and [AttributeSetType](ctp:api:type:AttributeSetType)
-         of `boolean` Attributes.n"
-        set_text: "For Set of string fields and [AttributeSetType](ctp:api:type:AttributeSetType)
-         of `text` Attributes.n"
-        set_ltext: "For Set of [LocalizedString](types#localizedstring) fields and [AttributeSetType](ctp:api:type:AttributeSetType)
-         of `ltext` Attributes.n"
-        set_enum: "For Set of enum fields and [AttributeSetType](ctp:api:type:AttributeSetType)
-         of `enum` Attributes.n"
-        set_lenum: "For Set of localized enum fields and [AttributeSetType](ctp:api:type:AttributeSetType)
-         of `lenum` Attributes.n"
-        set_number: "For Set of number fields and [AttributeSetType](ctp:api:type:AttributeSetType)
-         of `number` Attributes.n"
+        set_boolean: "For Set of Boolean fields, [AttributeSetType](ctp:api:type:AttributeSetType)
+         of `boolean` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `boolean`
+         Custom Fields.n"
+        set_text: "For Set of string fields, [AttributeSetType](ctp:api:type:AttributeSetType)
+         of `text` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `text`
+         Custom Fields.n"
+        set_ltext: "For Set of [LocalizedString](types#localizedstring) fields, [AttributeSetType](ctp:api:type:AttributeSetType)
+         of `ltext` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `ltext`
+         Custom Fields.n"
+        set_enum: "For Set of enum fields, [AttributeSetType](ctp:api:type:AttributeSetType)
+         of `enum` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `enum`
+         Custom Fields.n"
+        set_lenum: "For Set of localized enum fields, [AttributeSetType](ctp:api:type:AttributeSetType)
+         of `lenum` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `lenum`
+         Custom Fields.n"
+        set_number: "For Set of number fields, [AttributeSetType](ctp:api:type:AttributeSetType)
+         of `number` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `number`
+         Custom Fields.n"
         set_money: "For Set of [Money](types#money) fields and [AttributeSetType](ctp:api:type:AttributeSetType)
          of `money` Attributes.n"
-        set_date: "For Set of [Date](types#date) fields and [AttributeSetType](ctp:api:type:AttributeSetType)
-         of `date` Attributes.n"
-        set_datetime: "For Set of [DateTime](types#datetime) fields and [AttributeSetType](ctp:api:type:AttributeSetType)
-         of `datetime` Attributes.n"
-        set_time: "For Set of [Time](types#time) fields and [AttributeSetType](ctp:api:type:AttributeSetType)
-         of `time` Attributes.n"
+        set_date: "For Set of [Date](types#date) fields, [AttributeSetType](ctp:api:type:AttributeSetType)
+         of `date` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `date`
+         Custom Fields.n"
+        set_datetime: "For Set of [DateTime](types#datetime) fields, [AttributeSetType](ctp:api:type:AttributeSetType)
+         of `datetime` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `datetime`
+         Custom Fields.n"
+        set_time: "For Set of [Time](types#time) fields, [AttributeSetType](ctp:api:type:AttributeSetType)
+         of `time` Attributes, and [SetType](ctp:api:type:CustomFieldSetType) of `time`
+         Custom Fields.n"
         set_reference: "For Set of [Reference](types#reference) fields and [AttributeSetType](ctp:api:type:AttributeSetType)
          of `reference` Attributes.n"
     SearchFilterExpression:

diff --git a/uml/api/OrderSearchCustomType.puml b/uml/api/OrderSearchCustomType.puml
@@ -11,14 +11,14 @@ enum OrderSearchCustomType {
     DATE_TYPE
     TIME_TYPE
     DATE_TIME_TYPE
-    SET_TYPE._STRING_TYPE
-    SET_TYPE._LOCALIZED_STRING_TYPE
-    SET_TYPE._ENUM_TYPE
-    SET_TYPE._LOCALIZED_ENUM_TYPE
-    SET_TYPE._NUMBER_TYPE
-    SET_TYPE._DATE_TYPE
-    SET_TYPE._TIME_TYPE
-    SET_TYPE._DATE_TIME_TYPE
+    SET_TYPE_STRING_TYPE
+    SET_TYPE_LOCALIZED_STRING_TYPE
+    SET_TYPE_ENUM_TYPE
+    SET_TYPE_LOCALIZED_ENUM_TYPE
+    SET_TYPE_NUMBER_TYPE
+    SET_TYPE_DATE_TYPE
+    SET_TYPE_TIME_TYPE
+    SET_TYPE_DATE_TIME_TYPE
 }
 
 

diff --git a/uml/api/svg/OrderSearchCustomType.svg b/uml/api/svg/OrderSearchCustomType.svg