Updated API from documentation release

commercetools · Apr 22, 2024 · f39e14a · f39e14a
1 parent e59c07a
commit f39e14a
Show file tree

Hide file tree

Showing 21 changed files with 54 additions and 0 deletions.
diff --git a/api-specs/api/ruleset.xml b/api-specs/api/ruleset.xml
@@ -107,6 +107,9 @@
         <rule enabled="false">
             <name>com.commercetools.rmf.validators.DatetimeRule</name>
         </rule>
+      <rule enabled="true">
+        <name>com.commercetools.rmf.validators.PolymorphicSubtypesRule</name>
+      </rule>
         <rule>
             <name>com.commercetools.rmf.validators.CamelCaseRule</name>
             <options>

diff --git a/api-specs/api/types/annotations.raml b/api-specs/api/types/annotations.raml
@@ -4,6 +4,9 @@ package:
 identifier:
   type: boolean
   allowedTargets: TypeDeclaration
+ignoreValidators:
+  type: string[]
+  allowedTargets: TypeDeclaration
 elementIdentifier:
   type: boolean
   allowedTargets: TypeDeclaration

diff --git a/api-specs/api/types/common/BaseAddress.raml b/api-specs/api/types/common/BaseAddress.raml
@@ -6,6 +6,7 @@ description: |
   Polymorphic base type that represents a postal address and contact details.
   Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
   only differ in the data type for the optional `custom` field.
+(ignoreValidators): [PolymorphicSubtypesRule]
 properties:
   id?:
     type: string

diff --git a/api-specs/api/types/common/BaseResource.raml b/api-specs/api/types/common/BaseResource.raml
@@ -3,6 +3,7 @@
 displayName: BaseResource
 type: object
 (abstract): true
+(ignoreValidators): [PolymorphicSubtypesRule]
 properties:
   id:
     (identifier): true

diff --git a/api-specs/api/types/common/ClientLogging.raml b/api-specs/api/types/common/ClientLogging.raml
@@ -4,6 +4,7 @@ displayName: ClientLogging
 type: object
 description: |
   These objects represent information about which [API Client](/../api/projects/api-clients) created or modified a resource. For more information, see [Client Logging](/../api/general-concepts#client-logging).
+(ignoreValidators): [PolymorphicSubtypesRule]
 properties:
   clientId?:
     type: string

diff --git a/api-specs/api/types/common/Money.raml b/api-specs/api/types/common/Money.raml
@@ -5,6 +5,7 @@ type: object
 description: |
   Draft type that stores amounts only in cent precision for the specified currency.
 example: !include ../../examples/Common/Money.json
+(ignoreValidators): [PolymorphicSubtypesRule]
 properties:
   centAmount:
     type: number

diff --git a/api-specs/api/types/error/ErrorResponse.raml b/api-specs/api/types/error/ErrorResponse.raml
@@ -5,6 +5,7 @@ displayName: ErrorResponse
 description: |
   Base representation of an error response containing common fields to all errors.
 example: !include /../../examples/Error/ErrorResponse.json
+(ignoreValidators): [PolymorphicSubtypesRule]
 properties:
   statusCode:
     type: integer

diff --git a/api-specs/api/types/message/OrderMessage.raml b/api-specs/api/types/message/OrderMessage.raml
@@ -1,4 +1,5 @@
 #%RAML 1.0 DataType
 (package): Message
 type: Message
+(ignoreValidators): [PolymorphicSubtypesRule]
 displayName: OrderMessage
diff --git a/api-specs/api/types/message/payload/OrderMessagePayload.raml b/api-specs/api/types/message/payload/OrderMessagePayload.raml
@@ -1,4 +1,5 @@
 #%RAML 1.0 DataType
 (package): Message
 type: MessagePayload
+(ignoreValidators): [PolymorphicSubtypesRule]
 displayName: OrderMessagePayload
diff --git a/api-specs/api/types/order-search/OrderSearchCompoundExpression.raml b/api-specs/api/types/order-search/OrderSearchCompoundExpression.raml
@@ -2,3 +2,4 @@
 (package): Order
 type: OrderSearchQuery
 displayName: OrderSearchCompoundExpression
+(ignoreValidators): [PolymorphicSubtypesRule]
diff --git a/api-specs/api/types/order-search/OrderSearchQueryExpression.raml b/api-specs/api/types/order-search/OrderSearchQueryExpression.raml
@@ -2,3 +2,4 @@
 (package): Order
 type: OrderSearchQuery
 displayName: OrderSearchQueryExpression
+(ignoreValidators): [PolymorphicSubtypesRule]
diff --git a/api-specs/api/types/order-search/OrderSearchQueryExpressionValue.raml b/api-specs/api/types/order-search/OrderSearchQueryExpressionValue.raml
@@ -2,6 +2,7 @@
 (package): Order
 type: object
 displayName: OrderSearchQueryExpressionValue
+(ignoreValidators): [PolymorphicSubtypesRule]
 properties:
   field:
     type: string

diff --git a/api-specs/api/types/order/Order.raml b/api-specs/api/types/order/Order.raml
@@ -3,6 +3,7 @@
 displayName: Order
 (updateType): OrderUpdate
 type: BaseResource
+(ignoreValidators): [PolymorphicSubtypesRule]
 properties:
   id:
     (identifier): true

diff --git a/api-specs/api/types/order/OrderSearchQuery.raml b/api-specs/api/types/order/OrderSearchQuery.raml
@@ -2,3 +2,4 @@
 (package): Order
 type: object
 displayName: OrderSearchQuery
+(ignoreValidators): [PolymorphicSubtypesRule]
diff --git a/api-specs/api/types/product-search/facets/ProductSearchFacetExpression.raml b/api-specs/api/types/product-search/facets/ProductSearchFacetExpression.raml
@@ -3,3 +3,4 @@
 type: object
 (beta): true
 displayName: ProductSearchFacetExpression
+(ignoreValidators): [PolymorphicSubtypesRule]
diff --git a/api-specs/api/types/product-search/facets/ProductSearchFacetResult.raml b/api-specs/api/types/product-search/facets/ProductSearchFacetResult.raml
@@ -3,6 +3,7 @@
 displayName: ProductSearchFacetResult
 type: object
 (beta): true
+(ignoreValidators): [PolymorphicSubtypesRule]
 properties:
   name:
     type: string

diff --git a/api-specs/api/types/search/SearchCompoundExpression.raml b/api-specs/api/types/search/SearchCompoundExpression.raml
@@ -3,3 +3,4 @@
 type: SearchQuery
 (beta): true
 displayName: SearchCompoundExpression
+(ignoreValidators): [PolymorphicSubtypesRule]
diff --git a/api-specs/api/types/search/SearchQuery.raml b/api-specs/api/types/search/SearchQuery.raml
@@ -3,3 +3,4 @@
 type: object
 (beta): true
 displayName: SearchQuery
+(ignoreValidators): [PolymorphicSubtypesRule]
diff --git a/api-specs/api/types/search/SearchQueryExpression.raml b/api-specs/api/types/search/SearchQueryExpression.raml
@@ -3,3 +3,4 @@
 type: SearchQuery
 (beta): true
 displayName: SearchQueryExpression
+(ignoreValidators): [PolymorphicSubtypesRule]
diff --git a/api-specs/api/types/search/SearchQueryExpressionValue.raml b/api-specs/api/types/search/SearchQueryExpressionValue.raml
@@ -3,6 +3,7 @@
 type: object
 (beta): true
 displayName: SearchQueryExpressionValue
+(ignoreValidators): [PolymorphicSubtypesRule]
 properties:
   field:
     type: string

diff --git a/api-specs/readme.md b/api-specs/readme.md
@@ -700,6 +700,10 @@ This annotation is declared on the API settings level, so in the [api-specs/api/
 
 Use this annotation to add descriptions to an enum property, like here [ChannelRoleEnum.raml](./api/types/channel/ChannelRoleEnum.raml).
 
+##### (ignoreValidators)
+
+Use this annotation to ignore the rules in this list for the specific type, resource or module.
+
 ### Composable Commerce API folder structure
 
 #### /examples
@@ -1314,6 +1318,32 @@ resourceTypes:
         get:
 ```
 
+#### PolymorphicSubtypesRule
+
+The rule verifies that a type defines a discriminator if it has subtypes to avoid issues with deserialization of read models.
+
+```raml
+types:
+  Foo:
+    type: object
+    discriminator: type
+    properties:
+      type: string
+  SubFoo:
+    discriminatorValue: sub
+    type: Foo
+  InvalidBar:
+    type: object
+    description: InvalidBar
+    properties:
+      name: string
+  SubBar:
+    description: SubBar
+    type: InvalidBar
+  SubBar2:
+    type: InvalidBar
+```
+
 # Generate a Postman Collection
 
 Follow the steps in the [Generate a Postman Collection](https://github.com/commercetools/commercetools-docs/blob/main/api-specs/generate-a-postman-collection.md) guide to learn more.