Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
🟡 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
qoptional 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
This branch has not been deployed
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.

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.