TASK: Updating RAML types, Postman and OAS definition

Author: ct-sdks[bot]

bruno/api/Project/Product-projections/Product Projection Search/ByProjectKeyProductProjectionsSearchGet.bru

@@ -1,5 +1,5 @@
 meta {
-  name: Search Products by get
+  name: Search Products by GET
   type: http
   seq: 342
 }
@@ -12,18 +12,18 @@ get {
 
 
 query {
+  ~markMatchingVariants: 
+  ~/text.[a-z]{2}(-[A-Z]{2})?/: 
   ~fuzzy: 
   ~fuzzyLevel: 
-  ~markMatchingVariants: 
-  ~filter: 
-  ~filter.facets: 
   ~filter.query: 
+  ~filter: 
   ~facet: 
-  ~/text.[a-z]{2}(-[A-Z]{2})?/: 
+  ~filter.facets: 
+  ~expand: 
   ~sort: 
   ~limit: 
   ~offset: 
-  ~withTotal: 
   ~staged: 
   ~priceCurrency: 
   ~priceCountry: 
@@ -32,7 +32,6 @@ query {
   ~priceChannel: 
   ~localeProjection: 
   ~storeProjection: 
-  ~expand: 
 }
 
 script:post-response {

bruno/api/Project/Product-projections/Product Projection Search/ByProjectKeyProductProjectionsSearchPost.bru

@@ -1,5 +1,5 @@
 meta {
-  name: Search Products by post
+  name: Search Products by POST
   type: http
   seq: 341
 }

oas/api/openapi.yaml

@@ -27324,11 +27324,6 @@ paths:
         "503":
           $ref: '#/components/responses/errorable_503'
   /{projectKey}/product-projections/search:
-    description: |-
-      This endpoint provides high performance search queries over ProductProjections. The query result contains the
-      ProductProjections for which at least one ProductVariant matches the search query. This means that variants can
-      be included in the result also for which the search query does not match. To determine which ProductVariants match
-      the search query, the returned ProductProjections include the additional field isMatchingVariant.
     parameters:
       - name: projectKey
         in: path
@@ -27342,7 +27337,8 @@ paths:
             - "view_published_products:{projectKey}"
       operationId: ByProjectKeyProductProjectionsSearchPost
       description: |-
-        Product Projection Search
+        For implementing funnel search on Product Listing Pages where users select multiple filters, use this POST method.
+        To avoid URL length restrictions, this method passes the same query parameters as defined in the [GET](ctp:api:endpoint:/{projectKey}/product-projections/search:GET) method, within the request body in URL-encoded format.
       requestBody:
         content:
           application/x-www-form-urlencoded:
@@ -27379,32 +27375,45 @@ paths:
             - "view_published_products:{projectKey}"
       operationId: ByProjectKeyProductProjectionsSearchGet
       description: |-
-        Product Projection Search
+        This method appends query parameters to the URL.
+        The maximum allowed URL length is 8192 characters.
+        Exceeding this limit will result in URL truncation, potentially leading to unexpected results.
+        For funnel searches on Product Listing Pages, where users select multiple filters, we recommend the [POST](ctp:api:endpoint:/{projectKey}/product-projections/search:POST) method which passes the query parameters within the request body, avoiding URL length restrictions.
       parameters:
-        - name: fuzzy
+        - name: markMatchingVariants
+          x-annotation-default: false
           in: query
           required: false
           style: form
           schema:
             type: "boolean"
           explode: true
-        - name: fuzzyLevel
+        - name: /text.[a-z]{2}(-[A-Z]{2})?/
           in: query
           required: false
           style: form
           schema:
-            type: "number"
-            format: "double"
+            type: "array"
+            items:
+              type: "string"
           explode: true
-        - name: markMatchingVariants
+        - name: fuzzy
           x-annotation-default: false
           in: query
           required: false
           style: form
           schema:
             type: "boolean"
           explode: true
-        - name: filter
+        - name: fuzzyLevel
+          in: query
+          required: false
+          style: form
+          schema:
+            type: "number"
+            format: "double"
+          explode: true
+        - name: filter.query
           in: query
           required: false
           style: form
@@ -27413,7 +27422,7 @@ paths:
             items:
               type: "string"
           explode: true
-        - name: filter.facets
+        - name: filter
           in: query
           required: false
           style: form
@@ -27422,7 +27431,7 @@ paths:
             items:
               type: "string"
           explode: true
-        - name: filter.query
+        - name: facet
           in: query
           required: false
           style: form
@@ -27431,7 +27440,7 @@ paths:
             items:
               type: "string"
           explode: true
-        - name: facet
+        - name: filter.facets
           in: query
           required: false
           style: form
@@ -27440,7 +27449,7 @@ paths:
             items:
               type: "string"
           explode: true
-        - name: /text.[a-z]{2}(-[A-Z]{2})?/
+        - name: expand
           in: query
           required: false
           style: form
@@ -27456,7 +27465,7 @@ paths:
           schema:
             type: "array"
             items:
-              $ref: '#/components/schemas/Sort'
+              type: "string"
           explode: true
         - name: limit
           x-annotation-default: 20
@@ -27476,14 +27485,6 @@ paths:
             type: "number"
             format: "double"
           explode: true
-        - name: withTotal
-          x-annotation-default: true
-          in: query
-          required: false
-          style: form
-          schema:
-            type: "boolean"
-          explode: true
         - name: staged
           x-annotation-default: false
           in: query
@@ -27545,15 +27546,6 @@ paths:
           schema:
             type: "string"
           explode: true
-        - name: expand
-          in: query
-          required: false
-          style: form
-          schema:
-            type: "array"
-            items:
-              $ref: '#/components/schemas/Expansion'
-          explode: true
       responses:
         "200":
           description: |-
@@ -47356,6 +47348,9 @@ components:
       allOf:
         - $ref: '#/components/schemas/ErrorObject'
         - type: "object"
+          required:
+            - code
+            - message
           properties:
             code:
               type: "string"
@@ -48734,6 +48729,8 @@ components:
       allOf:
         - $ref: '#/components/schemas/GraphQLErrorObject'
         - type: "object"
+          required:
+            - code
           properties:
             code:
               type: "string"
@@ -73177,21 +73174,20 @@ components:
       type: "object"
       required:
         - count
-        - facets
         - limit
         - offset
         - results
       properties:
         limit:
           type: "integer"
           format: "int64"
-        count:
+        offset:
           type: "integer"
           format: "int64"
-        total:
+        count:
           type: "integer"
           format: "int64"
-        offset:
+        total:
           type: "integer"
           format: "int64"
         results:
@@ -73507,6 +73503,13 @@ components:
         - boolean
         - number
       x-annotation-package: "Product"
+      x-annotation-enumDescriptions:
+        text: "For [AttributeTextType](ctp:api:type:AttributeTextType) Attributes.n"
+        date: "For [AttributeDateType](ctp:api:type:AttributeDateType) Attributes.n"
+        time: "For [AttributeTimeType](ctp:api:type:AttributeTimeType) Attributes.n"
+        datetime: "For [AttributeDateTimeType](ctp:api:type:AttributeDateTimeType) Attributes.n"
+        boolean: "For [AttributeBooleanType](ctp:api:type:AttributeBooleanType) Attributes.n"
+        number: "For [AttributeNumberType](ctp:api:type:AttributeNumberType) Attributes.n"
     WhitespaceTokenizer:
       allOf:
         - $ref: '#/components/schemas/SuggestTokenizer'

uml/api/BaseResource.puml

@@ -3955,5 +3955,4 @@ BaseResource --> StoreNameSetMessage #blue;text:blue : "type : StoreNameSet"
 BaseResource --> StoreProductSelectionsChangedMessage #blue;text:blue : "type : StoreProductSelectionsChanged"
 BaseResource --> StoreSupplyChannelsChangedMessage #blue;text:blue : "type : StoreSupplyChannelsChanged"
 BaseResource --> PagedQueryResponse #green;text:green : "results"
-BaseResource --> PagedQueryResponse #green;text:green : "results"
 @enduml

uml/api/FacetRange.puml

@@ -28,6 +28,5 @@ interface RangeFacetResult [[RangeFacetResult.svg]]  {
     ranges: [[FacetRange.svg List<FacetRange>]]
 }
 
-FacetRange --> RangeFacetResult #green;text:green : "ranges"
 FacetRange --> RangeFacetResult #green;text:green : "ranges"
 @enduml

uml/api/FacetResults.puml

@@ -13,7 +13,14 @@ interface FacetResults [[FacetResults.svg]]  {
 
 
 
+interface ProductProjectionPagedSearchResponse [[ProductProjectionPagedSearchResponse.svg]]  {
+    limit: Long
+    offset: Long
+    count: Long
+    total: Long
+    results: [[ProductProjection.svg List<ProductProjection>]]
+    facets: [[FacetResults.svg FacetResults]]
+}
 
-
-
+FacetResults --> ProductProjectionPagedSearchResponse #green;text:green : "facets"
 @enduml

uml/api/FacetTerm.puml

@@ -25,6 +25,5 @@ interface TermFacetResult [[TermFacetResult.svg]]  {
     terms: [[FacetTerm.svg List<FacetTerm>]]
 }
 
-FacetTerm --> TermFacetResult #green;text:green : "terms"
 FacetTerm --> TermFacetResult #green;text:green : "terms"
 @enduml

uml/api/ProductProjection.puml

@@ -50,9 +50,9 @@ interface ProductProjectionPagedQueryResponse [[ProductProjectionPagedQueryRespo
 }
 interface ProductProjectionPagedSearchResponse [[ProductProjectionPagedSearchResponse.svg]]  {
     limit: Long
+    offset: Long
     count: Long
     total: Long
-    offset: Long
     results: [[ProductProjection.svg List<ProductProjection>]]
     facets: [[FacetResults.svg FacetResults]]
 }
@@ -124,7 +124,6 @@ interface ProductSearchResult [[ProductSearchResult.svg]]  {
 
 ProductProjection --> ProductProjectionPagedQueryResponse #green;text:green : "results"
 ProductProjection --> ProductProjectionPagedSearchResponse #green;text:green : "results"
-ProductProjection --> ProductProjectionPagedSearchResponse #green;text:green : "results"
 ProductProjection --> ProductCreatedMessage #green;text:green : "productProjection"
 ProductProjection --> ProductDeletedMessage #green;text:green : "currentProjection"
 ProductProjection --> ProductPublishedMessage #green;text:green : "productProjection"

uml/api/ProductProjectionPagedSearchResponse.puml

@@ -10,9 +10,9 @@ legend
 endlegend
 interface ProductProjectionPagedSearchResponse [[ProductProjectionPagedSearchResponse.svg]]  {
     limit: Long
+    offset: Long
     count: Long
     total: Long
-    offset: Long
     results: [[ProductProjection.svg List<ProductProjection>]]
     facets: [[FacetResults.svg FacetResults]]
 }

uml/api/TermFacetResultType.puml

@@ -9,6 +9,13 @@ enum TermFacetResultType {
     BOOLEAN
     NUMBER
 }
-
-
+interface TermFacetResult [[TermFacetResult.svg]]  {
+    type: [[FacetTypes.svg FacetTypes]]
+    dataType: [[TermFacetResultType.svg TermFacetResultType]]
+    missing: Long
+    total: Long
+    other: Long
+    terms: [[FacetTerm.svg List<FacetTerm>]]
+}
+TermFacetResultType --> TermFacetResult #green;text:green : "dataType"
 @enduml