Skip to content

Update main admin API schema #407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update main admin API schema #407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
226 changes: 223 additions & 3 deletions adminapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75262,6 +75262,153 @@
}
}
},
"/consents": {
"get": {
"tags": [
"Consent Management",
"Experimental"
],
"summary": "List all consents for current user",
"description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.",
"operationId": "fetchConsents",
"responses": {
"200": {
"description": "List of consents with their status",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ConsentState"
},
"example": {
"product_analytics": {
"name": "product_analytics",
"scopeName": "admin_user",
"identifier": "userId-12345",
"status": "accepted",
"actor": "userId-12345",
"updatedAt": "2024-01-15T10:20:30Z"
},
"backend_data": {
"name": "backend_data",
"scopeName": "system",
"identifier": "system",
"status": "requested",
"actor": null,
"updatedAt": null
}
}
}
}
}
},
"401": {
"description": "Unauthorized - User not logged in or invalid session"
}
}
}
},
"/consents/accept": {
"post": {
"tags": [
"Consent Management",
"Experimental"
],
"summary": "Accept a consent",
"description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.",
"operationId": "acceptConsent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"consent": {
"type": "string",
"description": "The name of the consent to accept"
}
},
"required": [
"consent"
],
"example": {
"consent": "product_analytics"
}
}
}
}
},
"responses": {
"200": {
"description": "Consent status changed successfully. Returns the updated consent status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentState"
}
}
}
},
"404": {
"description": "Bad request - Consent not found or consent property was empty"
},
"401": {
"description": "Unauthorized - User not logged in or invalid session"
}
}
}
},
"/consents/revoke": {
"post": {
"tags": [
"Consent Management",
"Experimental"
],
"summary": "Revoke a consent",
"description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.",
"operationId": "revokeConsent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"consent": {
"type": "string",
"description": "The name of the consent to accept"
}
},
"required": [
"consent"
],
"example": {
"consent": "product_analytics"
}
}
}
}
},
"responses": {
"200": {
"description": "Consent status changed successfully. Returns the updated consent status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsentState"
}
}
}
},
"404": {
"description": "Bad request - Consent not found or consent property was empty"
},
"401": {
"description": "Unauthorized - User not logged in or invalid session"
}
}
}
},
"/_action/order/{orderId}/order-address": {
"post": {
"tags": [
Expand Down Expand Up @@ -106728,6 +106875,10 @@
"customFields": {
"type": "object"
},
"internal": {
"description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.",
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
Expand Down Expand Up @@ -106909,6 +107060,10 @@
"type": "object",
"description": "Additional fields that offer a possibility to add own fields for the different program-areas."
},
"internal": {
"description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.",
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
Expand Down Expand Up @@ -112316,6 +112471,10 @@
"description": "Unique identity of anonymize.",
"type": "boolean"
},
"trackOffcanvasCart": {
"description": "When boolean value is `true`, it enables Google Analytics to track offcanvas cart.",
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
Expand Down Expand Up @@ -112366,9 +112525,14 @@
]
},
"SalesChannelAnalytics": {
"description": "Added since version: 6.2.0.0",
"description": "Sales channel analytics configuration",
"required": [
"id"
"id",
"active",
"trackOrders",
"anonymizeIp",
"trackOffcanvasCart",
"createdAt"
],
"properties": {
"id": {
Expand All @@ -112392,13 +112556,20 @@
"description": "Unique identity of anonymize.",
"type": "boolean"
},
"trackOffcanvasCart": {
"description": "Track off-canvas cart interactions in Google Analytics",
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updatedAt": {
"type": "string",
"type": [
"string",
"null"
],
"format": "date-time",
"readOnly": true
},
Expand Down Expand Up @@ -119584,6 +119755,55 @@
},
"type": "object"
},
"ConsentState": {
"type": "object",
"required": [
"name",
"scopeName",
"identifier",
"status",
"actor",
"updatedAt"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the consent"
},
"scopeName": {
"type": "string",
"description": "The scope of the consent that defines how the identifier is resolved"
},
"identifier": {
"type": "string",
"description": "The resolved identifier of the consent"
},
"status": {
"type": "string",
"enum": [
"unset",
"accepted",
"revoked"
],
"description": "The current status of the consent (requested, accepted, revoked)"
},
"actor": {
"type": [
"string",
"null"
],
"description": "The user name of the user who made the consent decision. null if never updated"
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The timestamp of when the consent status was last updated. null if never updated"
}
}
},
"businessEventsResponse": {
"type": "array",
"items": {
Expand Down
4 changes: 4 additions & 0 deletions adminapi.summary.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,9 @@
"/cms-section/{id}",
"/cms-slot",
"/cms-slot/{id}",
"/consents",
"/consents/accept",
"/consents/revoke",
"/country",
"/country-state",
"/country-state/{id}",
Expand Down Expand Up @@ -656,6 +659,7 @@
"CmsSectionJsonApi",
"CmsSlot",
"CmsSlotJsonApi",
"ConsentState",
"Country",
"CountryJsonApi",
"CountryState",
Expand Down