File tree 1 file changed +13
-1
lines changed
1 file changed +13
-1
lines changed Original file line number Diff line number Diff line change @@ -97,6 +97,10 @@ Headers that start with the `Nexus-Callback-` prefix are expected to be attached
97
97
the handler. The callback request must strip away the `Nexus-Callback-` prefix. E.g if a Start Operation request
98
98
includes a `Nexus-Callback-Token : some-token` header, the callback request would include a `Token: some-token` header.
99
99
100
+ The `Nexus-Link` header field can be added to associate resources with the start request. A handler may attach these
101
+ links as metadata to underlying resources to provide end-to-end observabililty. See the [`Nexus-Link`](#nexus-link)
102
+ section for more information.
103
+
100
104
# ### Request Body
101
105
102
106
The body may contain arbitrary data. Headers should specify content type and encoding.
@@ -111,7 +115,8 @@ The body may contain arbitrary data. Headers should specify content type and enc
111
115
112
116
**Body**: Arbitrary data conveying the operation's result. Headers should specify content type and encoding.
113
117
114
- - `201 Created` : Operation was started and will complete asynchronously.
118
+ - `201 Created` : Operation was started and will complete asynchronously. It may return `Nexus-Link` headers to associate
119
+ resources to this operation.
115
120
116
121
**Headers**:
117
122
@@ -266,6 +271,13 @@ following predefined error codes.
266
271
267
272
# # General Purpose Headers
268
273
274
+ # ## `Nexus-Link`
275
+
276
+ The `Nexus-Link` header field provides a means for serializing one or more links in HTTP headers. This header is encoded
277
+ the same way as the HTTP header `Link` described [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link).
278
+
279
+ Handlers and callers can specify links in different Nexus requests to associate an operation with arbitrary resources.
280
+
269
281
# ## `Request-Timeout`
270
282
271
283
Callers may specify the `Request-Timeout` header on all APIs to inform the handler how long they're willing to wait for
You can’t perform that action at this time.
0 commit comments