SPTECH-514: Document partner_business_category field on Tour schema - #122
Merged
arihantgupta-28 merged 1 commit intoAug 13, 2026
Merged
Conversation
The GET /tours and GET /tours/{tour_id} responses return a
partner_business_category field (exposed by PTECH-6404), but it was never
documented in the public Partner API spec. The internal service spec in
public-partner-api already documents it; the public mirror was not updated.
No decision against documenting it is logged in the implementation PRs or
tickets, so the omission was drift, not intent.
Add partner_business_category to the Tour schema as a descriptive string
with the current 13 values and an example. It is intentionally NOT modelled
as an enum: the category taxonomy is open, so an enum would falsely imply a
fixed set and could break partner codegen when new categories are introduced.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the public Partner API OpenAPI spec to document the existing partner_business_category field on the Tour schema, closing documentation drift versus the already-shipped API behavior.
Changes:
- Added
partner_business_categoryto theTourschema as an optionalstring. - Documented that the category set is not closed and listed currently observed values plus an example.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
kingaM
approved these changes
Aug 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
SPTECH-514 · https://getyourguide.slack.com/archives/C0AN9US9PFC/p1786097625095249
GET /toursandGET /tours/{tour_id}return apartner_business_categoryfield (exposed by PTECH-6404 in public-partner-api #1193), but it was never documented in the public Partner API spec. The internal service spec in public-partner-api already documents the field — the public mirror was just never updated.The ticket asked whether the omission was a conscious decision: no decision against documenting it is logged in the implementation PRs (#1193, #1209), commit history, or the PTECH tickets, and it was confirmed in the Slack thread that the docs should be updated. So this closes drift, not a deliberate gap.
This PR documents
partner_business_categoryon theTourschema with the current values and an example, placed directly afteractivity_type(#121) to match the internal spec's ordering.Notes on modelling
string, not anenum. The category taxonomy is open — anenumwould falsely imply a fixed set and could break partner-generated clients when a new category is introduced.level1of the tour business-category taxonomy) and match the category list used in partner-domain's commission-rate configuration.Otheris both a real category and the fallback the API returns when a tour has no category assigned yet.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 generatedTourmodel now includespartnerBusinessCategory?: string.🤖 Generated with Claude Code