|
5425 | 5425 | } |
5426 | 5426 | } |
5427 | 5427 | }, |
5428 | | - "/_action/validation/email": { |
5429 | | - "post": { |
| 5428 | + "/app-system/shop/verify": { |
| 5429 | + "get": { |
5430 | 5430 | "tags": [ |
5431 | | - "Email support validation" |
| 5431 | + "App System", |
| 5432 | + "Public" |
5432 | 5433 | ], |
5433 | | - "summary": "Email support.", |
5434 | | - "description": "Checks a given email string.", |
5435 | | - "operationId": "supportsEmail", |
5436 | | - "requestBody": { |
5437 | | - "required": true, |
5438 | | - "content": { |
5439 | | - "application/json": { |
5440 | | - "schema": { |
5441 | | - "required": [ |
5442 | | - "email" |
5443 | | - ], |
5444 | | - "properties": { |
5445 | | - "email": { |
5446 | | - "description": "The email to be verified.", |
5447 | | - "type": "string" |
5448 | | - } |
5449 | | - }, |
5450 | | - "type": "object" |
5451 | | - } |
| 5434 | + "summary": "Verify a shop's APP_URL", |
| 5435 | + "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.", |
| 5436 | + "operationId": "verifyAppUrl", |
| 5437 | + "parameters": [ |
| 5438 | + { |
| 5439 | + "name": "runId", |
| 5440 | + "in": "query", |
| 5441 | + "description": "A unique identifier used to look up the token", |
| 5442 | + "required": true, |
| 5443 | + "schema": { |
| 5444 | + "type": "string" |
| 5445 | + } |
| 5446 | + }, |
| 5447 | + { |
| 5448 | + "name": "token", |
| 5449 | + "in": "query", |
| 5450 | + "description": "A unique identifier", |
| 5451 | + "required": true, |
| 5452 | + "schema": { |
| 5453 | + "type": "string" |
5452 | 5454 | } |
5453 | 5455 | } |
5454 | | - }, |
| 5456 | + ], |
5455 | 5457 | "responses": { |
5456 | 5458 | "204": { |
5457 | | - "description": "Email is supported" |
| 5459 | + "description": "An empty response signalling successful verification." |
5458 | 5460 | }, |
5459 | 5461 | "400": { |
5460 | | - "description": "Invalid request payload. The argument 'email' may be missing.", |
5461 | | - "content": { |
5462 | | - "application/json": { |
5463 | | - "schema": { |
5464 | | - "properties": { |
5465 | | - "errors": { |
5466 | | - "description": "Contains the error message.", |
5467 | | - "type": "array" |
5468 | | - } |
5469 | | - }, |
5470 | | - "type": "object" |
5471 | | - }, |
5472 | | - "example": { |
5473 | | - "errors": [ |
5474 | | - { |
5475 | | - "code": "0", |
5476 | | - "status": "400", |
5477 | | - "title": "Unprocessable Content", |
5478 | | - "detail": "This value should not be blank." |
5479 | | - } |
5480 | | - ] |
5481 | | - } |
5482 | | - } |
5483 | | - } |
5484 | | - }, |
5485 | | - "422": { |
5486 | | - "description": "Email address is not supported.", |
5487 | | - "content": { |
5488 | | - "application/json": { |
5489 | | - "schema": { |
5490 | | - "properties": { |
5491 | | - "errors": { |
5492 | | - "description": "Contains the validation error.", |
5493 | | - "type": "array" |
5494 | | - } |
5495 | | - }, |
5496 | | - "type": "object" |
5497 | | - }, |
5498 | | - "example": { |
5499 | | - "errors": [ |
5500 | | - { |
5501 | | - "code": "0", |
5502 | | - "status": "422", |
5503 | | - "title": "Unprocessable Content", |
5504 | | - "detail": "This value is not a supported email address." |
5505 | | - } |
5506 | | - ] |
5507 | | - } |
5508 | | - } |
5509 | | - } |
| 5462 | + "description": "Malformed request or unsuccessful verification." |
5510 | 5463 | } |
5511 | 5464 | } |
5512 | 5465 | } |
|
8552 | 8505 | "description": "When boolean value is `true`, the category is listed for selection.", |
8553 | 8506 | "type": "boolean" |
8554 | 8507 | }, |
8555 | | - "cmsPageIdSwitched": { |
8556 | | - "description": "Runtime field, cannot be used as part of the criteria.", |
8557 | | - "type": "boolean" |
8558 | | - }, |
8559 | 8508 | "visibleChildCount": { |
8560 | 8509 | "description": "Runtime field, cannot be used as part of the criteria.", |
8561 | 8510 | "type": "integer", |
|
8619 | 8568 | "type": "string", |
8620 | 8569 | "pattern": "^[0-9a-f]{32}$" |
8621 | 8570 | }, |
| 8571 | + "cmsPageIdSwitched": { |
| 8572 | + "description": "Runtime field, cannot be used as part of the criteria.", |
| 8573 | + "type": "boolean", |
| 8574 | + "deprecated": true |
| 8575 | + }, |
8622 | 8576 | "createdAt": { |
8623 | 8577 | "type": "string", |
8624 | 8578 | "format": "date-time", |
|
9134 | 9088 | "description": "When boolean value is `true`, the category is listed for selection.", |
9135 | 9089 | "type": "boolean" |
9136 | 9090 | }, |
9137 | | - "cmsPageIdSwitched": { |
9138 | | - "description": "Runtime field, cannot be used as part of the criteria.", |
9139 | | - "type": "boolean" |
9140 | | - }, |
9141 | 9091 | "visibleChildCount": { |
9142 | 9092 | "description": "Runtime field, cannot be used as part of the criteria.", |
9143 | 9093 | "type": "integer", |
|
9201 | 9151 | "type": "string", |
9202 | 9152 | "pattern": "^[0-9a-f]{32}$" |
9203 | 9153 | }, |
| 9154 | + "cmsPageIdSwitched": { |
| 9155 | + "description": "Runtime field, cannot be used as part of the criteria.", |
| 9156 | + "type": "boolean", |
| 9157 | + "deprecated": true |
| 9158 | + }, |
9204 | 9159 | "createdAt": { |
9205 | 9160 | "type": "string", |
9206 | 9161 | "format": "date-time", |
|
12822 | 12777 | "format": "date-time" |
12823 | 12778 | }, |
12824 | 12779 | "hash": { |
12825 | | - "description": "Password hash for customer recovery.", |
| 12780 | + "description": "Customer registration double opt-in hash for confirming the customer account.", |
12826 | 12781 | "type": "string" |
12827 | 12782 | }, |
12828 | 12783 | "guest": { |
|
13628 | 13583 | "format": "date-time" |
13629 | 13584 | }, |
13630 | 13585 | "hash": { |
13631 | | - "description": "Password hash for customer recovery.", |
| 13586 | + "description": "Customer registration double opt-in hash for confirming the customer account.", |
13632 | 13587 | "type": "string" |
13633 | 13588 | }, |
13634 | 13589 | "guest": { |
|
0 commit comments