Skip to content

Document activity_type field on Tour schema - #121

Merged
pstarritt-gyg merged 1 commit into
mainfrom
docs/document-activity-type-tours
Aug 13, 2026
Merged

Document activity_type field on Tour schema#121
pstarritt-gyg merged 1 commit into
mainfrom
docs/document-activity-type-tours

Conversation

@pstarritt-gyg

@pstarritt-gyg pstarritt-gyg commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

What & why

https://getyourguide.slack.com/archives/C0AN9US9PFC/p1786613300301489

An APAC partner testing GET /tours hit an activity_type field in the response (values seen: privateTour, multiDayTrip) that isn't documented anywhere in the public Partner API spec. The field has been returned for a while — it's passed through from the upstream Search service — but was never published, so partners can't build against it with confidence.

This PR documents activity_type on the Tour schema with the common values and an example.

Notes on modelling

  • Documented as a plain string, not an enum. The value set is not closed upstream: even the Search source-of-truth spec (search.master.delivery) models the activity type key as a free string, and new values can appear over time. An enum would falsely imply a fixed set and could break partner-generated clients when a new value shows up.
  • The listed values are the currently-known set (derived from Search's Badge.type bestseller-<activityType> entries, plus transfer observed in Search data). The description explicitly tells integrators to tolerate unrecognised values.
  • example: entryTicket matches the example already used for this field in the internal service spec.

Verification

Ran the same client generation CI performs:
npx @openapitools/openapi-generator-cli generate -i spec/api.yaml -g typescript-node -o /tmp/... — succeeds, and the generated Tour model now includes activityType?: string.

🤖 Generated with Claude Code

The GET /tours response returns an activity_type field (passed through from
the Search service), but it was never documented in the public Partner API
spec. Partners integrating against /tours were seeing undocumented values
such as privateTour and multiDayTrip.

Add activity_type to the Tour schema as a descriptive string with the common
values documented and an example. It is intentionally NOT modelled as an enum:
the value set is not closed upstream, so an enum would falsely imply a fixed
set and could break partner codegen when new values are introduced.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@clue-gyg clue-gyg left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Auto-approved as trivial change

Documentation-only change adding a description for an already-existing (but previously undocumented) field in the OpenAPI spec; 20 lines added, no deletions, no behavioral or schema-contract change (it just documents a field partners already receive), well under the size limit.

@pstarritt-gyg
pstarritt-gyg merged commit 109909d into main Aug 13, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants