diff --git a/src/openapi/.redocly.yaml b/src/openapi/.redocly.yaml deleted file mode 100644 index f3190981..00000000 --- a/src/openapi/.redocly.yaml +++ /dev/null @@ -1,26 +0,0 @@ -# See https://docs.redoc.ly/cli/configuration/ for more information. -organization: adobe-developers -extends: - - minimal -apis: - Data Ingestion@1.0: - root: src/openapi/openapi/data-ingestion-schema-v1.yaml - labels: - - main - Data Ingestion@1.0.0: - root: src/openapi/data-ingestion-schema-v1.yaml -theme: - openapi: - pagination: section - hideHostname: true - sortPropsAlphabetically: false - pathInMiddlePanel: true - hideDownloadButton: false - hideTryItPanel: true - layout: stacked - showExtensions: true - nativeScrollbars: true - ctrlFHijack: true - scrollYOffset: 64 - disableSidebar: true - disableDeepLinks: false \ No newline at end of file diff --git a/src/pages/credential/GetCredentialOAuthS2s.js b/src/pages/credential/GetCredentialOAuthS2s.js new file mode 100644 index 00000000..bde13dd4 --- /dev/null +++ b/src/pages/credential/GetCredentialOAuthS2s.js @@ -0,0 +1,173 @@ +import React from 'react' +import { GetCredential } from '@adobe/gatsby-theme-aio/src/components/GetCredential'; +import commerce from "./images/commerce.svg"; + +const GetCredentialOAuthS2s = () => { + + return ( + + + + + + + + + + + + + + + + +
+
+

+ OAuth server-to-server credential +

+

+ This credential allows you to use industry standard OAuth2.0 libraries to generate access tokens using the OAuth 2.0 client credentials grant type. +

+

+ This credential only provides an access token. It does not return the tenant ID associated with your Adobe Commerce Optimizer sandbox environment, which is required for API calls. In addition to the access token, you must manually copy and paste a tenant ID from the Commerce Cloud Manager into the tenantID field in the Try it panel below. See the Get started documentation for help finding your tenant ID. +

+
+ +
+
+ +
+ + + + + + +
+
+

+ OAuth server-to-server credential +

+

+ This credential allows you to use industry standard OAuth2.0 libraries to generate access tokens using the OAuth 2.0 client credentials grant type. +

+
+ +
+
+ + + + + + + + + + + + Access token

Paste the access token into the Authorization header in the Try it panel below. Then, add the tenant ID to the tenant ID field. You only need to do this once; future requests reuse the values automatically.)}/> + + Credential details

The following Client ID and Organization ID are used to generate the access token:)} orderBy="ClientId,ImsOrgID"> + + + +
+ +
+ + + + + +
+

Welcome back

+

You can either re-use an existing credential or create a new credential.

+
+
+ +
+ + Credential details

The following Client ID and Organization ID are used to generate the access token:)} orderBy="ClientId,ImsOrgID"> + + + +
+ + + + + + Access token

Paste the access token into the Authorization header in the Try it panel below. Then, add the tenant ID to the tenant ID field. You only need to do this once; future requests reuse the values automatically.)} /> + + + + + + + +
+ + + + + + + + + + + + + + +
+
+

+ OAuth server-to-server credential +

+

+ This credential allows you to use industry standard OAuth2.0 libraries to generate access tokens using the OAuth 2.0 client credentials grant type. +

+
+ +
+
+
+
+ + ) +} + +export default GetCredentialOAuthS2s; diff --git a/src/pages/credential/images/commerce.svg b/src/pages/credential/images/commerce.svg new file mode 100644 index 00000000..4b22c80c --- /dev/null +++ b/src/pages/credential/images/commerce.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/pages/optimizer/data-ingestion/api-reference.md b/src/pages/optimizer/data-ingestion/api-reference.md deleted file mode 100644 index d270740e..00000000 --- a/src/pages/optimizer/data-ingestion/api-reference.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: Data Ingestion API Reference (REST) -description: Learn about the Data Ingestion Rest API for Adobe Commerce Optimizer. -layout: none ---- - -# API Reference - - diff --git a/src/pages/optimizer/merchandising-services/api-reference.md b/src/pages/optimizer/merchandising-services/api-reference.md deleted file mode 100644 index b1a467d9..00000000 --- a/src/pages/optimizer/merchandising-services/api-reference.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Merchandising API Reference -edition: saas -description: Get information about the storefront APIs to retrieve product and catalog data to create storefront experiences. -keywords: - - GraphQL - - Services - - Search - - Recommendations -frameSrc: /graphql-api/merchandising-api/index.html ---- diff --git a/src/pages/reference/rest/index.md b/src/pages/reference/rest/index.md index 64893043..62690825 100644 --- a/src/pages/reference/rest/index.md +++ b/src/pages/reference/rest/index.md @@ -9,6 +9,8 @@ keywords: layout: none --- -# API Reference +import GetCredentialOAuthS2s from '/src/pages/credential/GetCredentialOAuthS2s.js' - + + + diff --git a/src/openapi/README.md b/static/rest/README.md similarity index 100% rename from src/openapi/README.md rename to static/rest/README.md diff --git a/src/openapi/data-ingestion-schema-v1.yaml b/static/rest/data-ingestion-schema-v1.yaml similarity index 99% rename from src/openapi/data-ingestion-schema-v1.yaml rename to static/rest/data-ingestion-schema-v1.yaml index 92c53ddd..1f7b5a5d 100644 --- a/src/openapi/data-ingestion-schema-v1.yaml +++ b/static/rest/data-ingestion-schema-v1.yaml @@ -15,9 +15,10 @@ info: - [Prices](#tag/Prices)—define and manage product SKU prices and their associated price books. version: 1.0.0 servers: - - url: https://na1-sandbox.api.commerce.adobe.com/ - description: Production endpoint. The TENANT_ID value is the identifier of the Adobe Commerce instance. See [Adobe Commerce Cloud Manager](https://experience.adobe.com/#/commerce/cloud-service/instances) to see your available instances. - + - url: https://na1-stage.api.commerce.adobe.com/{tenantId} + variables: + tenantId: + default: string tags: - name: Metadata description: | @@ -183,8 +184,8 @@ paths: operationId: createProductMetadata parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -300,8 +301,8 @@ paths: When the update is processed, the merge strategy is used to apply changes to `scalar` and `object` type fields. The replace strategy is used to apply changes for fields in an `array`. operationId: updateProductMetadata parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -351,8 +352,8 @@ paths: description: Remove product attribute metadata resources from the catalog data. operationId: deleteProductMetadata parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -485,8 +486,8 @@ paths: * Use the [Delete products API](#operation/deleteProducts) to remove items from the bundle operationId: createProducts parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -890,8 +891,8 @@ paths: The replace strategy is used to apply changes for fields in an `array`. operationId: updateProducts parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -1055,8 +1056,8 @@ paths: Delete products with specified `sku`` and `source`` values operationId: deleteProducts parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -1101,8 +1102,8 @@ paths: Note: After you assign a `parentId` to a price book, you cannot change the parentId value using the update operation. If you want to define a different parent-child relationship, delete the child price book and create a new one with the desired parent-child relationship. operationId: createPriceBooks parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -1151,8 +1152,8 @@ paths: When you submit the update request for a child price book, include the correct `parentId`. If the request includes a different `parentId`, the value is ignored. operationId: updatePriceBooks parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -1195,8 +1196,8 @@ paths: If a price book is deleted by mistake, you have up to one week to restore the deleted price books and their associated prices. Restoring is done by recreating the top-level parent price book that was deleted, using the same payload submitted in the original create price book request. The state of the price books and prices are restored to the status and price values assigned when the price book was deleted. operationId: deletePriceBooks parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -1261,8 +1262,8 @@ paths: operationId: createPrices parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -1417,8 +1418,8 @@ paths: operationId: updatePrices parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -1485,8 +1486,8 @@ paths: operationId: deletePrices parameters: - - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/Authorization" + - $ref: "#/components/parameters/ContentType" - $ref: "#/components/parameters/ContentEncoding" responses: "200": @@ -1566,20 +1567,19 @@ components: schema: $ref: "#/components/schemas/429Response" parameters: - ContentType: - name: Content-Type + Authorization: + name: Authorization in: header required: true schema: type: string - enum: [application/json] - Authorization: - name: Authorization + ContentType: + name: Content-Type in: header required: true schema: type: string - description: Authorization Bearer token + enum: [application/json] ContentEncoding: name: Content-Encoding in: header @@ -1588,7 +1588,6 @@ components: type: string enum: [gzip] description: Use this header if the payload is compressed with gzip. - schemas: FeedItemFailedValidationResult: title: FeedItemFailedValidationResult