Skip to content

Update main admin API schema #452

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 #452

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
146 changes: 87 additions & 59 deletions adminapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75352,6 +75352,27 @@
}
}
},
"/_action/user/logout": {
"post": {
"tags": [
"Authorization & Authentication"
],
"summary": "Logout the current user",
"description": "Revokes all server-side refresh tokens for the currently authenticated administration user and returns a no content response.",
"operationId": "userLogout",
"responses": {
"204": {
"description": "Tokens have been revoked successfully."
},
"401": {
"description": "Unauthorized - the access token is missing or invalid."
},
"403": {
"description": "The authenticated source does not have a user ID associated."
}
}
}
},
"/_action/container_cache": {
"delete": {
"tags": [
Expand Down Expand Up @@ -77478,6 +77499,45 @@
]
}
},
"/app-system/shop/verify": {
"get": {
"tags": [
"App System",
"Public"
],
"summary": "Verify a shop's APP_URL",
"description": "Used to verify that a shop's APP_URL points to its self. The passed run ID and token are used to query the cache. It returns 204 no content if the given token can be verified using the run id.",
"operationId": "verifyAppUrl",
"parameters": [
{
"name": "runId",
"in": "query",
"description": "A unique identifier used to look up the token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "token",
"in": "query",
"description": "A unique identifier",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "An empty response signalling successful verification."
},
"400": {
"description": "Malformed request or unsuccessful verification."
}
}
}
},
"/_info/queue.json": {
"get": {
"tags": [
Expand Down Expand Up @@ -81406,10 +81466,6 @@
"description": "When boolean value is `true`, the category is listed for selection.",
"type": "boolean"
},
"cmsPageIdSwitched": {
"description": "Runtime field, cannot be used as part of the criteria.",
"type": "boolean"
},
"visibleChildCount": {
"description": "Runtime field, cannot be used as part of the criteria.",
"type": "integer",
Expand Down Expand Up @@ -81473,6 +81529,11 @@
"type": "string",
"pattern": "^[0-9a-f]{32}$"
},
"cmsPageIdSwitched": {
"description": "Runtime field, cannot be used as part of the criteria.",
"type": "boolean",
"deprecated": true
},
"createdAt": {
"type": "string",
"format": "date-time",
Expand Down Expand Up @@ -81995,10 +82056,6 @@
"description": "When boolean value is `true`, the category is listed for selection.",
"type": "boolean"
},
"cmsPageIdSwitched": {
"description": "Runtime field, cannot be used as part of the criteria.",
"type": "boolean"
},
"visibleChildCount": {
"description": "Runtime field, cannot be used as part of the criteria.",
"type": "integer",
Expand Down Expand Up @@ -82075,6 +82132,11 @@
"pattern": "^[0-9a-f]{32}$",
"description": "Unique identity of custom entity type."
},
"cmsPageIdSwitched": {
"description": "Runtime field, cannot be used as part of the criteria.",
"type": "boolean",
"deprecated": true
},
"createdAt": {
"type": "string",
"format": "date-time",
Expand Down Expand Up @@ -85778,7 +85840,7 @@
"format": "date-time"
},
"hash": {
"description": "Password hash for customer recovery.",
"description": "Customer registration double opt-in hash for confirming the customer account.",
"type": "string"
},
"guest": {
Expand Down Expand Up @@ -121044,29 +121106,21 @@
"type": "object",
"properties": {
"field": {
"type": "string"
"type": "string",
"description": "Sort the search results by field like an property identifier."
},
"order": {
"type": "string"
"type": "string",
"description": "Sort the search results of orders by ascending or descending."
},
"naturalSorting": {
"type": "boolean"
"type": "boolean",
"description": "Sorting for special cases such as German letters with umlauts and similar characters etc."
}
},
"required": [
"field"
]
},
"properties": {
"field": {
"description": "Sort the search results by field like an property identifier."
},
"order": {
"description": "Sort the search results of orders by ascending or descending."
},
"naturalSorting": {
"description": "Sorting for special cases such as German letters with umlauts and similar characters etc."
}
}
},
"post-filter": {
Expand All @@ -121087,17 +121141,6 @@
"$ref": "#/components/schemas/RangeFilter"
}
]
},
"properties": {
"type": {
"description": "To filter only the results but not the aggregations with filter types like ==, >=, etc."
},
"field": {
"description": "To filter only the results but not the aggregations by field like an property identifier."
},
"value": {
"description": "To filter only the results but not the aggregations by value."
}
}
},
"associations": {
Expand Down Expand Up @@ -121784,48 +121827,31 @@
"properties": {
"name": {
"type": "string",
"description": "Name of the event"
"description": "Unique name of the businessEventsResponse."
},
"class": {
"type": "string",
"description": "Class name of the event"
"description": "Class name of business event."
},
"data": {
"type": "object",
"description": "Available data of event"
"description": "Internal field."
},
"aware": {
"type": "array",
"description": "Flow builder will base on awareness to show actions",
"description": "Parameter that indicates the areas in which the business event is supported.",
"items": {
"type": "string"
}
},
"extensions": {
"type": "array",
"description": "Extensions data of event",
"description": "Internal field.",
"items": {
"type": "string"
}
}
}
},
"properties": {
"name": {
"description": "Unique name of the businessEventsResponse."
},
"class": {
"description": "Class name of business event."
},
"data": {
"description": "Internal field."
},
"aware": {
"description": "Parameter that indicates the areas in which the business event is supported."
},
"extensions": {
"description": "Internal field."
}
}
},
"ConsentState": {
Expand Down Expand Up @@ -121905,9 +121931,11 @@
}
},
"transactions": {
"properties": {
"paymentMethodId": {
"description": "Unique identity of payment method."
"items": {
"properties": {
"paymentMethodId": {
"description": "Unique identity of payment method."
}
}
}
},
Expand Down
2 changes: 2 additions & 0 deletions adminapi.summary.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
"/_action/theme/{themeId}/configuration",
"/_action/theme/{themeId}/reset",
"/_action/theme/{themeId}/structured-fields",
"/_action/user/logout",
"/_action/validation/email",
"/_info/config",
"/_info/events.json",
Expand Down Expand Up @@ -219,6 +220,7 @@
"/app-shipping-method",
"/app-shipping-method/{id}",
"/app-system/privileges/requested",
"/app-system/shop/verify",
"/app-system/{appName}/privileges",
"/app-system/{appName}/privileges/accepted",
"/app-template",
Expand Down