Version
Stay organized with collections
Save and categorize content based on your preferences.
Version object contains the major version of the API. Versions of the same major version are guaranteed to be compatible. The integrator must support all requests for the same major version.
| JSON representation |
{
"major": integer
} |
| Fields |
major |
integer
REQUIRED: Major version. This is marked for compatibility requests with different versions are not guaranteed to be compatible.
|
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThe API uses a version object containing the major version to ensure compatibility.\u003c/p\u003e\n"],["\u003cp\u003eIntegrators must support all requests for the same major version, ensuring consistency across implementations.\u003c/p\u003e\n"],["\u003cp\u003eMajor version differences indicate potential incompatibility, requiring careful handling by integrators.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of the version object is simple, consisting of a single "major" field containing an integer value.\u003c/p\u003e\n"]]],["The core content describes an API versioning system using a \"major\" version number. This integer signifies compatibility; different major versions are not guaranteed to be compatible, while the same major version ensures compatibility. Integrators are required to support all requests within the same major version. The version is represented in JSON as an object with a single required field: `major`, which is an integer.\n"],null,["# Version\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nVersion object contains the major version of the API. Versions of the same major version are guaranteed to be compatible. The integrator must support all requests for the same major version.\n\n| JSON representation |\n|------------------------------|\n| ``` { \"major\": integer } ``` |\n\n| Fields ||\n|---------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `major` | `integer` **REQUIRED**: Major version. This is marked for compatibility requests with different versions are not guaranteed to be compatible. |"]]