diff --git a/.nycrc.json b/.nycrc.json index 096322bf..6267c583 100644 --- a/.nycrc.json +++ b/.nycrc.json @@ -5,7 +5,7 @@ "exclude": [ "src/updateApis.ts", "src/lib/config.ts", - "src/generate-oas.ts", + "src/generateOas.ts", "src/static/helpers/index.ts", "src/lib/utils.ts" ], diff --git a/CHANGELOG.md b/CHANGELOG.md index 83d5628e..5bb19f6a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,41 @@ ## CHANGELOG ## v5.0.0 + +### API Versions + +| API Name | API Version | +|----------|-------------| +| assignments | 1.0.35 | +| campaigns | 1.0.37 | +| catalogs | 1.0.41 | +| cdn-api-process-apis | 1.0.39 | +| cors-preferences | 1.0.4 | +| coupons | 1.0.39 | +| customers | 1.0.32 | +| gift-certificates | 1.0.39 | +| orders | 1.4.9 | +| preferences | 1.1.3 | +| products | 1.0.40 | +| promotions | 1.0.33 | +| seo | 1.0.7 | +| shopper-baskets | 2.0.16 | +| shopper-baskets | 1.8.25 | +| shopper-context | 1.0.35 | +| shopper-customers | 1.0.53 | +| shopper-experience | 1.0.7 | +| shopper-gift-certificates | 1.0.26 | +| shopper-login | 1.39.40 | +| shopper-orders | 1.4.13 | +| shopper-products | 1.0.37 | +| shopper-promotions | 1.0.36 | +| shopper-search | 1.2.3 | +| 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 - SLAS helpers have been refactored to accept a single `options` object argument, where the properties are the old arguments diff --git a/apis/assignments-oas/assignments-oas-1.0.34/.metadata.json b/apis/assignments-oas/assignments-oas-1.0.35/.metadata.json similarity index 91% rename from apis/assignments-oas/assignments-oas-1.0.34/.metadata.json rename to apis/assignments-oas/assignments-oas-1.0.35/.metadata.json index 54ec312c..cfc7a5a8 100644 --- a/apis/assignments-oas/assignments-oas-1.0.34/.metadata.json +++ b/apis/assignments-oas/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" diff --git a/apis/assignments-oas/assignments-oas-1.0.34/assignments-oas-v1-internal.yaml b/apis/assignments-oas/assignments-oas-1.0.35/assignments-oas-v1-internal.yaml similarity index 97% rename from apis/assignments-oas/assignments-oas-1.0.34/assignments-oas-v1-internal.yaml rename to apis/assignments-oas/assignments-oas-1.0.35/assignments-oas-v1-internal.yaml index 73a7ca17..24430285 100644 --- a/apis/assignments-oas/assignments-oas-1.0.34/assignments-oas-v1-internal.yaml +++ b/apis/assignments-oas/assignments-oas-1.0.35/assignments-oas-v1-internal.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 diff --git a/apis/assignments-oas/assignments-oas-1.0.34/assignments-oas-v1-public.yaml b/apis/assignments-oas/assignments-oas-1.0.35/assignments-oas-v1-public.yaml similarity index 97% rename from apis/assignments-oas/assignments-oas-1.0.34/assignments-oas-v1-public.yaml rename to apis/assignments-oas/assignments-oas-1.0.35/assignments-oas-v1-public.yaml index 73a7ca17..24430285 100644 --- a/apis/assignments-oas/assignments-oas-1.0.34/assignments-oas-v1-public.yaml +++ b/apis/assignments-oas/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 diff --git a/apis/assignments-oas/assignments-oas-1.0.34/exchange.json b/apis/assignments-oas/assignments-oas-1.0.35/exchange.json similarity index 93% rename from apis/assignments-oas/assignments-oas-1.0.34/exchange.json rename to apis/assignments-oas/assignments-oas-1.0.35/exchange.json index bc38c6b3..1dbdeaa7 100644 --- a/apis/assignments-oas/assignments-oas-1.0.34/exchange.json +++ b/apis/assignments-oas/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", diff --git a/apis/campaigns-oas/campaigns-oas-1.0.36/.metadata.json b/apis/campaigns-oas/campaigns-oas-1.0.37/.metadata.json similarity index 91% rename from apis/campaigns-oas/campaigns-oas-1.0.36/.metadata.json rename to apis/campaigns-oas/campaigns-oas-1.0.37/.metadata.json index e2bdfc1f..86ebc01c 100644 --- a/apis/campaigns-oas/campaigns-oas-1.0.36/.metadata.json +++ b/apis/campaigns-oas/campaigns-oas-1.0.37/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/campaigns-oas/1.0.36", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/campaigns-oas/1.0.37", "name": "Campaigns OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "campaigns-oas", - "version": "1.0.36", + "version": "1.0.37", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/campaigns-oas/campaigns-oas-1.0.36/campaigns-oas-v1-internal.yaml b/apis/campaigns-oas/campaigns-oas-1.0.37/campaigns-oas-v1-internal.yaml similarity index 97% rename from apis/campaigns-oas/campaigns-oas-1.0.36/campaigns-oas-v1-internal.yaml rename to apis/campaigns-oas/campaigns-oas-1.0.37/campaigns-oas-v1-internal.yaml index 07ade22c..f9617bce 100644 --- a/apis/campaigns-oas/campaigns-oas-1.0.36/campaigns-oas-v1-internal.yaml +++ b/apis/campaigns-oas/campaigns-oas-1.0.37/campaigns-oas-v1-internal.yaml @@ -321,6 +321,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 @@ -358,6 +359,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -386,6 +388,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: @@ -419,6 +422,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -495,6 +499,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. @@ -508,16 +513,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 @@ -560,6 +579,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: @@ -583,6 +603,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 @@ -631,6 +652,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. @@ -664,7 +686,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 @@ -690,6 +720,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -716,6 +747,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -829,6 +861,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false CampaignId: minLength: 1 maxLength: 256 diff --git a/apis/campaigns-oas/campaigns-oas-1.0.36/campaigns-oas-v1-public.yaml b/apis/campaigns-oas/campaigns-oas-1.0.37/campaigns-oas-v1-public.yaml similarity index 97% rename from apis/campaigns-oas/campaigns-oas-1.0.36/campaigns-oas-v1-public.yaml rename to apis/campaigns-oas/campaigns-oas-1.0.37/campaigns-oas-v1-public.yaml index 07ade22c..f9617bce 100644 --- a/apis/campaigns-oas/campaigns-oas-1.0.36/campaigns-oas-v1-public.yaml +++ b/apis/campaigns-oas/campaigns-oas-1.0.37/campaigns-oas-v1-public.yaml @@ -321,6 +321,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 @@ -358,6 +359,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -386,6 +388,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: @@ -419,6 +422,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -495,6 +499,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. @@ -508,16 +513,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 @@ -560,6 +579,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: @@ -583,6 +603,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 @@ -631,6 +652,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. @@ -664,7 +686,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 @@ -690,6 +720,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -716,6 +747,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -829,6 +861,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false CampaignId: minLength: 1 maxLength: 256 diff --git a/apis/campaigns-oas/campaigns-oas-1.0.36/exchange.json b/apis/campaigns-oas/campaigns-oas-1.0.37/exchange.json similarity index 92% rename from apis/campaigns-oas/campaigns-oas-1.0.36/exchange.json rename to apis/campaigns-oas/campaigns-oas-1.0.37/exchange.json index 188f7449..c8bbae12 100644 --- a/apis/campaigns-oas/campaigns-oas-1.0.36/exchange.json +++ b/apis/campaigns-oas/campaigns-oas-1.0.37/exchange.json @@ -3,7 +3,7 @@ "name": "Campaigns OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "campaigns-oas", - "version": "1.0.36", + "version": "1.0.37", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/catalogs-oas/catalogs-oas-1.0.39/.metadata.json b/apis/catalogs-oas/catalogs-oas-1.0.41/.metadata.json similarity index 72% rename from apis/catalogs-oas/catalogs-oas-1.0.39/.metadata.json rename to apis/catalogs-oas/catalogs-oas-1.0.41/.metadata.json index 2cfef8b5..f91af58d 100644 --- a/apis/catalogs-oas/catalogs-oas-1.0.39/.metadata.json +++ b/apis/catalogs-oas/catalogs-oas-1.0.41/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/catalogs-oas/1.0.39", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/catalogs-oas/1.0.41", "name": "Catalogs OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "catalogs-oas", - "version": "1.0.39", + "version": "1.0.41", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/catalogs-oas/catalogs-oas-1.0.39/catalogs-oas-v1-internal.yaml b/apis/catalogs-oas/catalogs-oas-1.0.41/catalogs-oas-v1-internal.yaml similarity index 98% rename from apis/catalogs-oas/catalogs-oas-1.0.39/catalogs-oas-v1-internal.yaml rename to apis/catalogs-oas/catalogs-oas-1.0.41/catalogs-oas-v1-internal.yaml index 4b2799e5..09b87e92 100644 --- a/apis/catalogs-oas/catalogs-oas-1.0.39/catalogs-oas-v1-internal.yaml +++ b/apis/catalogs-oas/catalogs-oas-1.0.41/catalogs-oas-v1-internal.yaml @@ -2092,13 +2092,15 @@ components: description: Document representing a link to a customer list. description: type: object - additionalProperties: false + additionalProperties: + type: string description: The description of this site. example: default: Prototypical site used for starting point displayName: type: object - additionalProperties: false + additionalProperties: + type: string description: The display name entered by the user. example: default: Site Genesis @@ -2273,7 +2275,8 @@ components: example: 253402214400 description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the category. example: en_US: Mens Clothing Outerwear @@ -2296,7 +2299,8 @@ components: example: 253402214400 name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the category. example: en_US: Mens Clothing Outerwear @@ -2306,19 +2310,22 @@ components: example: true pageDescription: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page description of the category. example: en_US: Mens Outerwear Category pageKeywords: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page keywords for the category. example: en_US: Outerwear pageTitle: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page title of the category. example: en_US: Mens Clothing Outerwear @@ -2534,6 +2541,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 @@ -2571,6 +2579,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -2599,6 +2608,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: @@ -2632,6 +2642,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -2708,6 +2719,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. @@ -2721,16 +2733,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 @@ -2773,6 +2799,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: @@ -2796,6 +2823,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 @@ -2844,6 +2872,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. @@ -2877,7 +2906,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 @@ -2903,6 +2940,7 @@ components: required: - fields - searchPhrase + additionalProperties: false Sort: description: Document representing a sort request. Each API has a different default sort configuration that can be modified in the request. example: @@ -2924,6 +2962,7 @@ components: type: string required: - field + additionalProperties: false SearchRequest: description: Document representing a search request for retrieving items within the Data API. The query is a potentially complex set of expressions. The fields and expands that each query supports are defined within the search resource. type: object @@ -2961,6 +3000,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false PaginatedSearchResult: description: Document representing a generic search result. Each search resource should extend this to define what is returned in the `hits`. properties: @@ -3014,6 +3054,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false CatalogCategoryId: required: - catalogId @@ -3084,7 +3125,8 @@ components: example: 253402214400 localizedTaxClassId: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized tax class identifier of the product. example: en_US: exempt @@ -3105,7 +3147,8 @@ components: $ref: '#/components/schemas/Master' name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the product. example: en_US: Apple Ipod Classic @@ -3115,7 +3158,8 @@ components: example: true onlineFlag: type: object - additionalProperties: false + additionalProperties: + type: boolean description: The site-specific online status of the product. example: Site1: true @@ -3125,25 +3169,29 @@ components: example: apple-master-catalog owningCatalogName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the catalog that owns the product. It is read only. example: en_US: Apple Master Catalog pageDescription: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page description of the product. example: en_US: Page Description pageKeywords: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page keywords of the product. example: en_US: Keywords pageTitle: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page title of the product. example: en_US: Page Title @@ -3187,7 +3235,8 @@ components: description: The array of product sets which the product belongs to. It is read only. searchable: type: object - additionalProperties: false + additionalProperties: + type: boolean description: The site-specific searchable status of the product. example: Site1: true @@ -3226,13 +3275,15 @@ components: example: 66JSD88JASD validFrom: type: object - additionalProperties: false + additionalProperties: + type: string description: The valid/online from date of the product. example: default@SiteGenesis: '2000-05-11T00:00:00.000Z' validTo: type: object - additionalProperties: false + additionalProperties: + type: string description: The valid/online to date of the product. example: default@SiteGenesis: '2050-05-11T00:00:00.000Z' @@ -3255,7 +3306,8 @@ components: description: The array of variation groups in the product. This is applicable for product type "master" only. It is read only. variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: |- The variation values selected for the product in variation attribute id and value pairs. This is applicable for product types "Variant" and "VariationGroup" only. It is read only. @@ -3280,7 +3332,8 @@ components: example: https://www.example-image.com/images/apple-ipod-classic.jpg alt: type: object - additionalProperties: false + additionalProperties: + type: string description: The alternative image text. example: en_US: iPod @@ -3294,7 +3347,8 @@ components: example: /images/apple-ipod-classic.jpg title: type: object - additionalProperties: false + additionalProperties: + type: string description: The image title. example: en_US: iPod @@ -3306,7 +3360,8 @@ components: properties: description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the variation value. example: en_US: Red @@ -3316,7 +3371,8 @@ components: $ref: '#/components/schemas/MediaFile' name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation value. example: color: Red @@ -3346,7 +3402,8 @@ components: example: color attributeDefinitionName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation attribute definition. example: en_US: Color @@ -3361,7 +3418,8 @@ components: example: color name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation attribute. example: en_US: Color @@ -3506,7 +3564,8 @@ components: example: extension value: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized value of the product option. example: en_US: 5 Year Warranty @@ -3518,7 +3577,8 @@ components: properties: customName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized custom name of the product option. example: en_US: Warranty @@ -3528,7 +3588,8 @@ components: example: 5-years description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the product option. example: en_US: Option Description @@ -3657,7 +3718,8 @@ components: $ref: '#/components/schemas/ProductId' searchable: type: object - additionalProperties: false + additionalProperties: + type: boolean description: A flag indicating whether the variant is searchable. example: Site1: true @@ -3668,7 +3730,8 @@ components: description: Variation attributes. variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: The actual variation attribute ID - value pairs. example: color: black @@ -3695,7 +3758,8 @@ components: example: apple-ipod-classic-black variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: The actual variation attribute ID - value pairs. example: color: red @@ -3748,6 +3812,7 @@ components: description: The name of the product. example: default: Summer Bomber Jacket + additionalProperties: false description: Document representing a category product assignment. CategoryProductAssignmentSearchResult: required: @@ -3799,6 +3864,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false ExecutionJobStatusResult: required: - jobStatus @@ -4090,6 +4156,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false CategorySearchResult: required: - limit @@ -4140,6 +4207,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false CatalogSearchRequest: required: - query @@ -4156,6 +4224,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false CatalogSearchResult: required: - limit @@ -4206,6 +4275,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false CategorySearchRequest: required: - query @@ -4222,6 +4292,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false parameters: organizationId: description: An identifier for the organization the request is being made by diff --git a/apis/catalogs-oas/catalogs-oas-1.0.39/catalogs-oas-v1-public.yaml b/apis/catalogs-oas/catalogs-oas-1.0.41/catalogs-oas-v1-public.yaml similarity index 98% rename from apis/catalogs-oas/catalogs-oas-1.0.39/catalogs-oas-v1-public.yaml rename to apis/catalogs-oas/catalogs-oas-1.0.41/catalogs-oas-v1-public.yaml index d1591495..7d7eea11 100644 --- a/apis/catalogs-oas/catalogs-oas-1.0.39/catalogs-oas-v1-public.yaml +++ b/apis/catalogs-oas/catalogs-oas-1.0.41/catalogs-oas-v1-public.yaml @@ -2092,13 +2092,15 @@ components: description: Document representing a link to a customer list. description: type: object - additionalProperties: false + additionalProperties: + type: string description: The description of this site. example: default: Prototypical site used for starting point displayName: type: object - additionalProperties: false + additionalProperties: + type: string description: The display name entered by the user. example: default: Site Genesis @@ -2273,7 +2275,8 @@ components: example: 253402214400 description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the category. example: en_US: Mens Clothing Outerwear @@ -2296,7 +2299,8 @@ components: example: 253402214400 name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the category. example: en_US: Mens Clothing Outerwear @@ -2306,19 +2310,22 @@ components: example: true pageDescription: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page description of the category. example: en_US: Mens Outerwear Category pageKeywords: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page keywords for the category. example: en_US: Outerwear pageTitle: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page title of the category. example: en_US: Mens Clothing Outerwear @@ -2534,6 +2541,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 @@ -2571,6 +2579,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -2599,6 +2608,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: @@ -2632,6 +2642,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -2708,6 +2719,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. @@ -2721,16 +2733,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 @@ -2773,6 +2799,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: @@ -2796,6 +2823,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 @@ -2844,6 +2872,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. @@ -2877,7 +2906,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 @@ -2903,6 +2940,7 @@ components: required: - fields - searchPhrase + additionalProperties: false Sort: description: Document representing a sort request. Each API has a different default sort configuration that can be modified in the request. example: @@ -2924,6 +2962,7 @@ components: type: string required: - field + additionalProperties: false SearchRequest: description: Document representing a search request for retrieving items within the Data API. The query is a potentially complex set of expressions. The fields and expands that each query supports are defined within the search resource. type: object @@ -2961,6 +3000,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false PaginatedSearchResult: description: Document representing a generic search result. Each search resource should extend this to define what is returned in the `hits`. properties: @@ -3014,6 +3054,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false CatalogCategoryId: required: - catalogId @@ -3084,7 +3125,8 @@ components: example: 253402214400 localizedTaxClassId: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized tax class identifier of the product. example: en_US: exempt @@ -3105,7 +3147,8 @@ components: $ref: '#/components/schemas/Master' name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the product. example: en_US: Apple Ipod Classic @@ -3115,7 +3158,8 @@ components: example: true onlineFlag: type: object - additionalProperties: false + additionalProperties: + type: boolean description: The site-specific online status of the product. example: Site1: true @@ -3125,25 +3169,29 @@ components: example: apple-master-catalog owningCatalogName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the catalog that owns the product. It is read only. example: en_US: Apple Master Catalog pageDescription: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page description of the product. example: en_US: Page Description pageKeywords: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page keywords of the product. example: en_US: Keywords pageTitle: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page title of the product. example: en_US: Page Title @@ -3187,7 +3235,8 @@ components: description: The array of product sets which the product belongs to. It is read only. searchable: type: object - additionalProperties: false + additionalProperties: + type: boolean description: The site-specific searchable status of the product. example: Site1: true @@ -3226,13 +3275,15 @@ components: example: 66JSD88JASD validFrom: type: object - additionalProperties: false + additionalProperties: + type: string description: The valid/online from date of the product. example: default@SiteGenesis: '2000-05-11T00:00:00.000Z' validTo: type: object - additionalProperties: false + additionalProperties: + type: string description: The valid/online to date of the product. example: default@SiteGenesis: '2050-05-11T00:00:00.000Z' @@ -3255,7 +3306,8 @@ components: description: The array of variation groups in the product. This is applicable for product type "master" only. It is read only. variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: |- The variation values selected for the product in variation attribute id and value pairs. This is applicable for product types "Variant" and "VariationGroup" only. It is read only. @@ -3280,7 +3332,8 @@ components: example: https://www.example-image.com/images/apple-ipod-classic.jpg alt: type: object - additionalProperties: false + additionalProperties: + type: string description: The alternative image text. example: en_US: iPod @@ -3294,7 +3347,8 @@ components: example: /images/apple-ipod-classic.jpg title: type: object - additionalProperties: false + additionalProperties: + type: string description: The image title. example: en_US: iPod @@ -3306,7 +3360,8 @@ components: properties: description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the variation value. example: en_US: Red @@ -3316,7 +3371,8 @@ components: $ref: '#/components/schemas/MediaFile' name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation value. example: color: Red @@ -3346,7 +3402,8 @@ components: example: color attributeDefinitionName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation attribute definition. example: en_US: Color @@ -3361,7 +3418,8 @@ components: example: color name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation attribute. example: en_US: Color @@ -3506,7 +3564,8 @@ components: example: extension value: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized value of the product option. example: en_US: 5 Year Warranty @@ -3518,7 +3577,8 @@ components: properties: customName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized custom name of the product option. example: en_US: Warranty @@ -3528,7 +3588,8 @@ components: example: 5-years description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the product option. example: en_US: Option Description @@ -3657,7 +3718,8 @@ components: $ref: '#/components/schemas/ProductId' searchable: type: object - additionalProperties: false + additionalProperties: + type: boolean description: A flag indicating whether the variant is searchable. example: Site1: true @@ -3668,7 +3730,8 @@ components: description: Variation attributes. variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: The actual variation attribute ID - value pairs. example: color: black @@ -3695,7 +3758,8 @@ components: example: apple-ipod-classic-black variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: The actual variation attribute ID - value pairs. example: color: red @@ -3748,6 +3812,7 @@ components: description: The name of the product. example: default: Summer Bomber Jacket + additionalProperties: false description: Document representing a category product assignment. CategoryProductAssignmentSearchResult: required: @@ -3799,6 +3864,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false ExecutionJobStatusResult: required: - jobStatus @@ -4090,6 +4156,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false CategorySearchResult: required: - limit @@ -4140,6 +4207,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false CatalogSearchRequest: required: - query @@ -4156,6 +4224,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false CatalogSearchResult: required: - limit @@ -4206,6 +4275,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false CategorySearchRequest: required: - query @@ -4222,6 +4292,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false parameters: organizationId: description: An identifier for the organization the request is being made by diff --git a/apis/catalogs-oas/catalogs-oas-1.0.39/exchange.json b/apis/catalogs-oas/catalogs-oas-1.0.41/exchange.json similarity index 92% rename from apis/catalogs-oas/catalogs-oas-1.0.39/exchange.json rename to apis/catalogs-oas/catalogs-oas-1.0.41/exchange.json index 60a31074..05b5502a 100644 --- a/apis/catalogs-oas/catalogs-oas-1.0.39/exchange.json +++ b/apis/catalogs-oas/catalogs-oas-1.0.41/exchange.json @@ -3,7 +3,7 @@ "name": "Catalogs OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "catalogs-oas", - "version": "1.0.39", + "version": "1.0.41", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/.metadata.json b/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/.metadata.json similarity index 89% rename from apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/.metadata.json rename to apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/.metadata.json index 1dd816fd..b7311862 100644 --- a/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/.metadata.json +++ b/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis-oas/1.0.38", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis-oas/1.0.39", "name": "CDN API - Process APIs OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "cdn-api-process-apis-oas", - "version": "1.0.38", + "version": "1.0.39", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/cdn-api-process-apis-oas-v1-internal.yaml b/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/cdn-api-process-apis-oas-v1-internal.yaml similarity index 99% rename from apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/cdn-api-process-apis-oas-v1-internal.yaml rename to apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/cdn-api-process-apis-oas-v1-internal.yaml index 7634966e..1cd761e1 100644 --- a/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/cdn-api-process-apis-oas-v1-internal.yaml +++ b/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/cdn-api-process-apis-oas-v1-internal.yaml @@ -5119,6 +5119,7 @@ components: zoneId: example1-zone-Id name: example1.com status: pending + additionalProperties: false ZonesEnvelope: required: - data @@ -5162,6 +5163,7 @@ components: action: monitor mode: true description: SQL injection protection + additionalProperties: false WafGroupsEnvelope: type: object required: @@ -5217,6 +5219,7 @@ components: action: monitor defaultAction: challenge description: SQL injection protection + additionalProperties: false WafRulesEnvelope: type: object required: @@ -5295,6 +5298,7 @@ components: - 'off' example: brotliCompression: 'off' + additionalProperties: false SpeedSettingsEnvelope: type: object required: diff --git a/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/cdn-api-process-apis-oas-v1-public.yaml b/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/cdn-api-process-apis-oas-v1-public.yaml similarity index 99% rename from apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/cdn-api-process-apis-oas-v1-public.yaml rename to apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/cdn-api-process-apis-oas-v1-public.yaml index 7634966e..1cd761e1 100644 --- a/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/cdn-api-process-apis-oas-v1-public.yaml +++ b/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/cdn-api-process-apis-oas-v1-public.yaml @@ -5119,6 +5119,7 @@ components: zoneId: example1-zone-Id name: example1.com status: pending + additionalProperties: false ZonesEnvelope: required: - data @@ -5162,6 +5163,7 @@ components: action: monitor mode: true description: SQL injection protection + additionalProperties: false WafGroupsEnvelope: type: object required: @@ -5217,6 +5219,7 @@ components: action: monitor defaultAction: challenge description: SQL injection protection + additionalProperties: false WafRulesEnvelope: type: object required: @@ -5295,6 +5298,7 @@ components: - 'off' example: brotliCompression: 'off' + additionalProperties: false SpeedSettingsEnvelope: type: object required: diff --git a/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/exchange.json b/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/exchange.json similarity index 93% rename from apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/exchange.json rename to apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/exchange.json index 5fb5d9cd..4e35bb27 100644 --- a/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.38/exchange.json +++ b/apis/cdn-api-process-apis-oas/cdn-api-process-apis-oas-1.0.39/exchange.json @@ -3,7 +3,7 @@ "name": "CDN API - Process APIs OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "cdn-api-process-apis-oas", - "version": "1.0.38", + "version": "1.0.39", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/coupons-oas/coupons-oas-1.0.38/.metadata.json b/apis/coupons-oas/coupons-oas-1.0.39/.metadata.json similarity index 73% rename from apis/coupons-oas/coupons-oas-1.0.38/.metadata.json rename to apis/coupons-oas/coupons-oas-1.0.39/.metadata.json index 97680fbd..3bb0fdb9 100644 --- a/apis/coupons-oas/coupons-oas-1.0.38/.metadata.json +++ b/apis/coupons-oas/coupons-oas-1.0.39/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/coupons-oas/1.0.38", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/coupons-oas/1.0.39", "name": "Coupons OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "coupons-oas", - "version": "1.0.38", + "version": "1.0.39", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/coupons-oas/coupons-oas-1.0.38/coupons-oas-v1-internal.yaml b/apis/coupons-oas/coupons-oas-1.0.39/coupons-oas-v1-internal.yaml similarity index 98% rename from apis/coupons-oas/coupons-oas-1.0.38/coupons-oas-v1-internal.yaml rename to apis/coupons-oas/coupons-oas-1.0.39/coupons-oas-v1-internal.yaml index 52654b1c..3f028ae9 100644 --- a/apis/coupons-oas/coupons-oas-1.0.38/coupons-oas-v1-internal.yaml +++ b/apis/coupons-oas/coupons-oas-1.0.39/coupons-oas-v1-internal.yaml @@ -497,6 +497,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 @@ -534,6 +535,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -562,6 +564,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: @@ -595,6 +598,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -671,6 +675,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. @@ -684,16 +689,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 @@ -736,6 +755,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: @@ -759,6 +779,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 @@ -807,6 +828,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. @@ -840,7 +862,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 @@ -866,6 +896,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -892,6 +923,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -1005,6 +1037,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false RedemptionLimitPerPeriod: description: Document representing a coupon redemption limit. type: object diff --git a/apis/coupons-oas/coupons-oas-1.0.38/coupons-oas-v1-public.yaml b/apis/coupons-oas/coupons-oas-1.0.39/coupons-oas-v1-public.yaml similarity index 98% rename from apis/coupons-oas/coupons-oas-1.0.38/coupons-oas-v1-public.yaml rename to apis/coupons-oas/coupons-oas-1.0.39/coupons-oas-v1-public.yaml index 52654b1c..3f028ae9 100644 --- a/apis/coupons-oas/coupons-oas-1.0.38/coupons-oas-v1-public.yaml +++ b/apis/coupons-oas/coupons-oas-1.0.39/coupons-oas-v1-public.yaml @@ -497,6 +497,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 @@ -534,6 +535,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -562,6 +564,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: @@ -595,6 +598,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -671,6 +675,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. @@ -684,16 +689,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 @@ -736,6 +755,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: @@ -759,6 +779,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 @@ -807,6 +828,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. @@ -840,7 +862,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 @@ -866,6 +896,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -892,6 +923,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -1005,6 +1037,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false RedemptionLimitPerPeriod: description: Document representing a coupon redemption limit. type: object diff --git a/apis/coupons-oas/coupons-oas-1.0.38/exchange.json b/apis/coupons-oas/coupons-oas-1.0.39/exchange.json similarity index 92% rename from apis/coupons-oas/coupons-oas-1.0.38/exchange.json rename to apis/coupons-oas/coupons-oas-1.0.39/exchange.json index 282f791f..d25c7004 100644 --- a/apis/coupons-oas/coupons-oas-1.0.38/exchange.json +++ b/apis/coupons-oas/coupons-oas-1.0.39/exchange.json @@ -3,7 +3,7 @@ "name": "Coupons OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "coupons-oas", - "version": "1.0.38", + "version": "1.0.39", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/customers-oas/customers-oas-1.0.31/.metadata.json b/apis/customers-oas/customers-oas-1.0.32/.metadata.json similarity index 91% rename from apis/customers-oas/customers-oas-1.0.31/.metadata.json rename to apis/customers-oas/customers-oas-1.0.32/.metadata.json index 5768c18b..7fc179c3 100644 --- a/apis/customers-oas/customers-oas-1.0.31/.metadata.json +++ b/apis/customers-oas/customers-oas-1.0.32/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/customers-oas/1.0.31", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/customers-oas/1.0.32", "name": "Customers OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "customers-oas", - "version": "1.0.31", + "version": "1.0.32", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/customers-oas/customers-oas-1.0.31/customers-oas-v1-internal.yaml b/apis/customers-oas/customers-oas-1.0.32/customers-oas-v1-internal.yaml similarity index 98% rename from apis/customers-oas/customers-oas-1.0.31/customers-oas-v1-internal.yaml rename to apis/customers-oas/customers-oas-1.0.32/customers-oas-v1-internal.yaml index 3a21c192..e61ffe7a 100644 --- a/apis/customers-oas/customers-oas-1.0.31/customers-oas-v1-internal.yaml +++ b/apis/customers-oas/customers-oas-1.0.32/customers-oas-v1-internal.yaml @@ -868,6 +868,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 @@ -905,6 +906,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -933,6 +935,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: @@ -966,6 +969,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -1042,6 +1046,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. @@ -1055,16 +1060,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 @@ -1107,6 +1126,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: @@ -1130,6 +1150,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 @@ -1178,6 +1199,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. @@ -1211,7 +1233,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 @@ -1237,6 +1267,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -1263,6 +1294,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -1376,6 +1408,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false Credentials: required: - login @@ -1734,6 +1767,7 @@ components: - email searchPhrase: w.leung@gmail.com total: 1 + additionalProperties: false ErrorResponse: type: object additionalProperties: true @@ -1886,6 +1920,7 @@ components: searchPhrase: Big offset: 0 total: 1 + additionalProperties: false examples: CustomerSearchBody: value: diff --git a/apis/customers-oas/customers-oas-1.0.31/customers-oas-v1-public.yaml b/apis/customers-oas/customers-oas-1.0.32/customers-oas-v1-public.yaml similarity index 98% rename from apis/customers-oas/customers-oas-1.0.31/customers-oas-v1-public.yaml rename to apis/customers-oas/customers-oas-1.0.32/customers-oas-v1-public.yaml index 3a21c192..e61ffe7a 100644 --- a/apis/customers-oas/customers-oas-1.0.31/customers-oas-v1-public.yaml +++ b/apis/customers-oas/customers-oas-1.0.32/customers-oas-v1-public.yaml @@ -868,6 +868,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 @@ -905,6 +906,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -933,6 +935,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: @@ -966,6 +969,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -1042,6 +1046,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. @@ -1055,16 +1060,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 @@ -1107,6 +1126,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: @@ -1130,6 +1150,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 @@ -1178,6 +1199,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. @@ -1211,7 +1233,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 @@ -1237,6 +1267,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -1263,6 +1294,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -1376,6 +1408,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false Credentials: required: - login @@ -1734,6 +1767,7 @@ components: - email searchPhrase: w.leung@gmail.com total: 1 + additionalProperties: false ErrorResponse: type: object additionalProperties: true @@ -1886,6 +1920,7 @@ components: searchPhrase: Big offset: 0 total: 1 + additionalProperties: false examples: CustomerSearchBody: value: diff --git a/apis/customers-oas/customers-oas-1.0.31/exchange.json b/apis/customers-oas/customers-oas-1.0.32/exchange.json similarity index 92% rename from apis/customers-oas/customers-oas-1.0.31/exchange.json rename to apis/customers-oas/customers-oas-1.0.32/exchange.json index 304eb6ad..d3dd76bd 100644 --- a/apis/customers-oas/customers-oas-1.0.31/exchange.json +++ b/apis/customers-oas/customers-oas-1.0.32/exchange.json @@ -3,7 +3,7 @@ "name": "Customers OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "customers-oas", - "version": "1.0.31", + "version": "1.0.32", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/customers-oas/shopper-customers-oas-1.0.52/.metadata.json b/apis/customers-oas/shopper-customers-oas-1.0.53/.metadata.json similarity index 90% rename from apis/customers-oas/shopper-customers-oas-1.0.52/.metadata.json rename to apis/customers-oas/shopper-customers-oas-1.0.53/.metadata.json index ec46c726..4974c225 100644 --- a/apis/customers-oas/shopper-customers-oas-1.0.52/.metadata.json +++ b/apis/customers-oas/shopper-customers-oas-1.0.53/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-customers-oas/1.0.52", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-customers-oas/1.0.53", "name": "Shopper Customers OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-customers-oas", - "version": "1.0.52", + "version": "1.0.53", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/customers-oas/shopper-customers-oas-1.0.52/exchange.json b/apis/customers-oas/shopper-customers-oas-1.0.53/exchange.json similarity index 93% rename from apis/customers-oas/shopper-customers-oas-1.0.52/exchange.json rename to apis/customers-oas/shopper-customers-oas-1.0.53/exchange.json index 95053791..0a6f7a85 100644 --- a/apis/customers-oas/shopper-customers-oas-1.0.52/exchange.json +++ b/apis/customers-oas/shopper-customers-oas-1.0.53/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Customers OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-customers-oas", - "version": "1.0.52", + "version": "1.0.53", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/customers-oas/shopper-customers-oas-1.0.52/shopper-customers-oas-v1-internal.yaml b/apis/customers-oas/shopper-customers-oas-1.0.53/shopper-customers-oas-v1-internal.yaml similarity index 100% rename from apis/customers-oas/shopper-customers-oas-1.0.52/shopper-customers-oas-v1-internal.yaml rename to apis/customers-oas/shopper-customers-oas-1.0.53/shopper-customers-oas-v1-internal.yaml diff --git a/apis/customers-oas/shopper-customers-oas-1.0.52/shopper-customers-oas-v1-public.yaml b/apis/customers-oas/shopper-customers-oas-1.0.53/shopper-customers-oas-v1-public.yaml similarity index 100% rename from apis/customers-oas/shopper-customers-oas-1.0.52/shopper-customers-oas-v1-public.yaml rename to apis/customers-oas/shopper-customers-oas-1.0.53/shopper-customers-oas-v1-public.yaml diff --git a/apis/gift-certificates-oas/gift-certificates-oas-1.0.38/.metadata.json b/apis/gift-certificates-oas/gift-certificates-oas-1.0.39/.metadata.json similarity index 89% rename from apis/gift-certificates-oas/gift-certificates-oas-1.0.38/.metadata.json rename to apis/gift-certificates-oas/gift-certificates-oas-1.0.39/.metadata.json index 0a589017..5fa98cb1 100644 --- a/apis/gift-certificates-oas/gift-certificates-oas-1.0.38/.metadata.json +++ b/apis/gift-certificates-oas/gift-certificates-oas-1.0.39/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/gift-certificates-oas/1.0.38", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/gift-certificates-oas/1.0.39", "name": "Gift Certificates OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "gift-certificates-oas", - "version": "1.0.38", + "version": "1.0.39", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/gift-certificates-oas/gift-certificates-oas-1.0.38/exchange.json b/apis/gift-certificates-oas/gift-certificates-oas-1.0.39/exchange.json similarity index 93% rename from apis/gift-certificates-oas/gift-certificates-oas-1.0.38/exchange.json rename to apis/gift-certificates-oas/gift-certificates-oas-1.0.39/exchange.json index c8eb6a47..43f37b06 100644 --- a/apis/gift-certificates-oas/gift-certificates-oas-1.0.38/exchange.json +++ b/apis/gift-certificates-oas/gift-certificates-oas-1.0.39/exchange.json @@ -3,7 +3,7 @@ "name": "Gift Certificates OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "gift-certificates-oas", - "version": "1.0.38", + "version": "1.0.39", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/gift-certificates-oas/gift-certificates-oas-1.0.38/gift-certificates-oas-v1-internal.yaml b/apis/gift-certificates-oas/gift-certificates-oas-1.0.39/gift-certificates-oas-v1-internal.yaml similarity index 97% rename from apis/gift-certificates-oas/gift-certificates-oas-1.0.38/gift-certificates-oas-v1-internal.yaml rename to apis/gift-certificates-oas/gift-certificates-oas-1.0.39/gift-certificates-oas-v1-internal.yaml index 1780fff5..d1754beb 100644 --- a/apis/gift-certificates-oas/gift-certificates-oas-1.0.38/gift-certificates-oas-v1-internal.yaml +++ b/apis/gift-certificates-oas/gift-certificates-oas-1.0.39/gift-certificates-oas-v1-internal.yaml @@ -539,6 +539,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 @@ -576,6 +577,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -604,6 +606,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: @@ -637,6 +640,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -713,6 +717,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. @@ -726,16 +731,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 @@ -778,6 +797,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: @@ -801,6 +821,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 @@ -849,6 +870,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. @@ -882,7 +904,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 @@ -908,6 +938,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -934,6 +965,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -1047,6 +1079,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false GiftCertificateSearchResult: type: object required: diff --git a/apis/gift-certificates-oas/gift-certificates-oas-1.0.38/gift-certificates-oas-v1-public.yaml b/apis/gift-certificates-oas/gift-certificates-oas-1.0.39/gift-certificates-oas-v1-public.yaml similarity index 97% rename from apis/gift-certificates-oas/gift-certificates-oas-1.0.38/gift-certificates-oas-v1-public.yaml rename to apis/gift-certificates-oas/gift-certificates-oas-1.0.39/gift-certificates-oas-v1-public.yaml index 1780fff5..d1754beb 100644 --- a/apis/gift-certificates-oas/gift-certificates-oas-1.0.38/gift-certificates-oas-v1-public.yaml +++ b/apis/gift-certificates-oas/gift-certificates-oas-1.0.39/gift-certificates-oas-v1-public.yaml @@ -539,6 +539,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 @@ -576,6 +577,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -604,6 +606,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: @@ -637,6 +640,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -713,6 +717,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. @@ -726,16 +731,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 @@ -778,6 +797,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: @@ -801,6 +821,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 @@ -849,6 +870,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. @@ -882,7 +904,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 @@ -908,6 +938,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -934,6 +965,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -1047,6 +1079,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false GiftCertificateSearchResult: type: object required: diff --git a/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/.metadata.json b/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/.metadata.json similarity index 89% rename from apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/.metadata.json rename to apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/.metadata.json index 7f751f88..c422b797 100644 --- a/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/.metadata.json +++ b/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-gift-certificates-oas/1.0.25", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-gift-certificates-oas/1.0.26", "name": "Shopper Gift Certificates OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-gift-certificates-oas", - "version": "1.0.25", + "version": "1.0.26", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/exchange.json b/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/exchange.json similarity index 93% rename from apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/exchange.json rename to apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/exchange.json index 7fc4fefe..15a341ad 100644 --- a/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/exchange.json +++ b/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Gift Certificates OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-gift-certificates-oas", - "version": "1.0.25", + "version": "1.0.26", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/shopper-gift-certificates-oas-v1-internal.yaml b/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/shopper-gift-certificates-oas-v1-internal.yaml similarity index 100% rename from apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/shopper-gift-certificates-oas-v1-internal.yaml rename to apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/shopper-gift-certificates-oas-v1-internal.yaml diff --git a/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/shopper-gift-certificates-oas-v1-public.yaml b/apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/shopper-gift-certificates-oas-v1-public.yaml similarity index 100% rename from apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.25/shopper-gift-certificates-oas-v1-public.yaml rename to apis/gift-certificates-oas/shopper-gift-certificates-oas-1.0.26/shopper-gift-certificates-oas-v1-public.yaml diff --git a/apis/orders-oas/orders-oas-1.4.8/.metadata.json b/apis/orders-oas/orders-oas-1.4.9/.metadata.json similarity index 73% rename from apis/orders-oas/orders-oas-1.4.8/.metadata.json rename to apis/orders-oas/orders-oas-1.4.9/.metadata.json index d2fc1519..1e8d0d3c 100644 --- a/apis/orders-oas/orders-oas-1.4.8/.metadata.json +++ b/apis/orders-oas/orders-oas-1.4.9/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/orders-oas/1.4.8", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/orders-oas/1.4.9", "name": "Orders OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "orders-oas", - "version": "1.4.8", + "version": "1.4.9", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/orders-oas/orders-oas-1.4.8/exchange.json b/apis/orders-oas/orders-oas-1.4.9/exchange.json similarity index 93% rename from apis/orders-oas/orders-oas-1.4.8/exchange.json rename to apis/orders-oas/orders-oas-1.4.9/exchange.json index 9849fc03..d8ad4099 100644 --- a/apis/orders-oas/orders-oas-1.4.8/exchange.json +++ b/apis/orders-oas/orders-oas-1.4.9/exchange.json @@ -3,7 +3,7 @@ "name": "Orders OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "orders-oas", - "version": "1.4.8", + "version": "1.4.9", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/orders-oas/orders-oas-1.4.8/orders-oas-v1-internal.yaml b/apis/orders-oas/orders-oas-1.4.9/orders-oas-v1-internal.yaml similarity index 100% rename from apis/orders-oas/orders-oas-1.4.8/orders-oas-v1-internal.yaml rename to apis/orders-oas/orders-oas-1.4.9/orders-oas-v1-internal.yaml diff --git a/apis/orders-oas/orders-oas-1.4.8/orders-oas-v1-public.yaml b/apis/orders-oas/orders-oas-1.4.9/orders-oas-v1-public.yaml similarity index 100% rename from apis/orders-oas/orders-oas-1.4.8/orders-oas-v1-public.yaml rename to apis/orders-oas/orders-oas-1.4.9/orders-oas-v1-public.yaml diff --git a/apis/orders-oas/shopper-orders-oas-1.4.12/.metadata.json b/apis/orders-oas/shopper-orders-oas-1.4.13/.metadata.json similarity index 91% rename from apis/orders-oas/shopper-orders-oas-1.4.12/.metadata.json rename to apis/orders-oas/shopper-orders-oas-1.4.13/.metadata.json index 89645d40..e7691432 100644 --- a/apis/orders-oas/shopper-orders-oas-1.4.12/.metadata.json +++ b/apis/orders-oas/shopper-orders-oas-1.4.13/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-orders-oas/1.4.12", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-orders-oas/1.4.13", "name": "Shopper Orders OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-orders-oas", - "version": "1.4.12", + "version": "1.4.13", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/orders-oas/shopper-orders-oas-1.4.12/exchange.json b/apis/orders-oas/shopper-orders-oas-1.4.13/exchange.json similarity index 93% rename from apis/orders-oas/shopper-orders-oas-1.4.12/exchange.json rename to apis/orders-oas/shopper-orders-oas-1.4.13/exchange.json index 2e4e8e61..517ff680 100644 --- a/apis/orders-oas/shopper-orders-oas-1.4.12/exchange.json +++ b/apis/orders-oas/shopper-orders-oas-1.4.13/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Orders OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-orders-oas", - "version": "1.4.12", + "version": "1.4.13", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/orders-oas/shopper-orders-oas-1.4.12/shopper-orders-oas-v1-internal.yaml b/apis/orders-oas/shopper-orders-oas-1.4.13/shopper-orders-oas-v1-internal.yaml similarity index 100% rename from apis/orders-oas/shopper-orders-oas-1.4.12/shopper-orders-oas-v1-internal.yaml rename to apis/orders-oas/shopper-orders-oas-1.4.13/shopper-orders-oas-v1-internal.yaml diff --git a/apis/orders-oas/shopper-orders-oas-1.4.12/shopper-orders-oas-v1-public.yaml b/apis/orders-oas/shopper-orders-oas-1.4.13/shopper-orders-oas-v1-public.yaml similarity index 100% rename from apis/orders-oas/shopper-orders-oas-1.4.12/shopper-orders-oas-v1-public.yaml rename to apis/orders-oas/shopper-orders-oas-1.4.13/shopper-orders-oas-v1-public.yaml diff --git a/apis/preferences-oas/cors-preferences-oas-1.0.3/.metadata.json b/apis/preferences-oas/cors-preferences-oas-1.0.4/.metadata.json similarity index 90% rename from apis/preferences-oas/cors-preferences-oas-1.0.3/.metadata.json rename to apis/preferences-oas/cors-preferences-oas-1.0.4/.metadata.json index 5694e458..9267bcb9 100644 --- a/apis/preferences-oas/cors-preferences-oas-1.0.3/.metadata.json +++ b/apis/preferences-oas/cors-preferences-oas-1.0.4/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cors-preferences-oas/1.0.3", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cors-preferences-oas/1.0.4", "name": "Cors Preferences OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "cors-preferences-oas", - "version": "1.0.3", + "version": "1.0.4", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/preferences-oas/cors-preferences-oas-1.0.3/cors-preferences-oas-v1-internal.yaml b/apis/preferences-oas/cors-preferences-oas-1.0.4/cors-preferences-oas-v1-internal.yaml similarity index 100% rename from apis/preferences-oas/cors-preferences-oas-1.0.3/cors-preferences-oas-v1-internal.yaml rename to apis/preferences-oas/cors-preferences-oas-1.0.4/cors-preferences-oas-v1-internal.yaml diff --git a/apis/preferences-oas/cors-preferences-oas-1.0.3/cors-preferences-oas-v1-public.yaml b/apis/preferences-oas/cors-preferences-oas-1.0.4/cors-preferences-oas-v1-public.yaml similarity index 100% rename from apis/preferences-oas/cors-preferences-oas-1.0.3/cors-preferences-oas-v1-public.yaml rename to apis/preferences-oas/cors-preferences-oas-1.0.4/cors-preferences-oas-v1-public.yaml diff --git a/apis/preferences-oas/cors-preferences-oas-1.0.3/exchange.json b/apis/preferences-oas/cors-preferences-oas-1.0.4/exchange.json similarity index 93% rename from apis/preferences-oas/cors-preferences-oas-1.0.3/exchange.json rename to apis/preferences-oas/cors-preferences-oas-1.0.4/exchange.json index ed572642..da25d3a8 100644 --- a/apis/preferences-oas/cors-preferences-oas-1.0.3/exchange.json +++ b/apis/preferences-oas/cors-preferences-oas-1.0.4/exchange.json @@ -3,7 +3,7 @@ "name": "Cors Preferences OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "cors-preferences-oas", - "version": "1.0.3", + "version": "1.0.4", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/preferences-oas/preferences-oas-1.1.2/.metadata.json b/apis/preferences-oas/preferences-oas-1.1.3/.metadata.json similarity index 91% rename from apis/preferences-oas/preferences-oas-1.1.2/.metadata.json rename to apis/preferences-oas/preferences-oas-1.1.3/.metadata.json index 8dd90559..c859cede 100644 --- a/apis/preferences-oas/preferences-oas-1.1.2/.metadata.json +++ b/apis/preferences-oas/preferences-oas-1.1.3/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/preferences-oas/1.1.2", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/preferences-oas/1.1.3", "name": "Preferences OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "preferences-oas", - "version": "1.1.2", + "version": "1.1.3", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/preferences-oas/preferences-oas-1.1.2/exchange.json b/apis/preferences-oas/preferences-oas-1.1.3/exchange.json similarity index 93% rename from apis/preferences-oas/preferences-oas-1.1.2/exchange.json rename to apis/preferences-oas/preferences-oas-1.1.3/exchange.json index fc9e9699..b69df4ab 100644 --- a/apis/preferences-oas/preferences-oas-1.1.2/exchange.json +++ b/apis/preferences-oas/preferences-oas-1.1.3/exchange.json @@ -3,7 +3,7 @@ "name": "Preferences OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "preferences-oas", - "version": "1.1.2", + "version": "1.1.3", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/preferences-oas/preferences-oas-1.1.2/preferences-oas-v1-internal.yaml b/apis/preferences-oas/preferences-oas-1.1.3/preferences-oas-v1-internal.yaml similarity index 100% rename from apis/preferences-oas/preferences-oas-1.1.2/preferences-oas-v1-internal.yaml rename to apis/preferences-oas/preferences-oas-1.1.3/preferences-oas-v1-internal.yaml diff --git a/apis/preferences-oas/preferences-oas-1.1.2/preferences-oas-v1-public.yaml b/apis/preferences-oas/preferences-oas-1.1.3/preferences-oas-v1-public.yaml similarity index 100% rename from apis/preferences-oas/preferences-oas-1.1.2/preferences-oas-v1-public.yaml rename to apis/preferences-oas/preferences-oas-1.1.3/preferences-oas-v1-public.yaml diff --git a/apis/products-oas/products-oas-1.0.39/.metadata.json b/apis/products-oas/products-oas-1.0.40/.metadata.json similarity index 72% rename from apis/products-oas/products-oas-1.0.39/.metadata.json rename to apis/products-oas/products-oas-1.0.40/.metadata.json index b6d0b534..8c69671a 100644 --- a/apis/products-oas/products-oas-1.0.39/.metadata.json +++ b/apis/products-oas/products-oas-1.0.40/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/products-oas/1.0.39", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/products-oas/1.0.40", "name": "Products OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "products-oas", - "version": "1.0.39", + "version": "1.0.40", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/products-oas/products-oas-1.0.39/exchange.json b/apis/products-oas/products-oas-1.0.40/exchange.json similarity index 92% rename from apis/products-oas/products-oas-1.0.39/exchange.json rename to apis/products-oas/products-oas-1.0.40/exchange.json index 71f64cc3..465d0b71 100644 --- a/apis/products-oas/products-oas-1.0.39/exchange.json +++ b/apis/products-oas/products-oas-1.0.40/exchange.json @@ -3,7 +3,7 @@ "name": "Products OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "products-oas", - "version": "1.0.39", + "version": "1.0.40", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/products-oas/products-oas-1.0.39/products-oas-v1-internal.yaml b/apis/products-oas/products-oas-1.0.40/products-oas-v1-internal.yaml similarity index 98% rename from apis/products-oas/products-oas-1.0.39/products-oas-v1-internal.yaml rename to apis/products-oas/products-oas-1.0.40/products-oas-v1-internal.yaml index 638f683a..8283ef97 100644 --- a/apis/products-oas/products-oas-1.0.39/products-oas-v1-internal.yaml +++ b/apis/products-oas/products-oas-1.0.40/products-oas-v1-internal.yaml @@ -2209,7 +2209,8 @@ components: example: 253402214400 localizedTaxClassId: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized tax class identifier of the product. example: en_US: exempt @@ -2230,7 +2231,8 @@ components: $ref: '#/components/schemas/Master' name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the product. example: en_US: Apple Ipod Classic @@ -2240,7 +2242,8 @@ components: example: true onlineFlag: type: object - additionalProperties: false + additionalProperties: + type: boolean description: The site-specific online status of the product. example: Site1: true @@ -2250,25 +2253,29 @@ components: example: apple-master-catalog owningCatalogName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the catalog that owns the product. It is read only. example: en_US: Apple Master Catalog pageDescription: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page description of the product. example: en_US: Page Description pageKeywords: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page keywords of the product. example: en_US: Keywords pageTitle: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page title of the product. example: en_US: Page Title @@ -2312,7 +2319,8 @@ components: description: The array of product sets which the product belongs to. It is read only. searchable: type: object - additionalProperties: false + additionalProperties: + type: boolean description: The site-specific searchable status of the product. example: Site1: true @@ -2351,13 +2359,15 @@ components: example: 66JSD88JASD validFrom: type: object - additionalProperties: false + additionalProperties: + type: string description: The valid/online from date of the product. example: default@SiteGenesis: '2000-05-11T00:00:00.000Z' validTo: type: object - additionalProperties: false + additionalProperties: + type: string description: The valid/online to date of the product. example: default@SiteGenesis: '2050-05-11T00:00:00.000Z' @@ -2380,7 +2390,8 @@ components: description: The array of variation groups in the product. This is applicable for product type "master" only. It is read only. variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: |- The variation values selected for the product in variation attribute id and value pairs. This is applicable for product types "Variant" and "VariationGroup" only. It is read only. @@ -2399,7 +2410,8 @@ components: example: https://www.example-image.com/images/apple-ipod-classic.jpg alt: type: object - additionalProperties: false + additionalProperties: + type: string description: The alternative image text. example: en_US: iPod @@ -2413,7 +2425,8 @@ components: example: /images/apple-ipod-classic.jpg title: type: object - additionalProperties: false + additionalProperties: + type: string description: The image title. example: en_US: iPod @@ -2425,7 +2438,8 @@ components: properties: description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the variation value. example: en_US: Red @@ -2435,7 +2449,8 @@ components: $ref: '#/components/schemas/MediaFile' name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation value. example: color: Red @@ -2465,7 +2480,8 @@ components: example: color attributeDefinitionName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation attribute definition. example: en_US: Color @@ -2480,7 +2496,8 @@ components: example: color name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation attribute. example: en_US: Color @@ -2625,7 +2642,8 @@ components: example: extension value: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized value of the product option. example: en_US: 5 Year Warranty @@ -2637,7 +2655,8 @@ components: properties: customName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized custom name of the product option. example: en_US: Warranty @@ -2647,7 +2666,8 @@ components: example: 5-years description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the product option. example: en_US: Option Description @@ -2776,7 +2796,8 @@ components: $ref: '#/components/schemas/ProductId' searchable: type: object - additionalProperties: false + additionalProperties: + type: boolean description: A flag indicating whether the variant is searchable. example: Site1: true @@ -2787,7 +2808,8 @@ components: description: Variation attributes. variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: The actual variation attribute ID - value pairs. example: color: black @@ -2814,7 +2836,8 @@ components: example: apple-ipod-classic-black variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: The actual variation attribute ID - value pairs. example: color: red @@ -2911,6 +2934,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 @@ -2948,6 +2972,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -2976,6 +3001,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: @@ -3009,6 +3035,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -3085,6 +3112,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. @@ -3098,16 +3126,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 @@ -3150,6 +3192,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: @@ -3173,6 +3216,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 @@ -3221,6 +3265,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. @@ -3254,7 +3299,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 @@ -3280,6 +3333,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -3306,6 +3360,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -3350,6 +3405,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false Total: default: 0 minimum: 0 @@ -3435,6 +3491,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false VariantSearchResult: required: - limit @@ -3664,6 +3721,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false ProductSearchResult: required: - limit diff --git a/apis/products-oas/products-oas-1.0.39/products-oas-v1-public.yaml b/apis/products-oas/products-oas-1.0.40/products-oas-v1-public.yaml similarity index 98% rename from apis/products-oas/products-oas-1.0.39/products-oas-v1-public.yaml rename to apis/products-oas/products-oas-1.0.40/products-oas-v1-public.yaml index 638f683a..8283ef97 100644 --- a/apis/products-oas/products-oas-1.0.39/products-oas-v1-public.yaml +++ b/apis/products-oas/products-oas-1.0.40/products-oas-v1-public.yaml @@ -2209,7 +2209,8 @@ components: example: 253402214400 localizedTaxClassId: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized tax class identifier of the product. example: en_US: exempt @@ -2230,7 +2231,8 @@ components: $ref: '#/components/schemas/Master' name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the product. example: en_US: Apple Ipod Classic @@ -2240,7 +2242,8 @@ components: example: true onlineFlag: type: object - additionalProperties: false + additionalProperties: + type: boolean description: The site-specific online status of the product. example: Site1: true @@ -2250,25 +2253,29 @@ components: example: apple-master-catalog owningCatalogName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized name of the catalog that owns the product. It is read only. example: en_US: Apple Master Catalog pageDescription: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page description of the product. example: en_US: Page Description pageKeywords: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page keywords of the product. example: en_US: Keywords pageTitle: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized page title of the product. example: en_US: Page Title @@ -2312,7 +2319,8 @@ components: description: The array of product sets which the product belongs to. It is read only. searchable: type: object - additionalProperties: false + additionalProperties: + type: boolean description: The site-specific searchable status of the product. example: Site1: true @@ -2351,13 +2359,15 @@ components: example: 66JSD88JASD validFrom: type: object - additionalProperties: false + additionalProperties: + type: string description: The valid/online from date of the product. example: default@SiteGenesis: '2000-05-11T00:00:00.000Z' validTo: type: object - additionalProperties: false + additionalProperties: + type: string description: The valid/online to date of the product. example: default@SiteGenesis: '2050-05-11T00:00:00.000Z' @@ -2380,7 +2390,8 @@ components: description: The array of variation groups in the product. This is applicable for product type "master" only. It is read only. variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: |- The variation values selected for the product in variation attribute id and value pairs. This is applicable for product types "Variant" and "VariationGroup" only. It is read only. @@ -2399,7 +2410,8 @@ components: example: https://www.example-image.com/images/apple-ipod-classic.jpg alt: type: object - additionalProperties: false + additionalProperties: + type: string description: The alternative image text. example: en_US: iPod @@ -2413,7 +2425,8 @@ components: example: /images/apple-ipod-classic.jpg title: type: object - additionalProperties: false + additionalProperties: + type: string description: The image title. example: en_US: iPod @@ -2425,7 +2438,8 @@ components: properties: description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the variation value. example: en_US: Red @@ -2435,7 +2449,8 @@ components: $ref: '#/components/schemas/MediaFile' name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation value. example: color: Red @@ -2465,7 +2480,8 @@ components: example: color attributeDefinitionName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation attribute definition. example: en_US: Color @@ -2480,7 +2496,8 @@ components: example: color name: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized display name of the variation attribute. example: en_US: Color @@ -2625,7 +2642,8 @@ components: example: extension value: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized value of the product option. example: en_US: 5 Year Warranty @@ -2637,7 +2655,8 @@ components: properties: customName: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized custom name of the product option. example: en_US: Warranty @@ -2647,7 +2666,8 @@ components: example: 5-years description: type: object - additionalProperties: false + additionalProperties: + type: string description: The localized description of the product option. example: en_US: Option Description @@ -2776,7 +2796,8 @@ components: $ref: '#/components/schemas/ProductId' searchable: type: object - additionalProperties: false + additionalProperties: + type: boolean description: A flag indicating whether the variant is searchable. example: Site1: true @@ -2787,7 +2808,8 @@ components: description: Variation attributes. variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: The actual variation attribute ID - value pairs. example: color: black @@ -2814,7 +2836,8 @@ components: example: apple-ipod-classic-black variationValues: type: object - additionalProperties: false + additionalProperties: + type: string description: The actual variation attribute ID - value pairs. example: color: red @@ -2911,6 +2934,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 @@ -2948,6 +2972,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -2976,6 +3001,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: @@ -3009,6 +3035,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -3085,6 +3112,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. @@ -3098,16 +3126,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 @@ -3150,6 +3192,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: @@ -3173,6 +3216,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 @@ -3221,6 +3265,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. @@ -3254,7 +3299,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 @@ -3280,6 +3333,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -3306,6 +3360,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -3350,6 +3405,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false Total: default: 0 minimum: 0 @@ -3435,6 +3491,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false VariantSearchResult: required: - limit @@ -3664,6 +3721,7 @@ components: - description searchPhrase: campaign offset: 2 + additionalProperties: false ProductSearchResult: required: - limit diff --git a/apis/products-oas/shopper-products-oas-1.0.36/.metadata.json b/apis/products-oas/shopper-products-oas-1.0.37/.metadata.json similarity index 90% rename from apis/products-oas/shopper-products-oas-1.0.36/.metadata.json rename to apis/products-oas/shopper-products-oas-1.0.37/.metadata.json index 365c94c3..38f266f3 100644 --- a/apis/products-oas/shopper-products-oas-1.0.36/.metadata.json +++ b/apis/products-oas/shopper-products-oas-1.0.37/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-products-oas/1.0.36", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-products-oas/1.0.37", "name": "Shopper Products OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-products-oas", - "version": "1.0.36", + "version": "1.0.37", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/products-oas/shopper-products-oas-1.0.36/exchange.json b/apis/products-oas/shopper-products-oas-1.0.37/exchange.json similarity index 93% rename from apis/products-oas/shopper-products-oas-1.0.36/exchange.json rename to apis/products-oas/shopper-products-oas-1.0.37/exchange.json index 56c22502..d9b6d1a7 100644 --- a/apis/products-oas/shopper-products-oas-1.0.36/exchange.json +++ b/apis/products-oas/shopper-products-oas-1.0.37/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Products OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-products-oas", - "version": "1.0.36", + "version": "1.0.37", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/products-oas/shopper-products-oas-1.0.36/shopper-products-oas-v1-internal.yaml b/apis/products-oas/shopper-products-oas-1.0.37/shopper-products-oas-v1-internal.yaml similarity index 100% rename from apis/products-oas/shopper-products-oas-1.0.36/shopper-products-oas-v1-internal.yaml rename to apis/products-oas/shopper-products-oas-1.0.37/shopper-products-oas-v1-internal.yaml diff --git a/apis/products-oas/shopper-products-oas-1.0.36/shopper-products-oas-v1-public.yaml b/apis/products-oas/shopper-products-oas-1.0.37/shopper-products-oas-v1-public.yaml similarity index 100% rename from apis/products-oas/shopper-products-oas-1.0.36/shopper-products-oas-v1-public.yaml rename to apis/products-oas/shopper-products-oas-1.0.37/shopper-products-oas-v1-public.yaml diff --git a/apis/promotions-oas/promotions-oas-1.0.32/.metadata.json b/apis/promotions-oas/promotions-oas-1.0.33/.metadata.json similarity index 91% rename from apis/promotions-oas/promotions-oas-1.0.32/.metadata.json rename to apis/promotions-oas/promotions-oas-1.0.33/.metadata.json index 3cb07922..ccdc44bd 100644 --- a/apis/promotions-oas/promotions-oas-1.0.32/.metadata.json +++ b/apis/promotions-oas/promotions-oas-1.0.33/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/promotions-oas/1.0.32", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/promotions-oas/1.0.33", "name": "Promotions OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "promotions-oas", - "version": "1.0.32", + "version": "1.0.33", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/promotions-oas/promotions-oas-1.0.32/exchange.json b/apis/promotions-oas/promotions-oas-1.0.33/exchange.json similarity index 93% rename from apis/promotions-oas/promotions-oas-1.0.32/exchange.json rename to apis/promotions-oas/promotions-oas-1.0.33/exchange.json index f8ae40c3..69b6f757 100644 --- a/apis/promotions-oas/promotions-oas-1.0.32/exchange.json +++ b/apis/promotions-oas/promotions-oas-1.0.33/exchange.json @@ -3,7 +3,7 @@ "name": "Promotions OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "promotions-oas", - "version": "1.0.32", + "version": "1.0.33", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/promotions-oas/promotions-oas-1.0.32/promotions-oas-v1-internal.yaml b/apis/promotions-oas/promotions-oas-1.0.33/promotions-oas-v1-internal.yaml similarity index 98% rename from apis/promotions-oas/promotions-oas-1.0.32/promotions-oas-v1-internal.yaml rename to apis/promotions-oas/promotions-oas-1.0.33/promotions-oas-v1-internal.yaml index 40117459..50d5b7ff 100644 --- a/apis/promotions-oas/promotions-oas-1.0.32/promotions-oas-v1-internal.yaml +++ b/apis/promotions-oas/promotions-oas-1.0.33/promotions-oas-v1-internal.yaml @@ -313,6 +313,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 @@ -350,6 +351,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -378,6 +380,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: @@ -411,6 +414,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -487,6 +491,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. @@ -500,16 +505,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 @@ -552,6 +571,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: @@ -575,6 +595,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 @@ -623,6 +644,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. @@ -656,7 +678,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 @@ -682,6 +712,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -708,6 +739,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -821,6 +853,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false TimeOfDay: type: object required: diff --git a/apis/promotions-oas/promotions-oas-1.0.32/promotions-oas-v1-public.yaml b/apis/promotions-oas/promotions-oas-1.0.33/promotions-oas-v1-public.yaml similarity index 98% rename from apis/promotions-oas/promotions-oas-1.0.32/promotions-oas-v1-public.yaml rename to apis/promotions-oas/promotions-oas-1.0.33/promotions-oas-v1-public.yaml index 40117459..50d5b7ff 100644 --- a/apis/promotions-oas/promotions-oas-1.0.32/promotions-oas-v1-public.yaml +++ b/apis/promotions-oas/promotions-oas-1.0.33/promotions-oas-v1-public.yaml @@ -313,6 +313,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 @@ -350,6 +351,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -378,6 +380,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: @@ -411,6 +414,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -487,6 +491,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. @@ -500,16 +505,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 @@ -552,6 +571,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: @@ -575,6 +595,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 @@ -623,6 +644,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. @@ -656,7 +678,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 @@ -682,6 +712,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -708,6 +739,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -821,6 +853,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false TimeOfDay: type: object required: diff --git a/apis/promotions-oas/shopper-promotions-oas-1.0.35/.metadata.json b/apis/promotions-oas/shopper-promotions-oas-1.0.36/.metadata.json similarity index 90% rename from apis/promotions-oas/shopper-promotions-oas-1.0.35/.metadata.json rename to apis/promotions-oas/shopper-promotions-oas-1.0.36/.metadata.json index e7100eae..526c8bd5 100644 --- a/apis/promotions-oas/shopper-promotions-oas-1.0.35/.metadata.json +++ b/apis/promotions-oas/shopper-promotions-oas-1.0.36/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-promotions-oas/1.0.35", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-promotions-oas/1.0.36", "name": "Shopper Promotions OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-promotions-oas", - "version": "1.0.35", + "version": "1.0.36", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/promotions-oas/shopper-promotions-oas-1.0.35/exchange.json b/apis/promotions-oas/shopper-promotions-oas-1.0.36/exchange.json similarity index 93% rename from apis/promotions-oas/shopper-promotions-oas-1.0.35/exchange.json rename to apis/promotions-oas/shopper-promotions-oas-1.0.36/exchange.json index e557ddee..103c14cb 100644 --- a/apis/promotions-oas/shopper-promotions-oas-1.0.35/exchange.json +++ b/apis/promotions-oas/shopper-promotions-oas-1.0.36/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Promotions OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-promotions-oas", - "version": "1.0.35", + "version": "1.0.36", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/promotions-oas/shopper-promotions-oas-1.0.35/shopper-promotions-oas-v1-internal.yaml b/apis/promotions-oas/shopper-promotions-oas-1.0.36/shopper-promotions-oas-v1-internal.yaml similarity index 99% rename from apis/promotions-oas/shopper-promotions-oas-1.0.35/shopper-promotions-oas-v1-internal.yaml rename to apis/promotions-oas/shopper-promotions-oas-1.0.36/shopper-promotions-oas-v1-internal.yaml index 79fbe1ac..0817962d 100644 --- a/apis/promotions-oas/shopper-promotions-oas-1.0.35/shopper-promotions-oas-v1-internal.yaml +++ b/apis/promotions-oas/shopper-promotions-oas-1.0.36/shopper-promotions-oas-v1-internal.yaml @@ -276,6 +276,7 @@ components: id: $5_off_ties_promotion name: 5 Off Ties Promotion total: 2 + additionalProperties: false ErrorResponse: type: object additionalProperties: true diff --git a/apis/promotions-oas/shopper-promotions-oas-1.0.35/shopper-promotions-oas-v1-public.yaml b/apis/promotions-oas/shopper-promotions-oas-1.0.36/shopper-promotions-oas-v1-public.yaml similarity index 99% rename from apis/promotions-oas/shopper-promotions-oas-1.0.35/shopper-promotions-oas-v1-public.yaml rename to apis/promotions-oas/shopper-promotions-oas-1.0.36/shopper-promotions-oas-v1-public.yaml index 79fbe1ac..0817962d 100644 --- a/apis/promotions-oas/shopper-promotions-oas-1.0.35/shopper-promotions-oas-v1-public.yaml +++ b/apis/promotions-oas/shopper-promotions-oas-1.0.36/shopper-promotions-oas-v1-public.yaml @@ -276,6 +276,7 @@ components: id: $5_off_ties_promotion name: 5 Off Ties Promotion total: 2 + additionalProperties: false ErrorResponse: type: object additionalProperties: true diff --git a/apis/search-oas/shopper-search-oas-1.1.1/.metadata.json b/apis/search-oas/shopper-search-oas-1.2.3/.metadata.json similarity index 91% rename from apis/search-oas/shopper-search-oas-1.1.1/.metadata.json rename to apis/search-oas/shopper-search-oas-1.2.3/.metadata.json index 69a6a3b7..028f2b9a 100644 --- a/apis/search-oas/shopper-search-oas-1.1.1/.metadata.json +++ b/apis/search-oas/shopper-search-oas-1.2.3/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-search-oas/1.1.1", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-search-oas/1.2.3", "name": "Shopper Search OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-search-oas", - "version": "1.1.1", + "version": "1.2.3", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/search-oas/shopper-search-oas-1.1.1/exchange.json b/apis/search-oas/shopper-search-oas-1.2.3/exchange.json similarity index 93% rename from apis/search-oas/shopper-search-oas-1.1.1/exchange.json rename to apis/search-oas/shopper-search-oas-1.2.3/exchange.json index 6935ddb6..1b715e14 100644 --- a/apis/search-oas/shopper-search-oas-1.1.1/exchange.json +++ b/apis/search-oas/shopper-search-oas-1.2.3/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Search OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-search-oas", - "version": "1.1.1", + "version": "1.2.3", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/search-oas/shopper-search-oas-1.1.1/shopper-search-oas-v1-internal.yaml b/apis/search-oas/shopper-search-oas-1.2.3/shopper-search-oas-v1-internal.yaml similarity index 94% rename from apis/search-oas/shopper-search-oas-1.1.1/shopper-search-oas-v1-internal.yaml rename to apis/search-oas/shopper-search-oas-1.2.3/shopper-search-oas-v1-internal.yaml index e1d8b7b6..21a30812 100644 --- a/apis/search-oas/shopper-search-oas-1.1.1/shopper-search-oas-v1-internal.yaml +++ b/apis/search-oas/shopper-search-oas-1.2.3/shopper-search-oas-v1-internal.yaml @@ -23,10 +23,11 @@ paths: - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/currency' - $ref: '#/components/parameters/locale' - - $ref: '#/components/parameters/expand' + - $ref: '#/components/parameters/expandProductSearch' - $ref: '#/components/parameters/allImages' - $ref: '#/components/parameters/perPricebook' - $ref: '#/components/parameters/allVariationProperties' + - $ref: '#/components/parameters/includedCustomVariationProperties' - name: limit in: query required: false @@ -76,9 +77,11 @@ paths: - $ref: '#/components/parameters/organizationId' - $ref: '#/components/parameters/siteId' - $ref: '#/components/parameters/qSearchSuggestion' - - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/limitSearchSuggestion' - $ref: '#/components/parameters/currency' - $ref: '#/components/parameters/locale' + - $ref: '#/components/parameters/expandSearchSuggestion' + - $ref: '#/components/parameters/includedCustomProductProperties' responses: '200': description: Search suggestions successfully returned. @@ -1088,7 +1091,7 @@ components: refine: name: refine in: query - description: "Parameter that represents a refinement attribute or values pair. Refinement attribute ID and \nvalues are separated by '='. Multiple values are supported by a subset of refinement attributes and \ncan be provided by separating them using a pipe (URL \nencoded = \\\"|\\\") i.e. refine=c_refinementColor=red|green|blue. Value ranges can be specified like this: refine=price=(100..500) . \nMultiple refine parameters can be provided by using the refine as the key i.e refine=price=(0..10)&refine=c_refinementColor=green. \nThe refinements can be a collection of custom defined attributes IDs and the system defined attributes IDs but the search can \nonly accept a total of 9 refinements at a time. \nThe following system refinement attribute ids are supported:\ncgid: Allows refinement per single category ID. Multiple category ids are not supported. \nprice: Allows refinement per single price range. Multiple price ranges are not supported. \npmid: Allows refinement per promotion ID. \nhtype: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.\norderable_only: Unavailable products are excluded from the search results if true is set. Multiple refinement values are not supported.\nilids: Allows refinement per inventory list IDs. Important Note:This API parameter is not GA and is currently a pilot/beta service as defined by the customer's main services agreement and provided as-is. If you are not part of the pilot/beta program, the API will throw an exception. Contact your customer success representative for more information.\n\n**Note:** To refine a search using multiple promotion filters—for example, to find products in both the spring and summer campaigns—see [Refining by Multiple Promotions](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-promotions-for-developers.html#refining-by-multiple-promotions)." + description: "Parameter that represents a refinement attribute or values pair. Refinement attribute ID and values are separated by '='. Multiple values are supported by a subset of refinement attributes and can be provided by separating them using a pipe (URL encoded = \\\"|\\\") i.e. refine=c_refinementColor=red|green|blue. Value ranges can be specified like this: refine=price=(100..500) . \nMultiple refine parameters can be provided by using the refine as the key i.e refine=price=(0..10)&refine=c_refinementColor=green. The refinements can be a collection of custom defined attributes IDs \nand the system defined attributes IDs but the search can only accept a total of 9 refinements at a time. \n\nThe following system refinement attribute ids are supported:
\n`cgid`: Allows refinement per single category ID. Multiple category ids are not supported. \n`price`: Allows refinement per single price range. Multiple price ranges are not supported. \n`pmid`: Allows refinement per promotion ID. \n`htype`: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
\n`orderable_only`: Unavailable products are excluded from the search results if true is set. Multiple refinement values are not supported.
\n`ilids`: Allows refinement per inventory list IDs.
\n\n**Note:** To refine a search using multiple promotion filters—for example, to find products in both the spring and summer campaigns—see [Refining by Multiple Promotions](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-promotions-for-developers.html#refining-by-multiple-promotions)." required: false style: form explode: true @@ -1125,7 +1128,7 @@ components: value: US schema: $ref: '#/components/schemas/LocaleCode' - expand: + expandProductSearch: name: expand in: query description: "A comma-separated list with allowed values - `availability`, `images`, `prices`, `represented_products`, `variations`, `promotions`, `custom_properties`. \nBy default, the expand parameter includes `availability, images, prices, represented_products, variations`. \nUse none to disable all expand options. \n**The page_meta_tags expand value is optional and is available B2C Commerce version 25.2.**\"" @@ -1169,6 +1172,20 @@ components: schema: type: boolean example: false + includedCustomVariationProperties: + name: includedCustomVariationProperties + in: query + description: A comma-separated list of custom property ids to be returned for variant products. The `variants` expand parameter and `allVariationProperties` query parameter are required for these properties to be returned. + required: false + schema: + items: + type: string + example: c_batteryLife + pattern: ^c_.* + allOf: + - $ref: '#/components/schemas/String256' + type: array + maxItems: 5 qSearchSuggestion: name: q in: query @@ -1179,15 +1196,45 @@ components: minLength: 3 type: string example: sho - limit: - description: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria). + limitSearchSuggestion: name: limit in: query - examples: - limit: - value: 25 + description: The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions). + required: false + schema: + type: integer + maximum: 10 + default: 5 + minimum: 1 + example: 5 + expandSearchSuggestion: + name: expand + in: query + description: "A comma-separated list that allows values `images`, `prices`, `custom_product_properties`. \nBy default, the expand parameter includes `prices`." + required: false schema: - $ref: '#/components/schemas/Limit' + items: + type: string + example: prices + enum: + - images + - prices + - custom_product_properties + type: array + includedCustomProductProperties: + name: includedCustomProductProperties + in: query + description: A comma-separated list of custom property ids to be returned for product suggestions. The `custom_product_properties` expand parameter is required for these properties to be returned. + required: false + schema: + items: + type: string + example: c_batteryLife + pattern: ^c_.* + allOf: + - $ref: '#/components/schemas/String256' + type: array + maxItems: 5 examples: ProductSearchResultExample: value: diff --git a/apis/search-oas/shopper-search-oas-1.1.1/shopper-search-oas-v1-public.yaml b/apis/search-oas/shopper-search-oas-1.2.3/shopper-search-oas-v1-public.yaml similarity index 94% rename from apis/search-oas/shopper-search-oas-1.1.1/shopper-search-oas-v1-public.yaml rename to apis/search-oas/shopper-search-oas-1.2.3/shopper-search-oas-v1-public.yaml index e1d8b7b6..21a30812 100644 --- a/apis/search-oas/shopper-search-oas-1.1.1/shopper-search-oas-v1-public.yaml +++ b/apis/search-oas/shopper-search-oas-1.2.3/shopper-search-oas-v1-public.yaml @@ -23,10 +23,11 @@ paths: - $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/currency' - $ref: '#/components/parameters/locale' - - $ref: '#/components/parameters/expand' + - $ref: '#/components/parameters/expandProductSearch' - $ref: '#/components/parameters/allImages' - $ref: '#/components/parameters/perPricebook' - $ref: '#/components/parameters/allVariationProperties' + - $ref: '#/components/parameters/includedCustomVariationProperties' - name: limit in: query required: false @@ -76,9 +77,11 @@ paths: - $ref: '#/components/parameters/organizationId' - $ref: '#/components/parameters/siteId' - $ref: '#/components/parameters/qSearchSuggestion' - - $ref: '#/components/parameters/limit' + - $ref: '#/components/parameters/limitSearchSuggestion' - $ref: '#/components/parameters/currency' - $ref: '#/components/parameters/locale' + - $ref: '#/components/parameters/expandSearchSuggestion' + - $ref: '#/components/parameters/includedCustomProductProperties' responses: '200': description: Search suggestions successfully returned. @@ -1088,7 +1091,7 @@ components: refine: name: refine in: query - description: "Parameter that represents a refinement attribute or values pair. Refinement attribute ID and \nvalues are separated by '='. Multiple values are supported by a subset of refinement attributes and \ncan be provided by separating them using a pipe (URL \nencoded = \\\"|\\\") i.e. refine=c_refinementColor=red|green|blue. Value ranges can be specified like this: refine=price=(100..500) . \nMultiple refine parameters can be provided by using the refine as the key i.e refine=price=(0..10)&refine=c_refinementColor=green. \nThe refinements can be a collection of custom defined attributes IDs and the system defined attributes IDs but the search can \nonly accept a total of 9 refinements at a time. \nThe following system refinement attribute ids are supported:\ncgid: Allows refinement per single category ID. Multiple category ids are not supported. \nprice: Allows refinement per single price range. Multiple price ranges are not supported. \npmid: Allows refinement per promotion ID. \nhtype: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.\norderable_only: Unavailable products are excluded from the search results if true is set. Multiple refinement values are not supported.\nilids: Allows refinement per inventory list IDs. Important Note:This API parameter is not GA and is currently a pilot/beta service as defined by the customer's main services agreement and provided as-is. If you are not part of the pilot/beta program, the API will throw an exception. Contact your customer success representative for more information.\n\n**Note:** To refine a search using multiple promotion filters—for example, to find products in both the spring and summer campaigns—see [Refining by Multiple Promotions](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-promotions-for-developers.html#refining-by-multiple-promotions)." + description: "Parameter that represents a refinement attribute or values pair. Refinement attribute ID and values are separated by '='. Multiple values are supported by a subset of refinement attributes and can be provided by separating them using a pipe (URL encoded = \\\"|\\\") i.e. refine=c_refinementColor=red|green|blue. Value ranges can be specified like this: refine=price=(100..500) . \nMultiple refine parameters can be provided by using the refine as the key i.e refine=price=(0..10)&refine=c_refinementColor=green. The refinements can be a collection of custom defined attributes IDs \nand the system defined attributes IDs but the search can only accept a total of 9 refinements at a time. \n\nThe following system refinement attribute ids are supported:
\n`cgid`: Allows refinement per single category ID. Multiple category ids are not supported. \n`price`: Allows refinement per single price range. Multiple price ranges are not supported. \n`pmid`: Allows refinement per promotion ID. \n`htype`: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
\n`orderable_only`: Unavailable products are excluded from the search results if true is set. Multiple refinement values are not supported.
\n`ilids`: Allows refinement per inventory list IDs.
\n\n**Note:** To refine a search using multiple promotion filters—for example, to find products in both the spring and summer campaigns—see [Refining by Multiple Promotions](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-promotions-for-developers.html#refining-by-multiple-promotions)." required: false style: form explode: true @@ -1125,7 +1128,7 @@ components: value: US schema: $ref: '#/components/schemas/LocaleCode' - expand: + expandProductSearch: name: expand in: query description: "A comma-separated list with allowed values - `availability`, `images`, `prices`, `represented_products`, `variations`, `promotions`, `custom_properties`. \nBy default, the expand parameter includes `availability, images, prices, represented_products, variations`. \nUse none to disable all expand options. \n**The page_meta_tags expand value is optional and is available B2C Commerce version 25.2.**\"" @@ -1169,6 +1172,20 @@ components: schema: type: boolean example: false + includedCustomVariationProperties: + name: includedCustomVariationProperties + in: query + description: A comma-separated list of custom property ids to be returned for variant products. The `variants` expand parameter and `allVariationProperties` query parameter are required for these properties to be returned. + required: false + schema: + items: + type: string + example: c_batteryLife + pattern: ^c_.* + allOf: + - $ref: '#/components/schemas/String256' + type: array + maxItems: 5 qSearchSuggestion: name: q in: query @@ -1179,15 +1196,45 @@ components: minLength: 3 type: string example: sho - limit: - description: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria). + limitSearchSuggestion: name: limit in: query - examples: - limit: - value: 25 + description: The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions). + required: false + schema: + type: integer + maximum: 10 + default: 5 + minimum: 1 + example: 5 + expandSearchSuggestion: + name: expand + in: query + description: "A comma-separated list that allows values `images`, `prices`, `custom_product_properties`. \nBy default, the expand parameter includes `prices`." + required: false schema: - $ref: '#/components/schemas/Limit' + items: + type: string + example: prices + enum: + - images + - prices + - custom_product_properties + type: array + includedCustomProductProperties: + name: includedCustomProductProperties + in: query + description: A comma-separated list of custom property ids to be returned for product suggestions. The `custom_product_properties` expand parameter is required for these properties to be returned. + required: false + schema: + items: + type: string + example: c_batteryLife + pattern: ^c_.* + allOf: + - $ref: '#/components/schemas/String256' + type: array + maxItems: 5 examples: ProductSearchResultExample: value: diff --git a/apis/seo-oas/seo-oas-1.0.5/.metadata.json b/apis/seo-oas/seo-oas-1.0.7/.metadata.json similarity index 73% rename from apis/seo-oas/seo-oas-1.0.5/.metadata.json rename to apis/seo-oas/seo-oas-1.0.7/.metadata.json index 3d9950fa..aec57aca 100644 --- a/apis/seo-oas/seo-oas-1.0.5/.metadata.json +++ b/apis/seo-oas/seo-oas-1.0.7/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/seo-oas/1.0.5", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/seo-oas/1.0.7", "name": "Seo OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "seo-oas", - "version": "1.0.5", + "version": "1.0.7", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/seo-oas/seo-oas-1.0.5/exchange.json b/apis/seo-oas/seo-oas-1.0.7/exchange.json similarity index 92% rename from apis/seo-oas/seo-oas-1.0.5/exchange.json rename to apis/seo-oas/seo-oas-1.0.7/exchange.json index bf699c24..0e60ebe9 100644 --- a/apis/seo-oas/seo-oas-1.0.5/exchange.json +++ b/apis/seo-oas/seo-oas-1.0.7/exchange.json @@ -3,7 +3,7 @@ "name": "Seo OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "seo-oas", - "version": "1.0.5", + "version": "1.0.7", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/seo-oas/seo-oas-1.0.5/seo-oas-v1-internal.yaml b/apis/seo-oas/seo-oas-1.0.7/seo-oas-v1-internal.yaml similarity index 100% rename from apis/seo-oas/seo-oas-1.0.5/seo-oas-v1-internal.yaml rename to apis/seo-oas/seo-oas-1.0.7/seo-oas-v1-internal.yaml diff --git a/apis/seo-oas/seo-oas-1.0.5/seo-oas-v1-public.yaml b/apis/seo-oas/seo-oas-1.0.7/seo-oas-v1-public.yaml similarity index 100% rename from apis/seo-oas/seo-oas-1.0.5/seo-oas-v1-public.yaml rename to apis/seo-oas/seo-oas-1.0.7/seo-oas-v1-public.yaml diff --git a/apis/seo-oas/shopper-seo-oas-1.0.11/.metadata.json b/apis/seo-oas/shopper-seo-oas-1.0.13/.metadata.json similarity index 91% rename from apis/seo-oas/shopper-seo-oas-1.0.11/.metadata.json rename to apis/seo-oas/shopper-seo-oas-1.0.13/.metadata.json index 5fb91883..871cb6fb 100644 --- a/apis/seo-oas/shopper-seo-oas-1.0.11/.metadata.json +++ b/apis/seo-oas/shopper-seo-oas-1.0.13/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-seo-oas/1.0.11", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-seo-oas/1.0.13", "name": "Shopper Seo OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-seo-oas", - "version": "1.0.11", + "version": "1.0.13", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/seo-oas/shopper-seo-oas-1.0.11/exchange.json b/apis/seo-oas/shopper-seo-oas-1.0.13/exchange.json similarity index 93% rename from apis/seo-oas/shopper-seo-oas-1.0.11/exchange.json rename to apis/seo-oas/shopper-seo-oas-1.0.13/exchange.json index 41742f59..f6d65871 100644 --- a/apis/seo-oas/shopper-seo-oas-1.0.11/exchange.json +++ b/apis/seo-oas/shopper-seo-oas-1.0.13/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Seo OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-seo-oas", - "version": "1.0.11", + "version": "1.0.13", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/seo-oas/shopper-seo-oas-1.0.11/shopper-seo-oas-v1-internal.yaml b/apis/seo-oas/shopper-seo-oas-1.0.13/shopper-seo-oas-v1-internal.yaml similarity index 100% rename from apis/seo-oas/shopper-seo-oas-1.0.11/shopper-seo-oas-v1-internal.yaml rename to apis/seo-oas/shopper-seo-oas-1.0.13/shopper-seo-oas-v1-internal.yaml diff --git a/apis/seo-oas/shopper-seo-oas-1.0.11/shopper-seo-oas-v1-public.yaml b/apis/seo-oas/shopper-seo-oas-1.0.13/shopper-seo-oas-v1-public.yaml similarity index 100% rename from apis/seo-oas/shopper-seo-oas-1.0.11/shopper-seo-oas-v1-public.yaml rename to apis/seo-oas/shopper-seo-oas-1.0.13/shopper-seo-oas-v1-public.yaml diff --git a/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/.metadata.json b/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/.metadata.json similarity index 87% rename from apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/.metadata.json rename to apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/.metadata.json index 817677b4..a6a48a88 100644 --- a/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/.metadata.json +++ b/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/.metadata.json @@ -1,9 +1,9 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-baskets-oas/1.8.23", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-baskets-oas/1.8.25", "name": "Shopper Baskets OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-baskets-oas", - "version": "1.8.23", + "version": "1.8.25", "categories": {} } diff --git a/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/exchange.json b/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/exchange.json similarity index 93% rename from apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/exchange.json rename to apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/exchange.json index 02064acc..3e10cd6a 100644 --- a/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/exchange.json +++ b/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Baskets OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-baskets-oas", - "version": "1.8.23", + "version": "1.8.25", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/shopper-baskets-oas-v1-public.yaml b/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/shopper-baskets-oas-v1-internal.yaml similarity index 100% rename from apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/shopper-baskets-oas-v1-public.yaml rename to apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/shopper-baskets-oas-v1-internal.yaml diff --git a/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/shopper-baskets-oas-v1-internal.yaml b/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/shopper-baskets-oas-v1-public.yaml similarity index 99% rename from apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/shopper-baskets-oas-v1-internal.yaml rename to apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/shopper-baskets-oas-v1-public.yaml index f179b4cb..8bb23f27 100644 --- a/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.23/shopper-baskets-oas-v1-internal.yaml +++ b/apis/shopper-baskets-oas/shopper-baskets-oas-1.8.25/shopper-baskets-oas-v1-public.yaml @@ -6588,4 +6588,3 @@ components: rate: 0.01 - id: US_5 rate: 0.05 -x-sdk-classname: ShopperBasketsV1 diff --git a/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/.metadata.json b/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/.metadata.json similarity index 90% rename from apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/.metadata.json rename to apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/.metadata.json index 69d4eb32..d1026de3 100644 --- a/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/.metadata.json +++ b/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-baskets-oas/2.0.14", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-baskets-oas/2.0.16", "name": "Shopper Baskets OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-baskets-oas", - "version": "2.0.14", + "version": "2.0.16", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/exchange.json b/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/exchange.json similarity index 93% rename from apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/exchange.json rename to apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/exchange.json index 62f5dcca..1e1b79d4 100644 --- a/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/exchange.json +++ b/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Baskets OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-baskets-oas", - "version": "2.0.14", + "version": "2.0.16", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/shopper-baskets-oas-v2-internal.yaml b/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/shopper-baskets-oas-v2-internal.yaml similarity index 100% rename from apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/shopper-baskets-oas-v2-internal.yaml rename to apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/shopper-baskets-oas-v2-internal.yaml diff --git a/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/shopper-baskets-oas-v2-public.yaml b/apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/shopper-baskets-oas-v2-public.yaml similarity index 100% rename from apis/shopper-baskets-oas/shopper-baskets-oas-2.0.14/shopper-baskets-oas-v2-public.yaml rename to apis/shopper-baskets-oas/shopper-baskets-oas-2.0.16/shopper-baskets-oas-v2-public.yaml diff --git a/apis/shopper-context-oas/shopper-context-oas-1.0.33/.metadata.json b/apis/shopper-context-oas/shopper-context-oas-1.0.35/.metadata.json similarity index 90% rename from apis/shopper-context-oas/shopper-context-oas-1.0.33/.metadata.json rename to apis/shopper-context-oas/shopper-context-oas-1.0.35/.metadata.json index 457a343e..6eeba61c 100644 --- a/apis/shopper-context-oas/shopper-context-oas-1.0.33/.metadata.json +++ b/apis/shopper-context-oas/shopper-context-oas-1.0.35/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-context-oas/1.0.33", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-context-oas/1.0.35", "name": "Shopper Context OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-context-oas", - "version": "1.0.33", + "version": "1.0.35", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/shopper-context-oas/shopper-context-oas-1.0.33/exchange.json b/apis/shopper-context-oas/shopper-context-oas-1.0.35/exchange.json similarity index 93% rename from apis/shopper-context-oas/shopper-context-oas-1.0.33/exchange.json rename to apis/shopper-context-oas/shopper-context-oas-1.0.35/exchange.json index 13b0f12e..3406824e 100644 --- a/apis/shopper-context-oas/shopper-context-oas-1.0.33/exchange.json +++ b/apis/shopper-context-oas/shopper-context-oas-1.0.35/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Context OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-context-oas", - "version": "1.0.33", + "version": "1.0.35", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/shopper-context-oas/shopper-context-oas-1.0.33/shopper-context-oas-v1-internal.yaml b/apis/shopper-context-oas/shopper-context-oas-1.0.35/shopper-context-oas-v1-internal.yaml similarity index 89% rename from apis/shopper-context-oas/shopper-context-oas-1.0.33/shopper-context-oas-v1-internal.yaml rename to apis/shopper-context-oas/shopper-context-oas-1.0.35/shopper-context-oas-v1-internal.yaml index 3cf008e6..9f2713b5 100644 --- a/apis/shopper-context-oas/shopper-context-oas-1.0.33/shopper-context-oas-v1-internal.yaml +++ b/apis/shopper-context-oas/shopper-context-oas-1.0.35/shopper-context-oas-v1-internal.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Shopper Context version: v1 - description: "# API Overview\n\nWith the Shopper Context API, you can set any context information as a key/value pair and use it to retrieve personalized promotions, payment methods, and shipping methods. The context information that is set is evaluated against the customer group definitions to determine a customer group (shopper segment), and is then used to activate the experiences that are associated with a particular segment, such as promotions.\n\nYou can also get personalized API responses triggered by shopper context from the [Open Commerce API](https://documentation.b2c.commercecloud.salesforce.com/DOC1/topic/com.demandware.dochelp/OCAPI/current/usage/OpenCommerceAPI.html) (OCAPI). Support for both the B2C Commerce API and OCAPI allows shopper context to be used in hybrid deployments.\n\n**Warning** \nAccess tokens with a scope that includes the Shopper Context API are powerful. They can activate specific promotions and can be used to see how a storefront would be displayed in the future. Don't share them with untrusted clients like web browsers or client apps.\n\nMake Shopper Context calls with a private client and only set shopper context through a secure backend channel. To avoid misuse, do not make direct calls through a browser or similar client in which data can be viewed. \n\nAs part of this, when creating a SLAS public client for a tenant, if you attempt to add the Shopper Context API scope, a warning message is displayed to ensure you are aware of the pitfalls of doing so.\n\n**Note**:\n\nShopper context is valid for 1 day for guest shoppers and 7 days for registered shoppers. To extend the context set, create a new context. As a best practice, refresh your contexts periodically to ensure that the right personalized experience is rendered for your shoppers.\n\nWith B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` is required for all customers, and a bad request response code is returned for requests without a `siteId`.\n\n## Authentication & Authorization\n\nThe Shopper Context API requires a shopper access token from the Shopper Login and API Access Service (SLAS).\n\nFor details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html) in the SLAS guides. \n\nAdd `sfcc.shopper-context.rw` to the scopes configuration for the SLAS API client.\n\nFor more information, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides.\n\n**Warning**: As with all APIs, never store access tokens in the browser because this creates a security vulnerability.\n\n## Use Cases\n\nFor detailed usage information, see the [Shopper Context guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/shopper-context-api.html)." + description: "# API Overview\n\nWith the Shopper Context API, you can set any context information as a key/value pair and use it to retrieve personalized promotions, payment methods, and shipping methods. The context information that is set is evaluated against the customer group definitions to determine a customer group (shopper segment), and is then used to activate the experiences that are associated with a particular segment, such as promotions.\n\nYou can also get personalized API responses triggered by shopper context from the [Open Commerce API](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-commerce-ocapi/get-started-with-ocapi.html) (OCAPI). Support for both the B2C Commerce API and OCAPI allows shopper context to be used in hybrid deployments.\n\n**Warning** \nAccess tokens with a scope that includes the Shopper Context API are powerful. They can activate specific promotions and can be used to see how a storefront would be displayed in the future. Don't share them with untrusted clients like web browsers or client apps.\n\nMake Shopper Context calls with a private client and only set shopper context through a secure backend channel. To avoid misuse, do not make direct calls through a browser or similar client in which data can be viewed. \n\nAs part of this, when creating a SLAS public client for a tenant, if you attempt to add the Shopper Context API scope, a warning message is displayed to ensure you are aware of the pitfalls of doing so.\n\n**Note**:\n\nShopper context is valid for 1 day for guest shoppers and 7 days for registered shoppers. To extend the context set, create a new context. As a best practice, refresh your contexts periodically to ensure that the right personalized experience is rendered for your shoppers.\n\nWith B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` is required for all customers, and a bad request response code is returned for requests without a `siteId`.\n\n## Authentication & Authorization\n\nThe Shopper Context API requires a shopper access token from the Shopper Login and API Access Service (SLAS).\n\nFor details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html) in the SLAS guides. \n\nAdd `sfcc.shopper-context.rw` to the scopes configuration for the SLAS API client.\n\nFor more information, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides.\n\n**Warning**: As with all APIs, never store access tokens in the browser because this creates a security vulnerability.\n\n## Use Cases\n\nFor detailed usage information, see the [Shopper Context guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/shopper-context-api.html)." servers: - url: https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/v1 variables: @@ -349,7 +349,9 @@ components: description: Qualifier to set the Customer Group Ids for the context to apply. Set the Customer Group Ids to evaluate customer groups that trigger the promotions (campaign assignment) assigned to the customer groups. customQualifiers: type: object - additionalProperties: false + additionalProperties: + type: string + nullable: true description: Map of custom qualifiers for the shopper context. Set this object to trigger pricing and promotion experiences using a dynamic session-based customer group. Object size is limited to 20 key-value pairs (properties). example: deviceType: mobile @@ -359,7 +361,11 @@ components: type: object example: store: boston - additionalProperties: false + additionalProperties: + type: string + nullable: true + example: + store: boston description: Map of assignment qualifiers for the shopper context. Set this object when using the assignment framework to activate experiences based on assignment qualifiers. Currently, only pricing and promotion experiences are supported. Object size is limited to 20 key-value pairs (properties). clientIp: type: string @@ -420,6 +426,7 @@ components: - BigSpenders - MobileUsers clientIp: 12.12.12.1 + additionalProperties: false ErrorResponse: type: object additionalProperties: true diff --git a/apis/shopper-context-oas/shopper-context-oas-1.0.33/shopper-context-oas-v1-public.yaml b/apis/shopper-context-oas/shopper-context-oas-1.0.35/shopper-context-oas-v1-public.yaml similarity index 89% rename from apis/shopper-context-oas/shopper-context-oas-1.0.33/shopper-context-oas-v1-public.yaml rename to apis/shopper-context-oas/shopper-context-oas-1.0.35/shopper-context-oas-v1-public.yaml index 7ac29a33..250375de 100644 --- a/apis/shopper-context-oas/shopper-context-oas-1.0.33/shopper-context-oas-v1-public.yaml +++ b/apis/shopper-context-oas/shopper-context-oas-1.0.35/shopper-context-oas-v1-public.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Shopper Context version: v1 - description: "# API Overview\n\nWith the Shopper Context API, you can set any context information as a key/value pair and use it to retrieve personalized promotions, payment methods, and shipping methods. The context information that is set is evaluated against the customer group definitions to determine a customer group (shopper segment), and is then used to activate the experiences that are associated with a particular segment, such as promotions.\n\nYou can also get personalized API responses triggered by shopper context from the [Open Commerce API](https://documentation.b2c.commercecloud.salesforce.com/DOC1/topic/com.demandware.dochelp/OCAPI/current/usage/OpenCommerceAPI.html) (OCAPI). Support for both the B2C Commerce API and OCAPI allows shopper context to be used in hybrid deployments.\n\n**Warning** \nAccess tokens with a scope that includes the Shopper Context API are powerful. They can activate specific promotions and can be used to see how a storefront would be displayed in the future. Don't share them with untrusted clients like web browsers or client apps.\n\nMake Shopper Context calls with a private client and only set shopper context through a secure backend channel. To avoid misuse, do not make direct calls through a browser or similar client in which data can be viewed. \n\nAs part of this, when creating a SLAS public client for a tenant, if you attempt to add the Shopper Context API scope, a warning message is displayed to ensure you are aware of the pitfalls of doing so.\n\n**Note**:\n\nShopper context is valid for 1 day for guest shoppers and 7 days for registered shoppers. To extend the context set, create a new context. As a best practice, refresh your contexts periodically to ensure that the right personalized experience is rendered for your shoppers.\n\nWith B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` is required for all customers, and a bad request response code is returned for requests without a `siteId`.\n\n## Authentication & Authorization\n\nThe Shopper Context API requires a shopper access token from the Shopper Login and API Access Service (SLAS).\n\nFor details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html) in the SLAS guides. \n\nAdd `sfcc.shopper-context.rw` to the scopes configuration for the SLAS API client.\n\nFor more information, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides.\n\n**Warning**: As with all APIs, never store access tokens in the browser because this creates a security vulnerability.\n\n## Use Cases\n\nFor detailed usage information, see the [Shopper Context guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/shopper-context-api.html)." + description: "# API Overview\n\nWith the Shopper Context API, you can set any context information as a key/value pair and use it to retrieve personalized promotions, payment methods, and shipping methods. The context information that is set is evaluated against the customer group definitions to determine a customer group (shopper segment), and is then used to activate the experiences that are associated with a particular segment, such as promotions.\n\nYou can also get personalized API responses triggered by shopper context from the [Open Commerce API](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-commerce-ocapi/get-started-with-ocapi.html) (OCAPI). Support for both the B2C Commerce API and OCAPI allows shopper context to be used in hybrid deployments.\n\n**Warning** \nAccess tokens with a scope that includes the Shopper Context API are powerful. They can activate specific promotions and can be used to see how a storefront would be displayed in the future. Don't share them with untrusted clients like web browsers or client apps.\n\nMake Shopper Context calls with a private client and only set shopper context through a secure backend channel. To avoid misuse, do not make direct calls through a browser or similar client in which data can be viewed. \n\nAs part of this, when creating a SLAS public client for a tenant, if you attempt to add the Shopper Context API scope, a warning message is displayed to ensure you are aware of the pitfalls of doing so.\n\n**Note**:\n\nShopper context is valid for 1 day for guest shoppers and 7 days for registered shoppers. To extend the context set, create a new context. As a best practice, refresh your contexts periodically to ensure that the right personalized experience is rendered for your shoppers.\n\nWith B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` is required for all customers, and a bad request response code is returned for requests without a `siteId`.\n\n## Authentication & Authorization\n\nThe Shopper Context API requires a shopper access token from the Shopper Login and API Access Service (SLAS).\n\nFor details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html) in the SLAS guides. \n\nAdd `sfcc.shopper-context.rw` to the scopes configuration for the SLAS API client.\n\nFor more information, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides.\n\n**Warning**: As with all APIs, never store access tokens in the browser because this creates a security vulnerability.\n\n## Use Cases\n\nFor detailed usage information, see the [Shopper Context guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/shopper-context-api.html)." servers: - url: https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/v1 variables: @@ -349,7 +349,9 @@ components: description: Qualifier to set the Customer Group Ids for the context to apply. Set the Customer Group Ids to evaluate customer groups that trigger the promotions (campaign assignment) assigned to the customer groups. customQualifiers: type: object - additionalProperties: false + additionalProperties: + type: string + nullable: true description: Map of custom qualifiers for the shopper context. Set this object to trigger pricing and promotion experiences using a dynamic session-based customer group. Object size is limited to 20 key-value pairs (properties). example: deviceType: mobile @@ -359,7 +361,11 @@ components: type: object example: store: boston - additionalProperties: false + additionalProperties: + type: string + nullable: true + example: + store: boston description: Map of assignment qualifiers for the shopper context. Set this object when using the assignment framework to activate experiences based on assignment qualifiers. Currently, only pricing and promotion experiences are supported. Object size is limited to 20 key-value pairs (properties). clientIp: type: string @@ -420,6 +426,7 @@ components: - BigSpenders - MobileUsers clientIp: 12.12.12.1 + additionalProperties: false ErrorResponse: type: object additionalProperties: true diff --git a/apis/shopper-experience-oas/shopper-experience-oas-1.0.5/.metadata.json b/apis/shopper-experience-oas/shopper-experience-oas-1.0.7/.metadata.json similarity index 90% rename from apis/shopper-experience-oas/shopper-experience-oas-1.0.5/.metadata.json rename to apis/shopper-experience-oas/shopper-experience-oas-1.0.7/.metadata.json index 5c20ce8d..d08f0ad4 100644 --- a/apis/shopper-experience-oas/shopper-experience-oas-1.0.5/.metadata.json +++ b/apis/shopper-experience-oas/shopper-experience-oas-1.0.7/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-experience-oas/1.0.5", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-experience-oas/1.0.7", "name": "Shopper Experience OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-experience-oas", - "version": "1.0.5", + "version": "1.0.7", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/shopper-experience-oas/shopper-experience-oas-1.0.5/exchange.json b/apis/shopper-experience-oas/shopper-experience-oas-1.0.7/exchange.json similarity index 79% rename from apis/shopper-experience-oas/shopper-experience-oas-1.0.5/exchange.json rename to apis/shopper-experience-oas/shopper-experience-oas-1.0.7/exchange.json index c38de835..ebdb8cb0 100644 --- a/apis/shopper-experience-oas/shopper-experience-oas-1.0.5/exchange.json +++ b/apis/shopper-experience-oas/shopper-experience-oas-1.0.7/exchange.json @@ -1,9 +1,9 @@ { - "main": "shopper-experience-oas-v1-bundled.yaml", + "main": "shopper-experience-oas-v1-public.yaml", "name": "Shopper Experience OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-experience-oas", - "version": "1.0.5", + "version": "1.0.7", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/shopper-experience-oas/shopper-experience-oas-1.0.5/shopper-experience-oas-v1-bundled.yaml b/apis/shopper-experience-oas/shopper-experience-oas-1.0.7/shopper-experience-oas-v1-internal.yaml similarity index 96% rename from apis/shopper-experience-oas/shopper-experience-oas-1.0.5/shopper-experience-oas-v1-bundled.yaml rename to apis/shopper-experience-oas/shopper-experience-oas-1.0.7/shopper-experience-oas-v1-internal.yaml index b91531f3..1ea0bc40 100644 --- a/apis/shopper-experience-oas/shopper-experience-oas-1.0.5/shopper-experience-oas-v1-bundled.yaml +++ b/apis/shopper-experience-oas/shopper-experience-oas-1.0.7/shopper-experience-oas-v1-internal.yaml @@ -16,6 +16,14 @@ info: Only visible pages are returned. Because the visibility of components is driven by rules (scheduling or customer groups, for example), these rules are subject to evaluation when assembling the component hierarchy in the response. Only components that are visible for the current customer context appear in the response. The same rules apply to the page itself, which is only be processed and returned if it is visible. **Important**: Currently, the Shopper Experience API can’t be used when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled. + + ## Authentication & Authorization + + The Shopper Experience API requires a shopper access token from the Shopper Login and API Access Service (SLAS). + + For details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html#guest-user) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html#guest-user) in the SLAS guides. + + You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html). servers: - url: https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/v1 variables: @@ -211,12 +219,14 @@ components: title: Topseller category: topseller type: object + additionalProperties: false custom: title: Custom Component Data description: Any custom data added by the custom code for this component. example: detailUrl: www.myshop.com/topseller type: object + additionalProperties: false regions: title: Regions description: The regions (and their assigned components) for the component. @@ -294,12 +304,14 @@ components: example: thumbnail: myshop.jpg type: object + additionalProperties: false custom: title: Custom Page Data description: Any custom data added by the custom code for the page type. example: thumbnail_full: http://static.myshop.com/myshop.jpg type: object + additionalProperties: false regions: title: Regions description: The regions (and their assigned components) for the page. diff --git a/apis/shopper-experience-oas/shopper-experience-oas-1.0.7/shopper-experience-oas-v1-public.yaml b/apis/shopper-experience-oas/shopper-experience-oas-1.0.7/shopper-experience-oas-v1-public.yaml new file mode 100644 index 00000000..1ea0bc40 --- /dev/null +++ b/apis/shopper-experience-oas/shopper-experience-oas-1.0.7/shopper-experience-oas-v1-public.yaml @@ -0,0 +1,614 @@ +openapi: 3.0.3 +info: + title: Shopper Experience + version: v1 + description: |- + Use the Shopper Experience API to look up page information for pages that are created in Page Designer. + + Responses include the following: + + - The entire component hierarchy of the page at design time. + - All merchant data provided at design time. + - Server-side scripting data provided at run time. + + Both the page and components contain the values of all native and custom attributes that have been populated during page authoring. + + Only visible pages are returned. Because the visibility of components is driven by rules (scheduling or customer groups, for example), these rules are subject to evaluation when assembling the component hierarchy in the response. Only components that are visible for the current customer context appear in the response. The same rules apply to the page itself, which is only be processed and returned if it is visible. + + **Important**: Currently, the Shopper Experience API can’t be used when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled. + + ## Authentication & Authorization + + The Shopper Experience API requires a shopper access token from the Shopper Login and API Access Service (SLAS). + + For details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html#guest-user) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html#guest-user) in the SLAS guides. + + You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html). +servers: + - url: https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/v1 + variables: + shortCode: + default: shortCode +paths: + /organizations/{organizationId}/pages: + get: + summary: Get Page Designer pages. + description: "Get Page Designer pages. The results apply the visibility rules for each page's components, such as personalization or scheduled visibility.\n\nYou must provide the `aspectTypeId` along with either a `categoryId` or a `productId`. Since you can only create one page-to-product or page-to-category assignment per aspect type, the result contains at most one element.\n\n**Important**: \n- Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.\n- Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.\n- Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching)." + operationId: getPages + parameters: + - $ref: '#/components/parameters/organizationId' + - $ref: '#/components/parameters/categoryId' + - $ref: '#/components/parameters/productId' + - $ref: '#/components/parameters/aspectTypeId' + - $ref: '#/components/parameters/aspectAttributes' + - $ref: '#/components/parameters/parameters' + - $ref: '#/components/parameters/siteId' + - $ref: '#/components/parameters/locale' + responses: + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/PageResult' + examples: + PageResult: + $ref: '#/components/examples/PageResult' + '400': + description: | + Business Object ID Invalid + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + BusinessObjectIDInvalid: + $ref: '#/components/examples/BusinessObjectIDInvalid' + '404': + description: | + Requested Aspect Type Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + AspectTypeNotFound: + $ref: '#/components/examples/AspectTypeNotFound' + security: + - ShopperToken: + - sfcc.shopper-experience + /organizations/{organizationId}/pages/{pageId}: + get: + summary: Get a Page Designer page based on a single page ID. + description: "Get a Page Designer page for a specific page ID. The results apply the visibility rules for the page's components, such as personalization or scheduled visibility.\n\n**Important**: \n- Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.\n- Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.\n- Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching)." + operationId: getPage + parameters: + - $ref: '#/components/parameters/pageId' + - $ref: '#/components/parameters/organizationId' + - $ref: '#/components/parameters/aspectAttributes' + - $ref: '#/components/parameters/parameters' + - $ref: '#/components/parameters/siteId' + - $ref: '#/components/parameters/locale' + responses: + '200': + description: Success. + content: + application/json: + schema: + $ref: '#/components/schemas/Page' + examples: + Page: + $ref: '#/components/examples/Page' + '400': + description: | + Provided Aspect Attribute Invalid + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + AspectAttributeInvalid: + $ref: '#/components/examples/AspectAttributeInvalid' + '404': + description: | + Requested Page Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + PageNotFound: + $ref: '#/components/examples/PageNotFound' + security: + - ShopperToken: + - sfcc.shopper-experience +components: + securitySchemes: + ShopperToken: + type: oauth2 + description: "ShopperToken authentication follows the authorization code grant flow, as defined by the OAuth 2.1 standard. Depending on the type of OAuth client (public or private), this authorization flow has further requirements. \nFor a detailed description of the authorization flow, see the [SLAS overview](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).\nA shopper token allows you to access the Shopper API endpoints of both OCAPI and the B2C Commerce API. These endpoints can be used to build headless storefronts and other applications.\nThe `ShopperToken` security scheme is a parent of other security schemes, such as `ShopperTokenTsob`. A Shopper API endpoint can require a specific child scheme (`ShopperTokenTsob`, for example) that cannot be accessed with a regular shopper token.\n" + flows: + clientCredentials: + tokenUrl: https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token + scopes: + sfcc.shopper-experience: Shopper Experience scope READONLY + authorizationCode: + authorizationUrl: https://{short-code}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/authorize + tokenUrl: https://{short-code}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token + scopes: + sfcc.shopper-experience: Shopper Experience scope READONLY + schemas: + OrganizationId: + description: An identifier for the organization the request is being made by + example: f_ecom_zzxy_prd + type: string + minLength: 1 + maxLength: 32 + SiteId: + minLength: 1 + maxLength: 32 + description: The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites + example: RefArch + type: string + LanguageCountry: + pattern: ^[a-z][a-z]-[A-Z][A-Z]$ + description: A concatenated version of the standard Language and Country codes, combined with a hyphen '`-`'. + example: en-US + type: string + LanguageCode: + pattern: ^[a-z][a-z]$ + description: A two letter lowercase language code conforming to the [ISO 639-1](https://www.iso.org/iso-639-language-codes.html) standard. Additionally, this may be used to submit requests with the header parameter `Accept-Language`, following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). + example: en + type: string + DefaultFallback: + default: default + description: A specialized value indicating the system default values for locales. + example: default + enum: + - default + type: string + LocaleCode: + description: A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified. + oneOf: + - $ref: '#/components/schemas/LanguageCountry' + - $ref: '#/components/schemas/LanguageCode' + - $ref: '#/components/schemas/DefaultFallback' + Region: + properties: + id: + maxLength: 256 + title: ID + description: Region identifier. + example: header + type: string + components: + title: Components + description: The components in the region. + example: + - id: iofwj38fhw3f + typeId: commerce_assets.banner + data: + title: Products On Sale + bannerImage: sale/topsellerPromo.jpg + custom: + thumbnail_full: http://static.myshop.com/sale/topsellerPromo.jpg + type: array + items: + $ref: '#/components/schemas/Component' + required: + - id + type: object + Component: + properties: + id: + maxLength: 256 + title: ID + description: Component identifier. + example: rfdvj4ojtltljw3 + type: string + typeId: + maxLength: 256 + title: Component Type ID + description: Component type identifier. + example: commerce_assets.carousel + type: string + data: + title: Component Data + description: The configuration data assigned to the component. + example: + title: Topseller + category: topseller + type: object + additionalProperties: false + custom: + title: Custom Component Data + description: Any custom data added by the custom code for this component. + example: + detailUrl: www.myshop.com/topseller + type: object + additionalProperties: false + regions: + title: Regions + description: The regions (and their assigned components) for the component. + example: + - id: tiles + components: + - id: w3reö9wsjf3 + typeId: commerce_assets.productTile + data: + product: iphone6 + - id: cgn8d4ngdl4n + typeId: commerce_assets.productTile + data: + product: iphone7 + type: array + items: + $ref: '#/components/schemas/Region' + required: + - id + - typeId + type: object + Page: + properties: + id: + maxLength: 256 + title: ID + description: Page identifier. + example: homepage + type: string + typeId: + maxLength: 256 + title: Page Type ID + description: Page type identifier. + example: storePage + type: string + aspectTypeId: + maxLength: 256 + title: Aspect Type ID + description: The aspect type assigned to the page. + example: pdpAspect + type: string + name: + maxLength: 4000 + title: Page Name + description: Display name of the page. + example: Homepage + type: string + description: + maxLength: 4000 + title: Page Description + description: Description of the page. + example: Home page of the storefront. + type: string + pageTitle: + maxLength: 4000 + title: SEO Title + description: The SEO title of the page. + example: Homepage - My Shop + type: string + pageDescription: + maxLength: 4000 + title: SEO Description + description: The SEO description of the page. + example: Get started shopping + type: string + pageKeywords: + maxLength: 4000 + title: SEO Keywords + description: The SEO keywords of the page. + example: fashion, my shop + type: string + data: + title: Page Data + description: The configuration data assigned to the page. + example: + thumbnail: myshop.jpg + type: object + additionalProperties: false + custom: + title: Custom Page Data + description: Any custom data added by the custom code for the page type. + example: + thumbnail_full: http://static.myshop.com/myshop.jpg + type: object + additionalProperties: false + regions: + title: Regions + description: The regions (and their assigned components) for the page. + example: + - id: header + components: + - id: iofwj38fhw3f + typeId: commerce_assets.banner + data: + title: Products On Sale + bannerImage: sale/topsellerPromo.jpg + custom: + thumbnail_full: http://static.myshop.com/sale/topsellerPromo.jpg + - id: main + components: + - id: rfdvj4ojtltljw3 + typeId: commerce_assets.carousel + data: + title: Topseller + category: topseller + custom: + detailUrl: www.myshop.com/topseller + regions: + - id: tiles + components: + - id: w3reö9wsjf3 + typeId: commerce_assets.productTile + data: + product: iphone6 + - id: cgn8d4ngdl4n + typeId: commerce_assets.productTile + data: + product: iphone7 + - id: footer + components: [] + type: array + items: + $ref: '#/components/schemas/Region' + required: + - id + - typeId + type: object + PageResult: + properties: + data: + title: Data + description: List of pages. + type: array + items: + $ref: '#/components/schemas/Page' + required: + - data + type: object + ErrorResponse: + type: object + additionalProperties: true + properties: + title: + description: "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the \nproblem, except for purposes of localization\n" + type: string + maxLength: 256 + example: You do not have enough credit + type: + description: | + A URI reference [RFC3986] that identifies the + problem type. This specification encourages that, when + dereferenced, it provide human-readable documentation for the + problem type (e.g., using HTML [W3C.REC-html5-20141028]). When + this member is not present, its value is assumed to be + "about:blank". It accepts relative URIs; this means + that they must be resolved relative to the document's base URI, as + per [RFC3986], Section 5. + type: string + maxLength: 2048 + example: NotEnoughMoney + detail: + description: A human-readable explanation specific to this occurrence of the problem. + type: string + example: Your current balance is 30, but that costs 50 + instance: + description: | + A URI reference that identifies the specific + occurrence of the problem. It may or may not yield further + information if dereferenced. It accepts relative URIs; this means + that they must be resolved relative to the document's base URI, as + per [RFC3986], Section 5. + type: string + maxLength: 2048 + example: /account/12345/msgs/abc + required: + - title + - type + - detail + parameters: + organizationId: + description: An identifier for the organization the request is being made by + name: organizationId + in: path + required: true + example: f_ecom_zzxy_prd + schema: + $ref: '#/components/schemas/OrganizationId' + categoryId: + name: categoryId + in: query + description: Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided. + required: false + schema: + maxLength: 256 + type: string + example: home-clearance + productId: + name: productId + in: query + description: Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided. + required: false + schema: + maxLength: 100 + type: string + example: iphone11 + aspectTypeId: + name: aspectTypeId + in: query + description: Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`. + required: true + schema: + maxLength: 256 + type: string + example: pdp + aspectAttributes: + name: aspectAttributes + in: query + description: A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding. + required: false + schema: + type: string + maxLength: 256 + example: |- + { + "product" : "iphone11", + "breadcrumbCategory" : "home-clearance" + } + parameters: + name: parameters + in: query + description: A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding. + required: false + schema: + maxLength: 256 + type: string + example: refine=color,size;currency=USD;showNavigation=false + siteId: + description: The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites. + name: siteId + in: query + required: true + examples: + SiteId: + value: RefArch + schema: + $ref: '#/components/schemas/SiteId' + locale: + description: A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified. + name: locale + in: query + examples: + LanguageCountry: + value: en-US + CountryCode: + value: US + schema: + $ref: '#/components/schemas/LocaleCode' + pageId: + name: pageId + in: path + description: Identifier for the requested page. + required: true + schema: + maxLength: 256 + type: string + example: homepage + examples: + PageResult: + value: + data: + - id: homePpage + typeId: storePage + aspectTypeId: pdpAspect + name: Homepage + description: Home page of the storefront. + pageTitle: Homepage - My Shop + pageDescription: Get started shopping + pageKeywords: fashion, my shop + data: + thumbnail: myshop.jpg + custom: + thumbnail_full: http://static.myshop.com/myshop.jpg + regions: + - id: header + components: + - id: 2192f5b9aac0f2af2385f6f6b7 + typeId: commerce_assets.banner + data: + title: Products On Sale + bannerImage: sale/topsellerPromo.jpg + custom: + thumbnail_full: http://static.myshop.com/sale/topsellerPromo.jpg + - id: main + components: + - id: 5c5ebbcd2aee1a67af519c83b5 + typeId: commerce_assets.carousel + data: + title: Topseller + category: topseller + custom: + detailUrl: www.myshop.com/topseller + regions: + - id: tiles + components: + - id: d98a30dfe93715e3e6fc22a329 + typeId: commerce_assets.productTile + data: + product: iphone6 + - id: 43aa39896afb9292308181ce14 + typeId: commerce_assets.productTile + data: + product: iphone7 + - id: detailpage + typeId: storePage + name: storepage + description: A Store page + pageTitle: A Store + pageDescription: Buy in store + pageKeywords: fashion, my shop, store + data: + thumbnail: mystore.jpg + BusinessObjectIDInvalid: + value: + title: Business Object ID Invalid + type: https://api.commercecloud.salesforce.com/documentation/error/v1/errors/business-object-id-invalid + detail: At least one provided business object identifier was invalid. This means either none was provided at all or exclusiveness of multiple identifiers wasn't honored or the referenced business object didn't exist. + AspectTypeNotFound: + value: + title: Aspect Type Not Found + type: https://api.commercecloud.salesforce.com/documentation/error/v1/errors/aspect-type-not-found + detail: No aspect type with ID 'pdp' was found in site 'RefArch'. + Page: + value: + id: homepage + typeId: storePage + aspectTypeId: pdpAspect + name: Homepage + description: Home page of the storefront. + pageTitle: Homepage - My Shop + pageDescription: Get started shopping + pageKeywords: fashion, my shop + data: + thumbnail: myshop.jpg + custom: + thumbnail_full: http://static.myshop.com/myshop.jpg + regions: + - id: header + components: + - id: 375b9107b067902827083772f9 + typeId: commerce_assets.banner + data: + title: Products On Sale + bannerImage: sale/topsellerPromo.jpg + custom: + thumbnail_full: http://static.myshop.com/sale/topsellerPromo.jpg + - id: main + components: + - id: be1f331b92d8ad7e38e440e35d + typeId: commerce_assets.carousel + data: + title: Topseller + category: topseller + custom: + detailUrl: www.myshop.com/topseller + regions: + - id: tiles + components: + - id: 45af07459684e6db78990c5d05 + typeId: commerce_assets.productTile + data: + product: iphone6 + - id: df6e33766d90e7e205d109aa2f + typeId: commerce_assets.productTile + data: + product: iphone7 + AspectAttributeInvalid: + value: + title: Aspect Attribute Invalid + type: https://api.commercecloud.salesforce.com/documentation/error/v1/errors/aspect-attribute-invalid + detail: 'Aspect attribute value "5555" does not fulfill its respective definition {"id" : "foobar", "type" : "string","required" : "false"}' + PageNotFound: + value: + title: Page Not Found + type: https://api.commercecloud.salesforce.com/documentation/error/v1/errors/page-not-found + detail: No visible page with ID 'homepage' was found in site 'RefArch'. diff --git a/apis/shopper-login-oas/shopper-login-oas-1.39.39/.metadata.json b/apis/shopper-login-oas/shopper-login-oas-1.39.40/.metadata.json similarity index 90% rename from apis/shopper-login-oas/shopper-login-oas-1.39.39/.metadata.json rename to apis/shopper-login-oas/shopper-login-oas-1.39.40/.metadata.json index dfba711f..be593d46 100644 --- a/apis/shopper-login-oas/shopper-login-oas-1.39.39/.metadata.json +++ b/apis/shopper-login-oas/shopper-login-oas-1.39.40/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-login-oas/1.39.39", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-login-oas/1.39.40", "name": "Shopper Login OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-login-oas", - "version": "1.39.39", + "version": "1.39.40", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/shopper-login-oas/shopper-login-oas-1.39.39/exchange.json b/apis/shopper-login-oas/shopper-login-oas-1.39.40/exchange.json similarity index 92% rename from apis/shopper-login-oas/shopper-login-oas-1.39.39/exchange.json rename to apis/shopper-login-oas/shopper-login-oas-1.39.40/exchange.json index eca13c0e..1a1a493c 100644 --- a/apis/shopper-login-oas/shopper-login-oas-1.39.39/exchange.json +++ b/apis/shopper-login-oas/shopper-login-oas-1.39.40/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Login OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-login-oas", - "version": "1.39.39", + "version": "1.39.40", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/shopper-login-oas/shopper-login-oas-1.39.39/shopper-login-oas-v1-internal.yaml b/apis/shopper-login-oas/shopper-login-oas-1.39.40/shopper-login-oas-v1-internal.yaml similarity index 100% rename from apis/shopper-login-oas/shopper-login-oas-1.39.39/shopper-login-oas-v1-internal.yaml rename to apis/shopper-login-oas/shopper-login-oas-1.39.40/shopper-login-oas-v1-internal.yaml diff --git a/apis/shopper-login-oas/shopper-login-oas-1.39.39/shopper-login-oas-v1-public.yaml b/apis/shopper-login-oas/shopper-login-oas-1.39.40/shopper-login-oas-v1-public.yaml similarity index 100% rename from apis/shopper-login-oas/shopper-login-oas-1.39.39/shopper-login-oas-v1-public.yaml rename to apis/shopper-login-oas/shopper-login-oas-1.39.40/shopper-login-oas-v1-public.yaml diff --git a/apis/shopper-stores-oas/shopper-stores-oas-1.0.16/.metadata.json b/apis/shopper-stores-oas/shopper-stores-oas-1.0.17/.metadata.json similarity index 91% rename from apis/shopper-stores-oas/shopper-stores-oas-1.0.16/.metadata.json rename to apis/shopper-stores-oas/shopper-stores-oas-1.0.17/.metadata.json index 29049a24..cf46f91e 100644 --- a/apis/shopper-stores-oas/shopper-stores-oas-1.0.16/.metadata.json +++ b/apis/shopper-stores-oas/shopper-stores-oas-1.0.17/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-stores-oas/1.0.16", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-stores-oas/1.0.17", "name": "Shopper Stores OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-stores-oas", - "version": "1.0.16", + "version": "1.0.17", "categories": { "SDK Type": [ "Isomorphic", diff --git a/apis/shopper-stores-oas/shopper-stores-oas-1.0.16/exchange.json b/apis/shopper-stores-oas/shopper-stores-oas-1.0.17/exchange.json similarity index 93% rename from apis/shopper-stores-oas/shopper-stores-oas-1.0.16/exchange.json rename to apis/shopper-stores-oas/shopper-stores-oas-1.0.17/exchange.json index 85bcbebe..dd70dc9f 100644 --- a/apis/shopper-stores-oas/shopper-stores-oas-1.0.16/exchange.json +++ b/apis/shopper-stores-oas/shopper-stores-oas-1.0.17/exchange.json @@ -3,7 +3,7 @@ "name": "Shopper Stores OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "shopper-stores-oas", - "version": "1.0.16", + "version": "1.0.17", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/shopper-stores-oas/shopper-stores-oas-1.0.16/shopper-stores-oas-v1-internal.yaml b/apis/shopper-stores-oas/shopper-stores-oas-1.0.17/shopper-stores-oas-v1-internal.yaml similarity index 100% rename from apis/shopper-stores-oas/shopper-stores-oas-1.0.16/shopper-stores-oas-v1-internal.yaml rename to apis/shopper-stores-oas/shopper-stores-oas-1.0.17/shopper-stores-oas-v1-internal.yaml diff --git a/apis/shopper-stores-oas/shopper-stores-oas-1.0.16/shopper-stores-oas-v1-public.yaml b/apis/shopper-stores-oas/shopper-stores-oas-1.0.17/shopper-stores-oas-v1-public.yaml similarity index 100% rename from apis/shopper-stores-oas/shopper-stores-oas-1.0.16/shopper-stores-oas-v1-public.yaml rename to apis/shopper-stores-oas/shopper-stores-oas-1.0.17/shopper-stores-oas-v1-public.yaml diff --git a/apis/slas-admin-oas/slas-admin-oas-1.12.29/.metadata.json b/apis/slas-admin-oas/slas-admin-oas-1.12.30/.metadata.json similarity index 90% rename from apis/slas-admin-oas/slas-admin-oas-1.12.29/.metadata.json rename to apis/slas-admin-oas/slas-admin-oas-1.12.30/.metadata.json index 27d638c1..cf0a8a14 100644 --- a/apis/slas-admin-oas/slas-admin-oas-1.12.29/.metadata.json +++ b/apis/slas-admin-oas/slas-admin-oas-1.12.30/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/slas-admin-oas/1.12.29", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/slas-admin-oas/1.12.30", "name": "SLAS Admin OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "slas-admin-oas", - "version": "1.12.29", + "version": "1.12.30", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/slas-admin-oas/slas-admin-oas-1.12.29/exchange.json b/apis/slas-admin-oas/slas-admin-oas-1.12.30/exchange.json similarity index 92% rename from apis/slas-admin-oas/slas-admin-oas-1.12.29/exchange.json rename to apis/slas-admin-oas/slas-admin-oas-1.12.30/exchange.json index ab405020..8dda3944 100644 --- a/apis/slas-admin-oas/slas-admin-oas-1.12.29/exchange.json +++ b/apis/slas-admin-oas/slas-admin-oas-1.12.30/exchange.json @@ -3,7 +3,7 @@ "name": "SLAS Admin-UAP OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "slas-admin-oas", - "version": "1.12.29", + "version": "1.12.30", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/slas-admin-oas/slas-admin-oas-1.12.29/slas-admin-oas-v1-internal.yaml b/apis/slas-admin-oas/slas-admin-oas-1.12.30/slas-admin-oas-v1-internal.yaml similarity index 100% rename from apis/slas-admin-oas/slas-admin-oas-1.12.29/slas-admin-oas-v1-internal.yaml rename to apis/slas-admin-oas/slas-admin-oas-1.12.30/slas-admin-oas-v1-internal.yaml diff --git a/apis/slas-admin-oas/slas-admin-oas-1.12.29/slas-admin-oas-v1-public.yaml b/apis/slas-admin-oas/slas-admin-oas-1.12.30/slas-admin-oas-v1-public.yaml similarity index 100% rename from apis/slas-admin-oas/slas-admin-oas-1.12.29/slas-admin-oas-v1-public.yaml rename to apis/slas-admin-oas/slas-admin-oas-1.12.30/slas-admin-oas-v1-public.yaml diff --git a/apis/source-code-groups-oas/source-code-groups-oas-1.0.36/.metadata.json b/apis/source-code-groups-oas/source-code-groups-oas-1.0.37/.metadata.json similarity index 89% rename from apis/source-code-groups-oas/source-code-groups-oas-1.0.36/.metadata.json rename to apis/source-code-groups-oas/source-code-groups-oas-1.0.37/.metadata.json index de1144a4..6c9e120f 100644 --- a/apis/source-code-groups-oas/source-code-groups-oas-1.0.36/.metadata.json +++ b/apis/source-code-groups-oas/source-code-groups-oas-1.0.37/.metadata.json @@ -1,10 +1,10 @@ { - "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/source-code-groups-oas/1.0.36", + "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/source-code-groups-oas/1.0.37", "name": "Source Code Groups OAS", "description": "", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "source-code-groups-oas", - "version": "1.0.36", + "version": "1.0.37", "categories": { "SDK Type": [ "Commerce" diff --git a/apis/source-code-groups-oas/source-code-groups-oas-1.0.36/exchange.json b/apis/source-code-groups-oas/source-code-groups-oas-1.0.37/exchange.json similarity index 93% rename from apis/source-code-groups-oas/source-code-groups-oas-1.0.36/exchange.json rename to apis/source-code-groups-oas/source-code-groups-oas-1.0.37/exchange.json index fddbc91b..3f1ab4ac 100644 --- a/apis/source-code-groups-oas/source-code-groups-oas-1.0.36/exchange.json +++ b/apis/source-code-groups-oas/source-code-groups-oas-1.0.37/exchange.json @@ -3,7 +3,7 @@ "name": "Source Code Groups OAS", "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", "assetId": "source-code-groups-oas", - "version": "1.0.36", + "version": "1.0.37", "classifier": "oas", "tags": [], "descriptorVersion": "1.0.0", diff --git a/apis/source-code-groups-oas/source-code-groups-oas-1.0.36/source-code-groups-oas-v1-internal.yaml b/apis/source-code-groups-oas/source-code-groups-oas-1.0.37/source-code-groups-oas-v1-internal.yaml similarity index 97% rename from apis/source-code-groups-oas/source-code-groups-oas-1.0.36/source-code-groups-oas-v1-internal.yaml rename to apis/source-code-groups-oas/source-code-groups-oas-1.0.37/source-code-groups-oas-v1-internal.yaml index 84005cfd..f193f919 100644 --- a/apis/source-code-groups-oas/source-code-groups-oas-1.0.36/source-code-groups-oas-v1-internal.yaml +++ b/apis/source-code-groups-oas/source-code-groups-oas-1.0.37/source-code-groups-oas-v1-internal.yaml @@ -386,6 +386,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 @@ -423,6 +424,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -451,6 +453,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: @@ -484,6 +487,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -560,6 +564,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. @@ -573,16 +578,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 @@ -625,6 +644,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: @@ -648,6 +668,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 @@ -696,6 +717,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. @@ -729,7 +751,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 @@ -755,6 +785,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -781,6 +812,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -894,6 +926,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false SourceCodeGroupSearchResult: description: Document representing a source code group search result. type: object diff --git a/apis/source-code-groups-oas/source-code-groups-oas-1.0.36/source-code-groups-oas-v1-public.yaml b/apis/source-code-groups-oas/source-code-groups-oas-1.0.37/source-code-groups-oas-v1-public.yaml similarity index 97% rename from apis/source-code-groups-oas/source-code-groups-oas-1.0.36/source-code-groups-oas-v1-public.yaml rename to apis/source-code-groups-oas/source-code-groups-oas-1.0.37/source-code-groups-oas-v1-public.yaml index 84005cfd..f193f919 100644 --- a/apis/source-code-groups-oas/source-code-groups-oas-1.0.36/source-code-groups-oas-v1-public.yaml +++ b/apis/source-code-groups-oas/source-code-groups-oas-1.0.37/source-code-groups-oas-v1-public.yaml @@ -386,6 +386,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 @@ -423,6 +424,7 @@ components: type: array items: $ref: '#/components/schemas/Query' + additionalProperties: false Filter: minProperties: 1 maxProperties: 1 @@ -451,6 +453,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: @@ -484,6 +487,7 @@ components: example: and required: - operator + additionalProperties: false QueryFilter: description: Wraps any query and allows it to be used as a filter. type: object @@ -560,6 +564,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. @@ -573,16 +578,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 @@ -625,6 +644,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: @@ -648,6 +668,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 @@ -696,6 +717,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. @@ -729,7 +751,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 @@ -755,6 +785,7 @@ components: required: - fields - searchPhrase + additionalProperties: false String256: type: string maxLength: 256 @@ -781,6 +812,7 @@ components: type: string required: - field + additionalProperties: false Offset: default: 0 minimum: 0 @@ -894,6 +926,7 @@ components: sortOrder: desc offset: 2 total: 8 + additionalProperties: false SourceCodeGroupSearchResult: description: Document representing a source code group search result. type: object diff --git a/package.json b/package.json index b0e7f8d2..39552f8d 100644 --- a/package.json +++ b/package.json @@ -28,11 +28,12 @@ "doc": "npm run doc:generate && npm run doc:resources", "doc:generate": "typedoc --mode modules --out ./docs renderedTemplates/** --tsconfig tsconfig.json --external-modulemap \".*/renderedTemplates/([\\w\\-_]+)/\"", "doc:resources": "cp CHANGELOG.md ./docs", + "generateApiVersionTable": "ts-node src/generateApiVersionTable.ts", "lint": "npm run lint:dev -- --quiet", "lint:dev": "sort-package-json && eslint . --ext .ts --fix", "prepack": "npm run build", "prepare": "snyk protect", - "renderTemplates": "PACKAGE_VERSION=$(node -p \"require('./package.json').version\") ts-node src/generate-oas.ts", + "renderTemplates": "PACKAGE_VERSION=$(node -p \"require('./package.json').version\") ts-node src/generateOas.ts", "snyk:auth": "snyk auth", "pretest": "npm run lint && npm run depcheck", "test": "nyc mocha \"src/**/*.test.ts\"", diff --git a/src/generateApiVersionTable.ts b/src/generateApiVersionTable.ts new file mode 100644 index 00000000..5b099ad2 --- /dev/null +++ b/src/generateApiVersionTable.ts @@ -0,0 +1,167 @@ +import * as fs from 'fs'; +import * as path from 'path'; + +interface ApiVersion { + name: string; + version: string; +} + +/** + * Extracts API name and version from directory name + * Example: "assignments-oas-1.0.35" -> { name: "assignments", version: "1.0.35" } + */ +function extractApiInfo(dirName: string): ApiVersion | null { + // Match pattern like "api-name-oas-version" + const match = dirName.match(/^(.+)-oas-(.+)$/); + if (!match) { + return null; + } + + const apiName = match[1]; + const version = match[2]; + + // Validate version format (should be like 1.0.35, 2.0.16, etc.) + if (!/^\d+\.\d+\.\d+$/.test(version)) { + return null; + } + + return { name: apiName, version }; +} + +/** + * Scans the apis directory and extracts all API versions + */ +function scanApisDirectory(): ApiVersion[] { + const apisDir = path.join(process.cwd(), 'apis'); + const apis: ApiVersion[] = []; + + if (!fs.existsSync(apisDir)) { + console.error('apis directory not found'); + return apis; + } + + const apiDirs = fs.readdirSync(apisDir, { withFileTypes: true }) + .filter(dirent => dirent.isDirectory()) + .map(dirent => dirent.name); + + for (const apiDir of apiDirs) { + const apiPath = path.join(apisDir, apiDir); + const versionDirs = fs.readdirSync(apiPath, { withFileTypes: true }) + .filter(dirent => dirent.isDirectory()) + .map(dirent => dirent.name); + + for (const versionDir of versionDirs) { + const apiInfo = extractApiInfo(versionDir); + if (apiInfo) { + apis.push(apiInfo); + } + } + } + + return apis; +} + +/** + * Generates the API version table markdown + */ +function generateApiVersionTable(apis: ApiVersion[]): string { + if (apis.length === 0) { + return ''; + } + // Sort by API name, then version (descending) + apis.sort((a, b) => { + if (a.name !== b.name) return a.name.localeCompare(b.name); + return compareVersions(b.version, a.version); // descending version + }); + const table = [ + '| API Name | API Version |', + '|----------|-------------|', + ...apis.map(api => `| ${api.name} | ${api.version} |`) + ].join('\n'); + + return `\n### API Versions\n\n${table}\n`; +} + +/** + * Compares two version strings + * Returns: 1 if v1 > v2, -1 if v1 < v2, 0 if equal + */ +function compareVersions(v1: string, v2: string): number { + const parts1 = v1.split('.').map(Number); + const parts2 = v2.split('.').map(Number); + + for (let i = 0; i < Math.max(parts1.length, parts2.length); i++) { + const part1 = parts1[i] || 0; + const part2 = parts2[i] || 0; + + if (part1 > part2) return 1; + if (part1 < part2) return -1; + } + + return 0; +} + +/** + * Updates the CHANGELOG.md file with the API version table under the latest version section + */ +function updateChangelog(apiTable: string): void { + const changelogPath = path.join(process.cwd(), 'CHANGELOG.md'); + + if (!fs.existsSync(changelogPath)) { + console.error('CHANGELOG.md not found'); + return; + } + + let content = fs.readFileSync(changelogPath, 'utf8'); + + // Find the first version section (## vX.Y.Z) + const versionSectionRegex = /^(## v\d+\.\d+\.\d+\s*)$/m; + const match = content.match(versionSectionRegex); + + if (!match) { + console.error('No version section found in CHANGELOG.md'); + return; + } + + // Remove any existing API Versions table under the first version section + const apiTableRegex = /(## v\d+\.\d+\.\d+\s*)(\n### API Versions\n[\s\S]*?)(?=\n## |\n#|$)/m; + if (apiTableRegex.test(content)) { + content = content.replace(apiTableRegex, `$1`); // Remove old table + } + + // Insert the table after the first version header + const insertIndex = match.index! + match[0].length; + const beforeSection = content.substring(0, insertIndex); + const afterSection = content.substring(insertIndex); + + const updatedContent = beforeSection + apiTable + afterSection; + + fs.writeFileSync(changelogPath, updatedContent, 'utf8'); + console.log('Successfully updated CHANGELOG.md with API version table'); +} + +/** + * Main function + */ +function main(): void { + console.log('Scanning apis directory for API versions...'); + + const allApis = scanApisDirectory(); + console.log(`Found ${allApis.length} API versions`); + + const apiTable = generateApiVersionTable(allApis); + + if (apiTable) { + updateChangelog(apiTable); + console.log('API version table generated successfully'); + } else { + console.log('No valid API versions found'); + } +} + +// Run the script +if (require.main === module) { + main(); +} + +export { main, scanApisDirectory, generateApiVersionTable }; \ No newline at end of file diff --git a/src/generate-oas.ts b/src/generateOas.ts similarity index 100% rename from src/generate-oas.ts rename to src/generateOas.ts