Document help_center default and locales fields in Preview spec

[ib-skoric]

Why?

PR intercom/intercom#508490 added default and locales fields to the Help Center API response on the Preview version, but the OpenAPI spec did not document them. Without this update, SDK consumers on Preview would miss the fields in generated types and the API docs would be inaccurate.

How?

Added default (boolean) and locales (array of strings) properties to the help_center schema in the Preview spec and updated the inline response example for the single help center GET endpoint.

Decisions

• Updated only descriptions/0/api.intercom.io.yaml since the fields are Preview-version only
• Made manual edits instead of using generate-openapi-from-pr because the change is small and precisely scoped
• Modeled default after the existing website_turned_on boolean property and locales as an array of string locale codes, matching test data (["en", "fr"])
• Only updated the single-help-center GET example; the list endpoint example shows an empty data array, so no example change was needed there

Review Guidance

Dimension	Score	Reasoning
Complexity	░░░░░░░░░░ 0.4	Why Two property additions to a single schema plus one example update — no cross-cutting impact.
Unintuitiveness	░░░░░░░░░░ 0.3	Why Diff matches the PR description and plan verbatim with no hidden behavior.
Risk Surface	░░░░░░░░░░ 0.5	Why Documentation-only YAML change in the Preview spec; no runtime or sensitive paths touched.

Attention: Routine review — Tiny, precisely-scoped OpenAPI doc addition matching the plan exactly; nothing non-obvious to flag.

_{🧪 This AI-generated review guidance is experimental. Share feedback}

• Relates to https://github.com/intercom/intercom/pull/508490

Implementation Plan

Worker Implementation Plan

Plan: Add default and locales fields to Help Center schema (Preview)

Context

PR intercom/intercom#508490 added two new fields to the Help Center API response, gated behind the Preview/Unstable API version:

• default (boolean) — whether the help center is the workspace's default (model.is_default)
• locales (array of string locale codes) — the help center's selected languages (model.selected_locale_ids), e.g. ["en", "fr"]

The version change class AddDefaultAndLocalesToHelpCenterResponse strips these fields for stable API clients. Only the Preview spec (descriptions/0/api.intercom.io.yaml) needs updating.

Changes Required

1. Add properties to help_center schema (line ~26439)

File: descriptions/0/api.intercom.io.yaml
Location: After the custom_domain property (ends at line 26439), before the help_center_list schema (line 26440).

Add two new properties:

        default:
          type: boolean
          description: Whether this help center is the default for the workspace.
          example: false
        locales:
          type: array
          description: The locales in which the help center is available.
          items:
            type: string
          example:
          - en
          - fr

Conventions followed:

• Boolean fields: same pattern as website_turned_on (line 26422) — type: boolean, description, example
• Array of strings: type: array with items: type: string and inline example list
• Locale codes are strings (confirmed from test data: ["en", "fr"])

2. Update inline response example for GET /help_center/help_centers/{id} (line ~2782)

File: descriptions/0/api.intercom.io.yaml
Location: After custom_domain: help.mycompany.com (line 2782) in the "Collection found" example.

Add:

                    default: false
                    locales:
                    - en

3. No change needed for GET /help_center/help_centers (list endpoint)

The list endpoint example at line 2832-2834 shows data: [] (empty array). No individual help center example to update.

4. No other endpoints reference the help_center schema

Confirmed: only two $ref references to help_center — the GET single endpoint (line 2784) and help_center_list.items (line 26457).

Verification

1. Run fern check to validate the spec:

   export PATH="$HOME/.nvm/versions/node/v24.10.0/bin:$PATH"
   npx fern check

2. Visually confirm the new properties appear in the help_center schema
3. Visually confirm the response example includes the new fields

Implementation Notes

• Do NOT use the generate-openapi-from-pr skill — the changes are small and precisely scoped; manual edits are faster and more controlled.
• Ensure proper YAML indentation (8 spaces for properties under properties:, 10 spaces for sub-keys).
• Follow existing conventions: no nullable for required fields, string examples unquoted when simple identifiers.

Parthas Order (task/issue)

Add Help Center default and locales fields to OpenAPI spec

Problem

PR intercom/intercom#508490 added default (boolean) and locales (array of locale IDs) fields to the Help Center API response, gated behind the Preview API version via AddDefaultAndLocalesToHelpCenterResponse. The intercom-openapi spec does not yet document these fields — the help_center schema in descriptions/0/api.intercom.io.yaml is missing them.

Why This Matters

Without the spec update, SDK consumers on the Preview version will not see these fields in generated types, and the API documentation will be inaccurate.

Goal

The Preview OpenAPI spec documents the default and locales fields on the help_center schema, with correct types, descriptions, and examples.

Context

• Source PR: https://github.com/intercom/intercom/pull/508490
• These fields are Preview-version only — only descriptions/0/api.intercom.io.yaml needs updating
• The repo has a generate-openapi-from-pr skill — use it with the source PR URL
• The help_center schema is at approximately line 26391 of the preview spec

Acceptance Criteria

• help_center schema in descriptions/0/api.intercom.io.yaml includes default (boolean) and locales (array) properties
• Inline response examples for Help Center endpoints include the new fields
• fern check passes

_{Generated with Claude Code, zen coded with Parthas}