Skip to content

docs(location): document required REST headers #784

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

Open
sakinaroufid wants to merge 2 commits into
base: main
Choose a base branch
from
+14 −0
Open

docs(location): document required REST headers #784

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
617826d
docs(location): document required REST headers
sakinaroufid Aug 29, 2026
61cb16d
Merge branch 'main' into docs/location-rest-headers
sakinaroufid Sep 4, 2026
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
14 changes: 14 additions & 0 deletions docs/specification/common/location/rest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,20 @@ Maps to the [Location Lookup](lookup.md) capability. See the
}
```

## HTTP Headers

The following headers are defined for the HTTP binding and apply to all
operations unless otherwise noted.

{{ header_fields('search_locations', 'common/rest.openapi.json') }}

### Specific Header Requirements

* **UCP-Agent**: All requests **MUST** include the `UCP-Agent` header

@proshoumma proshoumma Sep 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey @sakinaroufid 👋🏼 , I opened #819 which takes on the cross-binding cleanup you flagged here. Instead of copying the UCP-Agent again, it adds a header_requirements macro as a single source and switches catalog/cart/checkout/order to it (also fixes order's drifted wording).

If it's easier to fold in here, you can cherry-pick the commit onto this branch. Then this section becomes just:

### Specific Header Requirements

{{ header_requirements('ucp_agent') }}

Otherwise, PRs can adopt based on whichever lands first.

containing the platform profile URI using Dictionary Structured Field syntax
([RFC 8941](https://datatracker.ietf.org/doc/html/rfc8941){target="_blank"}).
Format: `profile="https://platform.example/profile"`.

## Error Handling

UCP uses a two-layer error model separating transport-level errors from business outcomes.
Expand Down
Loading