mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-25 15:19:19 +00:00
Updates execution/asynchronous-tasks.md
Auto commit by GitBook Editor
This commit is contained in:
@@ -1,9 +1,9 @@
|
|||||||
# Asynchronous Tasks
|
# Asynchronous Tasks
|
||||||
If an API operation is asynchronous, but its progress could be tracked by a client, the response to such an asynchronous operation **MUST** return, in the case of success, the **202 Accepted** status code together with a `application/hal+json` representation of a new task-tracking resource.
|
If an API operation is asynchronous, but its progress could be tracked by a client, the response to such an asynchronous operation **MUST** return, in the case of success, the **202 Accepted** status code together with a `application/hal+json` representation of a new **task-tracking resource**.
|
||||||
|
|
||||||
|
|
||||||
## Task Resource
|
## Task Tracking Resource
|
||||||
The task resource **SHOULD** convey the information about the status of the asynchronous task.
|
The task-tracking resource **SHOULD** convey the information about the status of an asynchronous task.
|
||||||
|
|
||||||
Retrieval of such a resource using the HTTP GET Request Method **SHOULD** be designed as follows:
|
Retrieval of such a resource using the HTTP GET Request Method **SHOULD** be designed as follows:
|
||||||
|
|
||||||
|
|||||||
@@ -53,6 +53,16 @@ Every bulk operation **MUST** be atomic.
|
|||||||
|
|
||||||
> _The server must implement bulk requests as atomic. If the request is for creating 10 addresses, the server should create all 10 addresses before returning a successful response code. The server should not commit changes partially in the case of failures._
|
> _The server must implement bulk requests as atomic. If the request is for creating 10 addresses, the server should create all 10 addresses before returning a successful response code. The server should not commit changes partially in the case of failures._
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
|
|
||||||
|
## DO NOT USE "POST tunneling"
|
||||||
|
|
||||||
|
TODO
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user