Skip to content

feat(catalogs): document address and fiscal catalog endpoints - #320

Open
javorosas wants to merge 6 commits into
mainfrom
docs/address-fiscal-catalogs
Open

javorosas wants to merge 6 commits into
mainfrom
docs/address-fiscal-catalogs

Conversation

@javorosas

@javorosas javorosas commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Document country, tax-regime, CFDI-use, and Mexican postal-code searches plus postal-code details with neighborhoods, with authentication requirements in both OpenAPI locales.

Postal search uses numeric queries as full codes/prefixes and textual queries as neighborhood, locality/city, municipality, or state names. Text ignores case and diacritics, exact names rank ahead of partial matches, and each postal code appears once. The state filter applies in both modes. Each postal row includes all neighborhoods as {key, description} entries, and postal detail uses the same ZipCode shape; pages, forward/backward cursors, and capped textual totals are documented.

Match the optional-query contract for Carta Porte, Comercio Exterior, and payroll searches; empty specialized queries return no matches.

Validation: both OpenAPI locale checks pass for 132 operations, including references, generated type contracts, and structural parity.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The five new catalog operations lack security requirements in both locale specifications, allowing generated clients to omit required bearer tokens and receive 401 responses.

1 open issue
What changed in this PR

Expands the bilingual OpenAPI reference with address and fiscal catalog endpoints for API consumers.

Changes:

  • Adds country, tax-regime, CFDI-use, and Mexican postal-code searches, plus postal-code details with neighborhoods.
  • Defines shared response models and postal-code page/cursor pagination.
  • Makes q optional on 13 existing Carta Porte catalog searches in both locales.
File Description
website/​openapi_v2.yaml Adds Spanish endpoint documentation and response schemas; updates query requirements.
website/​openapi_v2.en.yaml Mirrors the endpoint, schema, and query-requirement changes in English.

Review effort: Balanced

Comment thread website/openapi_v2.yaml Resolved

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants