Update APIs (@W-17701731@) (#430)

* add APIs

* remove SEO API

* update test

* Feat: Update docs site and add API version table (@W-17701731@) (#431)

* update docs

* lint and remove generateVersionTable from test covereage

Author: joeluong-sfcc

.nycrc.json

@@ -6,6 +6,7 @@
     "src/updateApis.ts",
     "src/lib/config.ts",
     "src/generate-oas.ts",
+    "src/generateVersionTable.ts",
     "src/removeInternalOas.ts",
     "src/static/helpers/index.ts",
     "src/lib/utils.ts"

CHANGELOG.md

@@ -1,7 +1,40 @@
-## CHANGELOG
+# CHANGELOG
 
 ## v5.0.0
 
+### API Versions
+
+| API Name | API Version |
+|----------|-------------|
+| assignments | 1.0.35 |
+| campaigns | 1.0.37 |
+| catalogs | 1.0.42 |
+| cdn-api-process-apis | 1.0.39 |
+| cors-preferences | 1.0.5 |
+| coupons | 1.0.39 |
+| customers | 1.0.32 |
+| gift-certificates | 1.0.39 |
+| orders | 1.4.10 |
+| preferences | 1.1.3 |
+| products | 1.0.40 |
+| promotions | 1.0.33 |
+| shopper-baskets | 1.9.0 |
+| shopper-baskets | 2.1.0 |
+| shopper-consents | 1.1.0 |
+| shopper-context | 1.1.1 |
+| shopper-customers | 1.1.1 |
+| shopper-experience | 1.0.7 |
+| shopper-gift-certificates | 1.0.26 |
+| shopper-login | 1.39.41 |
+| shopper-orders | 1.5.0 |
+| shopper-products | 1.0.37 |
+| shopper-promotions | 1.0.36 |
+| shopper-search | 1.3.0 |
+| shopper-seo | 1.0.13 |
+| shopper-stores | 1.0.17 |
+| slas-admin | 1.12.30 |
+| source-code-groups | 1.0.37 |
+
 ### Enchancements
 - Enum types have been added for certain operations and types
 - Certain operations have had types updated for query parameters

…as/assignments-oas-1.0.34/.metadata.json …is/assignments-oas-1.0.35/.metadata.jsonapis/assignments-oas/assignments-oas-1.0.34/.metadata.json renamed to apis/assignments-oas-1.0.35/.metadata.json apis/assignments-oas/assignments-oas-1.0.34/.metadata.json renamed to apis/assignments-oas-1.0.35/.metadata.json

@@ -1,10 +1,10 @@
 {
-  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/assignments-oas/1.0.34",
+  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/assignments-oas/1.0.35",
   "name": "Assignments OAS",
   "description": "",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "assignments-oas",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "categories": {
     "SDK Type": [
       "Commerce"

…as-1.0.34/assignments-oas-v1-public.yaml …as-1.0.35/assignments-oas-v1-public.yamlapis/assignments-oas/assignments-oas-1.0.34/assignments-oas-v1-public.yaml renamed to apis/assignments-oas-1.0.35/assignments-oas-v1-public.yaml apis/assignments-oas/assignments-oas-1.0.34/assignments-oas-v1-public.yaml renamed to apis/assignments-oas-1.0.35/assignments-oas-v1-public.yaml

@@ -115,6 +115,7 @@ components:
           $ref: '#/components/schemas/TermQuery'
         textQuery:
           $ref: '#/components/schemas/TextQuery'
+      additionalProperties: false
     BoolQuery:
       description: "A boolean query allows construction of full logical expression trees that are composed of other queries (usually term queries and text queries). A boolean query has three sets of clauses:\n  \n  - `must`, which combines as an `AND` operator.\n  - `should`, which combines as an `OR` operator.\n  - `must_not`, which combines as a `NOT` operator.\n  \nIf `must`, `mustNot`, or `should` appear in the same boolean query, they are combined logically using the `AND` operator. For example:\n\n    (must-1 AND must-1 AND ...)\n      AND (should-1 OR should-2 OR ...)\n      AND NOT (must_not-1 OR must_not-2 OR ...)\n"
       type: object
@@ -152,6 +153,7 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Query'
+      additionalProperties: false
     Filter:
       minProperties: 1
       maxProperties: 1
@@ -180,6 +182,7 @@ components:
           $ref: '#/components/schemas/RangeFilter'
         termFilter:
           $ref: '#/components/schemas/TermFilter'
+      additionalProperties: false
     BoolFilter:
       description: Allows you to combine other filters into (possibly recursive) logical expression trees. A boolean filter is composed of a logical operator (`AND`, `OR`, `NOT`) and a list of filters that the operator relates to. Multiple filters can be negated with a single `NOT` operator, even when the filters are combined with the `AND` operator.
       example:
@@ -213,6 +216,7 @@ components:
           example: and
       required:
         - operator
+      additionalProperties: false
     QueryFilter:
       description: Wraps any query and allows it to be used as a filter.
       type: object
@@ -289,6 +293,7 @@ components:
       required:
         - fromField
         - toField
+      additionalProperties: false
     RangeFilter:
       description: |-
         Allows you to restrict a search result to hits that have values for a given attribute that fall within a given value range. The range filter supports several value types and relies on the natural sorting of the value type for range interpretation. Value ranges can be open-ended, but only at one end of the range. You can configure whether the lower bounds and upper bounds are inclusive or exclusive.
@@ -302,16 +307,30 @@ components:
           allOf:
             - $ref: '#/components/schemas/Field'
         from:
+          oneOf:
+            - type: string
+              format: date-time
+              example: '2007-01-01T00:00:00.000Z'
+            - type: integer
+              example: 1
+            - type: number
+              example: 1
           description: The lower bound of the filter range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.
-          example: '2007-01-01T00:00:00.000Z'
         fromInclusive:
           default: true
           example: true
           description: A flag indicating if the lower bound of the range is inclusive. To make the lower bound exclusive, set to `false`.
           type: boolean
         to:
+          oneOf:
+            - type: string
+              format: date-time
+              example: '2007-01-02T00:00:00.000Z'
+            - type: integer
+              example: 2
+            - type: number
+              example: 2
           description: The upper bound of the filter range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.
-          example: '2017-01-01T00:00:00.000Z'
         toInclusive:
           default: true
           example: true
@@ -354,6 +373,7 @@ components:
       required:
         - field
         - operator
+      additionalProperties: false
     FilteredQuery:
       description: Allows to filter the result of a possibly complex query using a possibly complex filter.
       example:
@@ -377,6 +397,7 @@ components:
       required:
         - filter
         - query
+      additionalProperties: false
     MatchAllQuery:
       description: Matches all documents (namespace and document type). This query comes in handy if you just want to filter a search result or really do not have any constraints.
       type: object
@@ -425,6 +446,7 @@ components:
       required:
         - path
         - query
+      additionalProperties: false
     TermQuery:
       description: |-
         A term query matches one or more values against one or more document fields. A document is considered a hit if one of the values matches exactly with at least one of the given fields. The operator `is` can only take one value, while `one_of` can take multiple values. If multiple fields are specified, they are combined using a logical `OR` operator.
@@ -458,7 +480,15 @@ components:
           description: The values that the fields are compared against, combined with the operator.
           type: array
           items:
-            type: string
+            oneOf:
+              - type: string
+                example: myCouponId
+              - type: number
+                example: 1
+              - type: boolean
+                example: true
+              - type: integer
+                example: 1
             example: myCouponId
       required:
         - fields
@@ -484,6 +514,7 @@ components:
       required:
         - fields
         - searchPhrase
+      additionalProperties: false
     String256:
       type: string
       maxLength: 256
@@ -510,6 +541,7 @@ components:
           type: string
       required:
         - field
+      additionalProperties: false
     Offset:
       default: 0
       minimum: 0
@@ -623,6 +655,7 @@ components:
             sortOrder: desc
         offset: 2
         total: 8
+      additionalProperties: false
     CampaignId:
       minLength: 1
       maxLength: 256

…oas/assignments-oas-1.0.34/exchange.json apis/assignments-oas-1.0.35/exchange.jsonapis/assignments-oas/assignments-oas-1.0.34/exchange.json renamed to apis/assignments-oas-1.0.35/exchange.json apis/assignments-oas/assignments-oas-1.0.34/exchange.json renamed to apis/assignments-oas-1.0.35/exchange.json

@@ -3,7 +3,7 @@
   "name": "Assignments OAS",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "assignments-oas",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "classifier": "oas",
   "tags": [],
   "descriptorVersion": "1.0.0",