Skip to content

Commit 6df7e59

Browse files
authored
Merge pull request #12 from pdoerner/complete-before-start-headers
Add Nexus-Operation-Id and Nexus-Link headers to callback definition
2 parents eb7557c + 263385d commit 6df7e59

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Diff for: SPEC.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ timeout for a single HTTP request. Format of this header value is number + unit,
103103
milliseconds, `s` for seconds, and `m` for minutes.
104104

105105
The `Nexus-Link` header field can be added to associate resources with the start request. A handler may attach these
106-
links as metadata to underlying resources to provide end-to-end observabililty. See the [`Nexus-Link`](#nexus-link)
106+
links as metadata to underlying resources to provide end-to-end observability. See the [`Nexus-Link`](#nexus-link)
107107
section for more information.
108108

109109
#### Request Body
@@ -306,6 +306,10 @@ For invoking a callback URL:
306306
- Issue a POST request to the caller-provided URL.
307307
- Include any callback headers supplied in the originating StartOperation request, stripping away the `Nexus-Callback-`
308308
prefix.
309+
- Include the `Nexus-Operation-Id` header, `Nexus-Operation-Start-Time` and any `Nexus-Link` headers for resources
310+
associated with this operation to support completing asynchronous operations before the response to StartOperation is
311+
received. `Nexus-Operation-Start-Time` should be in a valid HTTP format described [here](https://www.rfc-editor.org/rfc/rfc5322.html#section-3.3).
312+
If is omitted, the time the completion is received will be used as operation start time.
309313
- Include the `Nexus-Operation-State` header.
310314
- If state is `succeeded`, deliver non-empty results in the body with corresponding `Content-*` headers.
311315
- If state is `failed` or `canceled`, content type should be `application/json` and the body must have a serialized

0 commit comments

Comments
 (0)