From 052b8fa8130ae93e241c64d6b53ade7c16085520 Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Tue, 10 Oct 2023 08:05:00 +0000 Subject: [PATCH] Updated API from documentation release --- api-specs/api/api.raml | 2 +- api-specs/checkout/api.raml | 4 +- api-specs/connect/api.raml | 7 ++-- api-specs/frontend-api/api.raml | 4 +- api-specs/history/api.raml | 70 ++++++++++++++++----------------- api-specs/ml/api.raml | 4 +- 6 files changed, 45 insertions(+), 46 deletions(-) diff --git a/api-specs/api/api.raml b/api-specs/api/api.raml index a8652419b..de27012ba 100644 --- a/api-specs/api/api.raml +++ b/api-specs/api/api.raml @@ -1,6 +1,7 @@ #%RAML 1.0 --- title: commercetools Composable Commerce API +annotationTypes: !include types/annotations.raml (products): - Composable Commerce baseUri: https://api.{region}.commercetools.com @@ -36,7 +37,6 @@ traits: localeProjecting: !include traits/locale-projecting.raml storeProjecting: !include traits/store-projecting.raml dataErasure: !include traits/data-erasure.raml -annotationTypes: !include types/annotations.raml types: !include types/types.raml mediaType: application/json resourceTypes: diff --git a/api-specs/checkout/api.raml b/api-specs/checkout/api.raml index a5c821dd4..e1553891a 100644 --- a/api-specs/checkout/api.raml +++ b/api-specs/checkout/api.raml @@ -1,6 +1,8 @@ #%RAML 1.0 --- title: commercetools Checkout API +uses: + annotations: types/annotations.raml (annotations.products): - Checkout version: v1 @@ -29,7 +31,5 @@ baseUriParameters: region: australia-southeast1 provider: gcp name: Australia (Google Cloud, Sydney) -uses: - annotations: types/annotations.raml types: !include types/types.raml diff --git a/api-specs/connect/api.raml b/api-specs/connect/api.raml index 01ee7bc55..fc6f9d8ba 100644 --- a/api-specs/connect/api.raml +++ b/api-specs/connect/api.raml @@ -1,6 +1,9 @@ #%RAML 1.0 --- title: commercetools Connect API +uses: + annotations: types/annotations.raml + common: types/common.raml (annotations.products): - Connect version: v1 @@ -30,10 +33,6 @@ baseUriParameters: provider: gcp name: Australia (Google Cloud, Sydney) -uses: - annotations: types/annotations.raml - common: types/common.raml - types: !include types/types.raml securitySchemes: diff --git a/api-specs/frontend-api/api.raml b/api-specs/frontend-api/api.raml index 3d6ca4929..f269d6c5f 100644 --- a/api-specs/frontend-api/api.raml +++ b/api-specs/frontend-api/api.raml @@ -1,8 +1,6 @@ #%RAML 1.0 --- title: commercetools Frontend API hub API -(products): - - Frontend annotationTypes: package: type: string @@ -13,6 +11,8 @@ annotationTypes: type: array items: type: string +(products): + - Frontend baseUri: https://{project}-{customer}.frontastic.io baseUriParameters: diff --git a/api-specs/history/api.raml b/api-specs/history/api.raml index db30b8fb4..8d5699125 100644 --- a/api-specs/history/api.raml +++ b/api-specs/history/api.raml @@ -1,6 +1,41 @@ #%RAML 1.0 --- title: commercetools Change History API +annotationTypes: + asMap: + type: object + properties: + key: string + value: string + docsBaseUri: + allowedTargets: + - API + type: string + docsBaseUriParameters: + allowedTargets: + - API + type: object + products: + allowedTargets: + - API + type: array + items: + type: string + serviceRegions: + allowedTargets: + - API + - SecuritySchemeSettings + type: array + items: + type: object + properties: + uri: string + region: string + provider: string + name: string + package: + type: string + allowedTargets: TypeDeclaration (products): - Composable Commerce description: Fetch all Records from all resource types that match queryParameters. @@ -49,41 +84,6 @@ securitySchemes: oauth_2_0: !include oauth2.raml securedBy: [oauth_2_0] mediaType: application/json -annotationTypes: - asMap: - type: object - properties: - key: string - value: string - docsBaseUri: - allowedTargets: - - API - type: string - docsBaseUriParameters: - allowedTargets: - - API - type: object - products: - allowedTargets: - - API - type: array - items: - type: string - serviceRegions: - allowedTargets: - - API - - SecuritySchemeSettings - type: array - items: - type: object - properties: - uri: string - region: string - provider: string - name: string - package: - type: string - allowedTargets: TypeDeclaration types: !include types/types.raml resourceTypes: diff --git a/api-specs/ml/api.raml b/api-specs/ml/api.raml index 2f1eb2e66..dd22dc753 100644 --- a/api-specs/ml/api.raml +++ b/api-specs/ml/api.raml @@ -1,8 +1,6 @@ #%RAML 1.0 --- title: commercetools Composable Commerce Machine Learning API -(annotations.products): - - Composable Commerce version: v1 mediaType: application/json baseUri: https://ml-eu.europe-west1.gcp.commercetools.com @@ -16,6 +14,8 @@ uses: common: types/common.raml similar-products: types/similar-products.raml annotations: types/annotations.raml +(annotations.products): + - Composable Commerce securitySchemes: oauth_2_0: !include securitySchemes/oauth2.raml