Add Nexus-Link header spec #8
Conversation
rodrigozhou
force-pushed
the
rodrigozhou/links
branch
2 times, most recently
from
e5c2e4b to
4d0ed52
Compare
SPEC.md
Outdated
| @@ -72,6 +72,25 @@ properties: | |||
| Describes the current state of an operation. | |||
| ``` | |||
|
|
|||
| ### Links | |||
There was a problem hiding this comment.
I wouldn't put this in the schema section. These objects are never serialized in JSON form.
I would add another section to the doc called Links after Predefined Handler Errors
There was a problem hiding this comment.
In the new section you can borrow the text from MDN:
The Nexus-Link header field provides a means for serializing one or more links in HTTP headers. This header is encoded the same way as the HTTP header Link described
here.
Handlers and callers can specify links in different Nexus requests to associate an operation with arbitrary resources.
SPEC.md
Outdated
| - `201 Created`: Operation was started and will complete asynchronously. It may return `Nexus-Link` headers that | ||
| contain information about the operations done by the handler. |
There was a problem hiding this comment.
| - `201 Created`: Operation was started and will complete asynchronously. It may return `Nexus-Link` headers that | |
| contain information about the operations done by the handler. | |
| - `201 Created`: Operation was started and will complete asynchronously. It may return `Nexus-Link` headers to | |
| associate resources to this operation. |
SPEC.md
Outdated
| @@ -97,6 +116,10 @@ Headers that start with the `Nexus-Callback-` prefix are expected to be attached | |||
| the handler. The callback request must strip away the `Nexus-Callback-` prefix. E.g if a Start Operation request | |||
| includes a `Nexus-Callback-Token: some-token` header, the callback request would include a `Token: some-token` header. | |||
|
|
|||
| The header `Nexus-Link` contains a `Link` object encoded the same way as the HTTP header `Link` described | |||
There was a problem hiding this comment.
You can shorten this and link to the Links header.
rodrigozhou
force-pushed
the
rodrigozhou/links
branch
from
4d0ed52 to
ab89853
Compare
bergundy
force-pushed
the
rodrigozhou/links
branch
from
ab89853 to
3e440a1
Compare
There was a problem hiding this comment.
@rodrigozhou I ended up editing this myself. It made more sense than to keep doing this back and forth.
Add
Linkto api spec.