Skip to content

Commit

Permalink
Restructure
Browse files Browse the repository at this point in the history
  • Loading branch information
bergundy committed Sep 25, 2024
1 parent 30ebcf5 commit 3e440a1
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion SPEC.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,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 `Nexus-Link` header field can be added to associate resources with the start request. A handler may attach these
links as metadata to underlying resources to provide end-to-end observabililty. See the [`Nexus-Link`](#nexus-link)
section for more information.

#### Request Body

The body may contain arbitrary data. Headers should specify content type and encoding.
Expand All @@ -111,7 +115,8 @@ The body may contain arbitrary data. Headers should specify content type and enc

**Body**: Arbitrary data conveying the operation's result. Headers should specify content type and encoding.

- `201 Created`: Operation was started and will complete asynchronously.
- `201 Created`: Operation was started and will complete asynchronously. It may return `Nexus-Link` headers to associate
resources to this operation.

**Headers**:

Expand Down Expand Up @@ -266,6 +271,13 @@ following predefined error codes.

## General Purpose Headers

### `Nexus-Link`

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](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link).

Handlers and callers can specify links in different Nexus requests to associate an operation with arbitrary resources.

### `Request-Timeout`

Callers may specify the `Request-Timeout` header on all APIs to inform the handler how long they're willing to wait for
Expand Down

0 comments on commit 3e440a1

Please sign in to comment.