Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Nexus-Operation-Id and Nexus-Link headers to callback definition #12

Merged
merged 6 commits into from
Nov 19, 2024
+5 −1
Merged

Add Nexus-Operation-Id and Nexus-Link headers to callback definition #12

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
de306d5
Add Nexus-Operation-Id and Nexus-Link headers to callback definition
pdoerner Nov 15, 2024
72fd448
Add Nexus-Operation-Start-Time header
pdoerner Nov 15, 2024
a6c61d8
remove formatting
pdoerner Nov 15, 2024
da7f7c2
format
pdoerner Nov 15, 2024
705296b
format
pdoerner Nov 15, 2024
263385d
link to format
pdoerner Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion SPEC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ timeout for a single HTTP request. Format of this header value is number + unit,
milliseconds, `s` for seconds, and `m` for minutes.

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)
links as metadata to underlying resources to provide end-to-end observability. See the [`Nexus-Link`](#nexus-link)
section for more information.

#### Request Body
Expand Down Expand Up @@ -306,6 +306,10 @@ For invoking a callback URL:
- Issue a POST request to the caller-provided URL.
- Include any callback headers supplied in the originating StartOperation request, stripping away the `Nexus-Callback-`
prefix.
- Include the `Nexus-Operation-Id` header, `Nexus-Operation-Start-Time` and any `Nexus-Link` headers for resources
associated with this operation to support completing asynchronous operations before the response to StartOperation is
received. `Nexus-Operation-Start-Time` should be in a valid HTTP/1.1 format. If is omitted, the time the completion is
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you clarify and possibly link here? https://www.rfc-editor.org/rfc/rfc5322.html#section-3.3

received will be used as operation start time.
- Include the `Nexus-Operation-State` header.
- If state is `succeeded`, deliver non-empty results in the body with corresponding `Content-*` headers.
- If state is `failed` or `canceled`, content type should be `application/json` and the body must have a serialized
Expand Down
Loading