Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
8aafa44
add server var for tenant ID
jeff-matthews Jul 17, 2025
fe2993e
optimize security schemes
jeff-matthews Jul 17, 2025
dc22fe3
get credential for openapi specs
jeff-matthews Jul 18, 2025
f8cd006
fix: replaced ACCS with ACO
jeff-matthews Jul 18, 2025
5ce556d
fix: long description
jeff-matthews Jul 18, 2025
1e72f8b
Revert "fix: long description"
jeff-matthews Jul 18, 2025
36be64e
move original spec to static dir
jeff-matthews Jul 18, 2025
3686ac9
added stage project template ID for testing
jeff-matthews Jul 28, 2025
314eef9
Merge branch 'develop' into test-playground
jeff-matthews Jul 28, 2025
d15772b
Merge branch 'develop' into test-playground
jeff-matthews Jul 29, 2025
58c908b
Delete src/pages/optimizer/data-ingestion/api-reference.md
meker12 Aug 1, 2025
a8bd9f0
Delete src/pages/optimizer/merchandising-services/api-reference.md
meker12 Aug 1, 2025
4fd9a65
Merge branch 'main' into test-playground
jeff-matthews Aug 4, 2025
c6dff73
Merge branch 'main' into test-playground
jeff-matthews Aug 4, 2025
ed4a06c
remove unnecessary heading
jeff-matthews Aug 4, 2025
769963d
initial attempt at guidance for retrieving tenant ID
jeff-matthews Aug 4, 2025
b2dacea
refine help message for finding tenant ID
jeff-matthews Aug 4, 2025
8f64dc6
remove server description
jeff-matthews Aug 4, 2025
7b05fe1
add styling to tenant ID help
jeff-matthews Aug 4, 2025
c70576d
replaced securitySchemes w/ parameters for better UX
jeff-matthews Aug 4, 2025
0800f79
Revert "replaced securitySchemes w/ parameters for better UX"
jeff-matthews Aug 4, 2025
4dd1cef
change target server to stage
jeff-matthews Aug 4, 2025
7b4aa3c
separate bearer auth security from API key and IMS org ID parameters
jeff-matthews Aug 4, 2025
19395dd
replace security scheme with parameters again
jeff-matthews Aug 4, 2025
d7491f0
fix: use consistent case
jeff-matthews Aug 4, 2025
440d895
removed api key and IMS org ID headers
jeff-matthews Aug 5, 2025
23481c0
replace credential detail with tenant ID guidance
jeff-matthews Aug 5, 2025
77a5f4e
test: access token heading
jeff-matthews Aug 5, 2025
dc663f5
fix: add scopes
jeff-matthews Aug 5, 2025
d53a698
fix: restore client ID and IMS org ID (partially)
jeff-matthews Aug 5, 2025
7aa102c
fix: add orderby for client Id and IMS org ID
jeff-matthews Aug 5, 2025
31ccb32
clarify token use
jeff-matthews Aug 5, 2025
452ba01
clarify copy token
jeff-matthews Aug 5, 2025
1a13e23
fix: access token return console error
jeff-matthews Aug 5, 2025
68ee975
fix: credential return for client id
jeff-matthews Aug 5, 2025
4fe3751
simplfy component text
jeff-matthews Aug 5, 2025
0a409bc
fix: remove br tags that render as plaintext
jeff-matthews Aug 5, 2025
c178ae7
wordsmithing
jeff-matthews Aug 5, 2025
f0b77d0
separate tenant ID from client and org ID
jeff-matthews Aug 5, 2025
5b2b42f
Apply suggestions from code review
jeff-matthews Aug 6, 2025
df810ee
Apply suggestions from code review
jeff-matthews Aug 6, 2025
232373a
normalize review suggestions for new and return
jeff-matthews Aug 6, 2025
a014f2a
fix: editorial
jeff-matthews Aug 6, 2025
009df3b
fix: case
jeff-matthews Aug 6, 2025
1db7b80
Apply suggestions from code review
jeff-matthews Aug 6, 2025
3707fee
fix: normalize return credential block with review suggestions
jeff-matthews Aug 6, 2025
01fdc04
fix: normalize return credential block with review suggestions
jeff-matthews Aug 6, 2025
e100548
fix: remove redundant sentence
jeff-matthews Aug 6, 2025
e5696e5
Merge pull request #273 from AdobeDocs/test-playground
jeff-matthews Aug 6, 2025
c1960e8
fix: set default content type
jeff-matthews Aug 7, 2025
033a166
Merge pull request #285 from AdobeDocs/updates-for-prod
jeff-matthews Aug 7, 2025
ceb39f9
feat: replace staging template ID and server URL with production sandbox
jeff-matthews Aug 7, 2025
b19e8d2
Merge pull request #286 from AdobeDocs/replace-stage-with-prod
jeff-matthews Aug 7, 2025
27f946a
fix: normalize references to tenant ID (instance ID)
jeff-matthews Aug 7, 2025
364112c
Merge pull request #287 from AdobeDocs/tenant-vs-instance
jeff-matthews Aug 7, 2025
297d457
fix: captialization
jeff-matthews Aug 7, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
optimize security schemes
  • Loading branch information
jeff-matthews committed Jul 17, 2025
commit fe2993e0d84a1aca7cc07acfd3f2071ee4b72e8a
84 changes: 20 additions & 64 deletions src/openapi/data-ingestion-schema-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ info:
- <strong>[Price books](#tag/Price-Books)</strong>—define and manage pricing scopes for different customer tiers and markets.
- <strong>[Prices](#tag/Prices)</strong>—define and manage product SKU prices and their associated price books.
version: 1.0.0
security:
- apiKeyAuth: []
- bearerAuth: []
- imsOrgAuth: []
servers:
- url: https://na1-sandbox.api.commerce.adobe.com/{tenantId}
description: Production endpoint. The tenantId 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.
Expand Down Expand Up @@ -94,12 +98,6 @@ paths:
schema:
type: string
enum: [application/json]
- name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token
- name: Content-Encoding
in: header
required: false
Expand Down Expand Up @@ -249,12 +247,6 @@ paths:
schema:
type: string
enum: [application/json]
- name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token
- name: Content-Encoding
in: header
required: false
Expand Down Expand Up @@ -337,12 +329,6 @@ paths:
schema:
type: string
enum: [application/json]
- name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token.
- name: Content-Encoding
in: header
required: false
Expand Down Expand Up @@ -503,7 +489,6 @@ paths:
operationId: createProducts
parameters:
- $ref: "#/components/parameters/ContentType"
- $ref: "#/components/parameters/Authorization"
- $ref: "#/components/parameters/ContentEncoding"
responses:
"200":
Expand Down Expand Up @@ -906,7 +891,6 @@ paths:
operationId: updateProducts
parameters:
- $ref: "#/components/parameters/ContentType"
- $ref: "#/components/parameters/Authorization"
- $ref: "#/components/parameters/ContentEncoding"
responses:
"200":
Expand Down Expand Up @@ -1069,7 +1053,6 @@ paths:
operationId: deleteProducts
parameters:
- $ref: "#/components/parameters/ContentType"
- $ref: "#/components/parameters/Authorization"
- $ref: "#/components/parameters/ContentEncoding"
responses:
"200":
Expand Down Expand Up @@ -1118,12 +1101,6 @@ paths:
schema:
type: string
enum: [application/json]
- name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token
- name: Content-Encoding
in: header
required: false
Expand Down Expand Up @@ -1206,12 +1183,6 @@ paths:
schema:
type: string
enum: [application/json]
- name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token.
- name: Content-Encoding
in: header
required: false
Expand Down Expand Up @@ -1288,12 +1259,6 @@ paths:
schema:
type: string
enum: [application/json]
- name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token.
- name: Content-Encoding
in: header
required: false
Expand Down Expand Up @@ -1367,12 +1332,6 @@ paths:
schema:
type: string
enum: [application/json]
- name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token
- name: Content-Encoding
in: header
required: false
Expand Down Expand Up @@ -1458,12 +1417,6 @@ paths:
schema:
type: string
enum: [application/json]
- name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token
- name: Content-Encoding
in: header
required: false
Expand Down Expand Up @@ -1544,12 +1497,6 @@ paths:
schema:
type: string
enum: [application/json]
- name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token
- name: Content-Encoding
in: header
required: false
Expand Down Expand Up @@ -1605,6 +1552,21 @@ paths:
$ref: "#/components/schemas/429Response"

components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: API key for authentication
bearerAuth:
type: http
scheme: bearer
description: Bearer token for authorization
imsOrgAuth:
type: apiKey
in: header
name: x-gw-ims-org-id
description: Adobe IMS organization ID
responses:
AcceptedResponse:
description: All items accepted and will be processed asynchronously
Expand Down Expand Up @@ -1638,13 +1600,7 @@ components:
schema:
type: string
enum: [application/json]
Authorization:
name: Authorization
in: header
required: true
schema:
type: string
description: Authorization Bearer token

ContentEncoding:
name: Content-Encoding
in: header
Expand Down