From eaa679e6b5c81825e765ac010e11482d733aadb6 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 11 Jul 2025 16:25:21 -0500 Subject: [PATCH 1/8] CCSAAS-2663: initial commit of get credential stub files --- src/pages/credential/GetCredentialOAuthS2s.js | 183 ++++++++++++++++++ src/pages/reference/rest/saas.md | 6 +- 2 files changed, 188 insertions(+), 1 deletion(-) create mode 100644 src/pages/credential/GetCredentialOAuthS2s.js diff --git a/src/pages/credential/GetCredentialOAuthS2s.js b/src/pages/credential/GetCredentialOAuthS2s.js new file mode 100644 index 000000000..c8b014edb --- /dev/null +++ b/src/pages/credential/GetCredentialOAuthS2s.js @@ -0,0 +1,183 @@ +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. +

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

+ 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

After copying the access token, you must prepend the token with Bearer to use it with API calls.)} /> + + + Credential details

You can use the following credential details to try out the Adobe Commerce as a Cloud Service REST API below.
  • Client ID: Your public identifier for accessing the API. This acts as an API key when used with the Commerce APIs, and corresponds with the x-api-key header.
  • Organization ID: The ID of the organization you're using with the Commerce APIs. This corresponds with the x-gw-ims-org-id header.
)} orderBy="ClientId,ImsOrgID"> + + + + + + + + + + + +
+

Welcome back

+

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

+
+ + + + + Credential details

You can use the following credential details to try out the Adobe Commerce as a Cloud Service REST API below.
  • Client ID: Your public identifier for accessing the API. This acts as an API key when used with the Platform APIs, and corresponds with the x-api-key header.
  • Organization ID: The ID of the organization you're using with the Commerce APIs. This corresponds with the x-gw-ims-org-id header.
)} orderBy="ClientId,ImsOrgID"> + + + + + + + + + + Access token

After copying the access token, you must prepend the token with Bearer to use it with API calls.)} /> + + + + + + + + + + + + + + + + + + + + + + +
+
+

+ 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/reference/rest/saas.md b/src/pages/reference/rest/saas.md index 7447694da..64bad9a0e 100644 --- a/src/pages/reference/rest/saas.md +++ b/src/pages/reference/rest/saas.md @@ -5,6 +5,10 @@ keywords: - REST edition: saas frameSrc: https://adobe-commerce-saas.redoc.ly ---- +--- + +import GetCredentialsOAuthS2s from '/src/pages/credential/GetCredentialOAuthS2s.js' # REST endpoints for Adobe Commerce as a Cloud Service + + From a9a37d65884fe7ca597295290e8d772007ce22fe Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 11 Jul 2025 16:34:48 -0500 Subject: [PATCH 2/8] fix: added missing image --- src/pages/credential/images/commerce.svg | 1 + 1 file changed, 1 insertion(+) create mode 100644 src/pages/credential/images/commerce.svg diff --git a/src/pages/credential/images/commerce.svg b/src/pages/credential/images/commerce.svg new file mode 100644 index 000000000..4b22c80c7 --- /dev/null +++ b/src/pages/credential/images/commerce.svg @@ -0,0 +1 @@ + \ No newline at end of file From 596aa73c5eda8e8dd0d484deb189f9bdca98df3f Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 11 Jul 2025 16:52:43 -0500 Subject: [PATCH 3/8] fix: remove AAEP doc links --- src/pages/credential/GetCredentialOAuthS2s.js | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/src/pages/credential/GetCredentialOAuthS2s.js b/src/pages/credential/GetCredentialOAuthS2s.js index c8b014edb..15c70996c 100644 --- a/src/pages/credential/GetCredentialOAuthS2s.js +++ b/src/pages/credential/GetCredentialOAuthS2s.js @@ -61,15 +61,9 @@ const GetCredentialOAuthS2s = () => {

Learn more

- + Authentication documentation - - Adobe Experience Platform API documentation - - - Adobe Experience Platform documentation - @@ -162,15 +156,9 @@ const GetCredentialOAuthS2s = () => {

Learn more

- + Authentication documentation - - Adobe Experience Platform API documentation - - - Adobe Experience Platform documentation - From c468ab613b12e0390cd25ebc655fab5ab15bf69a Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 11 Jul 2025 16:53:43 -0500 Subject: [PATCH 4/8] fix: import directive --- src/pages/reference/rest/saas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/reference/rest/saas.md b/src/pages/reference/rest/saas.md index 64bad9a0e..dca88234f 100644 --- a/src/pages/reference/rest/saas.md +++ b/src/pages/reference/rest/saas.md @@ -7,7 +7,7 @@ edition: saas frameSrc: https://adobe-commerce-saas.redoc.ly --- -import GetCredentialsOAuthS2s from '/src/pages/credential/GetCredentialOAuthS2s.js' +import GetCredentialOAuthS2s from '/src/pages/credential/GetCredentialOAuthS2s.js' # REST endpoints for Adobe Commerce as a Cloud Service From 23065ea0cebfcefbb242d4dcec1b768acd457da2 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 11 Jul 2025 17:04:39 -0500 Subject: [PATCH 5/8] fix: use redocly block --- src/pages/reference/rest/saas.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/pages/reference/rest/saas.md b/src/pages/reference/rest/saas.md index dca88234f..60d556ee6 100644 --- a/src/pages/reference/rest/saas.md +++ b/src/pages/reference/rest/saas.md @@ -4,7 +4,7 @@ description: Review comprehensive reference documentation for the Adobe Commerce keywords: - REST edition: saas -frameSrc: https://adobe-commerce-saas.redoc.ly +# frameSrc: https://adobe-commerce-saas.redoc.ly --- import GetCredentialOAuthS2s from '/src/pages/credential/GetCredentialOAuthS2s.js' @@ -12,3 +12,5 @@ import GetCredentialOAuthS2s from '/src/pages/credential/GetCredentialOAuthS2s.j # REST endpoints for Adobe Commerce as a Cloud Service + + From 09486ba3e7cc1b50ecea6b417cba46c9cc732784 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 11 Jul 2025 17:43:01 -0500 Subject: [PATCH 6/8] added pagination config option --- src/pages/reference/rest/saas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/reference/rest/saas.md b/src/pages/reference/rest/saas.md index 60d556ee6..cad73707a 100644 --- a/src/pages/reference/rest/saas.md +++ b/src/pages/reference/rest/saas.md @@ -13,4 +13,4 @@ import GetCredentialOAuthS2s from '/src/pages/credential/GetCredentialOAuthS2s.j - + From 562f29cca85ac2edbd75bcb9cefe01d7355f7f73 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Mon, 14 Jul 2025 10:50:58 -0500 Subject: [PATCH 7/8] fix: apply lessons learned from #463 --- .github/workflows/publish.yml | 1 + .github/workflows/stage.yml | 1 + src/pages/reference/rest/saas.md | 6 ++---- {src/openapi => static/rest}/accs-schema.yaml | 0 4 files changed, 4 insertions(+), 4 deletions(-) rename {src/openapi => static/rest}/accs-schema.yaml (100%) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index c1e395e5c..8c9e14c60 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -97,6 +97,7 @@ jobs: ALGOLIA_WRITE_API_KEY: ${{ secrets.AIO_ALGOLIA_WRITE_API_KEY }} GATSBY_ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME || github.event.repository.name }} GATSBY_FEDS_PRIVACY_ID: ${{ secrets.AIO_FEDS_PRIVACY_ID }} + GATSBY_REDOCLY_KEY: ${{ secrets.REDOCLY_LICENSE_KEY }} GATSBY_SITE_DOMAIN_URL: https://developer.adobe.com - name: Deploy uses: AdobeDocs/static-website-deploy@master diff --git a/.github/workflows/stage.yml b/.github/workflows/stage.yml index 2e0b0d296..20fa072b5 100644 --- a/.github/workflows/stage.yml +++ b/.github/workflows/stage.yml @@ -110,6 +110,7 @@ ALGOLIA_INDEXATION_MODE: skip GATSBY_ALGOLIA_INDEX_NAME: ${{ secrets.ALGOLIA_INDEX_NAME || github.event.repository.name }} GATSBY_FEDS_PRIVACY_ID: ${{ secrets.AIO_FEDS_PRIVACY_ID }} + GATSBY_REDOCLY_KEY: ${{ secrets.REDOCLY_LICENSE_KEY }} GATSBY_SITE_DOMAIN_URL: https://developer-stage.adobe.com - name: Deploy diff --git a/src/pages/reference/rest/saas.md b/src/pages/reference/rest/saas.md index cad73707a..1c976a747 100644 --- a/src/pages/reference/rest/saas.md +++ b/src/pages/reference/rest/saas.md @@ -4,13 +4,11 @@ description: Review comprehensive reference documentation for the Adobe Commerce keywords: - REST edition: saas -# frameSrc: https://adobe-commerce-saas.redoc.ly +layout: none --- import GetCredentialOAuthS2s from '/src/pages/credential/GetCredentialOAuthS2s.js' -# REST endpoints for Adobe Commerce as a Cloud Service - - + diff --git a/src/openapi/accs-schema.yaml b/static/rest/accs-schema.yaml similarity index 100% rename from src/openapi/accs-schema.yaml rename to static/rest/accs-schema.yaml From 32841eb198ba81623b922bb1d5562a96a9911aaa Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 16 Jul 2025 11:54:42 -0500 Subject: [PATCH 8/8] added staging template ID --- src/pages/credential/GetCredentialOAuthS2s.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/credential/GetCredentialOAuthS2s.js b/src/pages/credential/GetCredentialOAuthS2s.js index 15c70996c..22df35ace 100644 --- a/src/pages/credential/GetCredentialOAuthS2s.js +++ b/src/pages/credential/GetCredentialOAuthS2s.js @@ -6,7 +6,7 @@ const GetCredentialOAuthS2s = () => { return ( - +