Skip to content

SPTECH-562: Document GET /{version}/availabilities/status/changes (availability delta feed) - #123

Merged
pstarritt-gyg merged 8 commits into
mainfrom
sptech-562-availability-status-changes
Sep 29, 2026
Merged

pstarritt-gyg merged 8 commits into
mainfrom
sptech-562-availability-status-changes

Conversation

@pstarritt-gyg

@pstarritt-gyg pstarritt-gyg commented Sep 2, 2026 •

Copy link
Copy Markdown
Contributor

What

Documents the new cursor-paginated availability delta endpoint:

GET /{version}/availabilities/status/changes?cursor=<opaque>&limit=<1..5000>

This should only be merged when we want to expose it to all partners.

Returns slots whose bookability changed (sold out / back in stock) since the given cursor, ordered by feed position. _metadata is a feed-specific CursorPageMetadata — start_cursor, end_cursor, page_size, has_next_page. Each delta carries its own opaque base64 cursor, plus tour_id, option_id, slot date_time (UTC), vacancies (0 = sold out; null = in stock, exact count unknown), and update_time (UTC, microsecond precision, for last-write-wins application — matches the update_time of the availability v4 export). Partners page with end_cursor while has_next_page is true.

The endpoint is limited to master-bill partners; a token without the master-bill privilege gets 403.

Implementation PR (internal): getyourguide/public-partner-api#2038. Field rename to update_time synced from getyourguide/public-partner-api#2098 so this public spec matches the current API structure. The endpoint ships dark (empty pages) until the data path and the dedicated bulk instances land, so docs publication should be coordinated with the rollout.

🤖 Generated with Claude Code

Cursor-paginated feed of sold-out / back-in-stock availability changes.
Mirrors getyourguide/public-partner-api#2038.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@pstarritt-gyg
pstarritt-gyg requested a review from a team as a code owner September 2, 2026 10:56
@gyg-dev-cluster-tool gyg-dev-cluster-tool Bot changed the title Document GET /{version}/availabilities/status/changes (availability delta feed) SPTECH-562: Document GET /{version}/availabilities/status/changes (availability delta feed) Sep 2, 2026
@clue-gyg clue-gyg removed the risk:low label Sep 2, 2026
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@pstarritt-gyg
pstarritt-gyg removed the request for review from FlaviaC-gyg September 2, 2026 11:04
@pstarritt-gyg
pstarritt-gyg marked this pull request as draft September 2, 2026 11:04
pstarritt-gyg and others added 4 commits September 2, 2026 13:08
Each delta carries its cursor; page returns first_cursor, last_cursor
and page_size. state removed (derive from vacancies). limit 1..5000,
default 1000.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
_metadata is a feed-specific CursorPageMetadata (first_cursor,
last_cursor, page_size, has_next_page) instead of the shared MetaData;
cursors are opaque base64 strings, one per delta.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The 4XX response here lives at components/responses/4XX (the internal
repo names it ErrorResponse), which broke spec validation in CI.
CursorPageMetadata moves to the shared metadata.yaml with
element-generic wording for reuse by future cursor APIs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@pstarritt-gyg
pstarritt-gyg marked this pull request as ready for review September 2, 2026 12:38
Comment thread spec/paths/availabilities.yaml Outdated
Comment thread spec/paths/availabilities.yaml Outdated
pstarritt-gyg and others added 2 commits September 25, 2026 16:05
…ill note

Match the internal public-partner-api spec:
- Rename delta field update_timestamp -> update_time (required list + property)
  to match the availability v4 export; document last-write-wins precedence.
- Document the master-bill restriction (403 without the privilege) on the
  operation description.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replace the old placeholder cursor examples with the realistic
`v1:<timestamp>,<id>` base64 tokens used in the internal public-partner-api
spec (request/delta cursor, and CursorPageMetadata start_cursor/end_cursor).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@pstarritt-gyg
pstarritt-gyg merged commit 397d39b into main Sep 29, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants