Skip to content

Update SwagDigitalSalesRooms admin API schema #451

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 SwagDigitalSalesRooms admin API schema #451

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
142 changes: 59 additions & 83 deletions SwagDigitalSalesRooms-adminapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4884,89 +4884,63 @@
}
}
},
"/_action/validation/email": {
"/_action/user/logout": {
"post": {
"tags": [
"Email support validation"
"Authorization & Authentication"
],
"summary": "Email support.",
"description": "Checks a given email string.",
"operationId": "supportsEmail",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"email"
],
"properties": {
"email": {
"description": "The email to be verified.",
"type": "string"
}
},
"type": "object"
}
}
}
},
"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": "Email is supported"
"description": "Tokens have been revoked successfully."
},
"400": {
"description": "Invalid request payload. The argument 'email' may be missing.",
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"description": "Contains the error message.",
"type": "array"
}
},
"type": "object"
},
"example": {
"errors": [
{
"code": "0",
"status": "400",
"title": "Unprocessable Content",
"detail": "This value should not be blank."
}
]
}
}
"401": {
"description": "Unauthorized - the access token is missing or invalid."
},
"403": {
"description": "The authenticated source does not have a user ID associated."
}
}
}
},
"/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"
}
},
"422": {
"description": "Email address is not supported.",
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"description": "Contains the validation error.",
"type": "array"
}
},
"type": "object"
},
"example": {
"errors": [
{
"code": "0",
"status": "422",
"title": "Unprocessable Content",
"detail": "This value is not a supported email address."
}
]
}
}
{
"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."
}
}
}
},
Expand Down Expand Up @@ -9068,10 +9042,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 @@ -9135,6 +9105,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 @@ -9650,10 +9625,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 @@ -9717,6 +9688,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 @@ -13474,7 +13450,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 @@ -14316,7 +14292,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
3 changes: 2 additions & 1 deletion SwagDigitalSalesRooms-adminapi.summary.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics",
"/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics",
"/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics",
"/_action/validation/email",
"/_action/user/logout",
"/aggregate/dsr-appointment",
"/aggregate/dsr-appointment-attendee",
"/aggregate/dsr-appointment-request",
Expand All @@ -30,6 +30,7 @@
"/aggregate/dsr-interaction",
"/aggregate/dsr-presentation",
"/aggregate/dsr-presentation-cms-page",
"/app-system/shop/verify",
"/dsr-appointment",
"/dsr-appointment-attendee",
"/dsr-appointment-attendee/{id}",
Expand Down