Skip to content

SPTECH-514: Document partner_business_category field on Tour schema - #122

Merged
arihantgupta-28 merged 1 commit into
mainfrom
SPTECH-514/document-partner-business-category-tours
Aug 13, 2026
Merged

SPTECH-514: Document partner_business_category field on Tour schema#122
arihantgupta-28 merged 1 commit into
mainfrom
SPTECH-514/document-partner-business-category-tours

Conversation

@arihantgupta-28

@arihantgupta-28 arihantgupta-28 commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

What & why

SPTECH-514 · https://getyourguide.slack.com/archives/C0AN9US9PFC/p1786097625095249

GET /tours and GET /tours/{tour_id} return a partner_business_category field (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_category on the Tour schema with the current values and an example, placed directly after activity_type (#121) to match the internal spec's ordering.

Notes on modelling

  • Documented as a plain string, not an enum. The category taxonomy is open — an enum would falsely imply a fixed set and could break partner-generated clients when a new category is introduced.
  • The 13 listed values are verified against production data (level1 of the tour business-category taxonomy) and match the category list used in partner-domain's commission-rate configuration.
  • Other is both a real category and the fallback the API returns when a tour has no category assigned yet.
  • The field is optional: it is only populated when the search lookup returns a hit, so it can be absent (the generated client models it as nullable).

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 partnerBusinessCategory?: string.

🤖 Generated with Claude Code

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>

Copilot AI 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.

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_category to the Tour schema as an optional string.
  • 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.

@arihantgupta-28
arihantgupta-28 merged commit 7966963 into main Aug 13, 2026
4 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