ZIP-558: updates the spec file to match the current SDK state#3
Merged
ericlakich merged 1 commit intomainfrom Jan 22, 2026
Merged
ZIP-558: updates the spec file to match the current SDK state#3ericlakich merged 1 commit intomainfrom
ericlakich merged 1 commit intomainfrom
Conversation
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.
This pull request makes significant improvements to the API specification in
docs/spec.yamlfor the v6.0 models, focusing on better alignment with real API responses, improved field naming (including camelCase aliasing), and enhanced documentation for SDK developers. It also adds actual API response examples and new CI/CD quality requirements to ensure code quality and correctness.Key changes:
Data Model & Field Mapping Improvements
api_fieldaliases for camelCase mapping, clarified that some fields are strings (not enums), and improved field descriptions and examples for clarity. [1] [2] [3] [4] [5]origin_destinationmodel withsourcing_rulesto match the real API structure and field naming, including all necessary field aliasing and documentation. [1] [2]Model Structure & Response Accuracy
V60Metadatato nest response info under a newresponseobject (V60ResponseInfo), accurately reflecting actual API responses.V60DisplayRatemodel and updatedV60TaxSummaryto include adisplay_ratesarray, matching the breakdowns in real responses.Documentation & Testing
CI/CD & Code Quality
quality_requirementssection specifying minimum code coverage, type checking, formatting, linting, and Pydantic usage requirements, including sample configuration and code.