Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-011 What does the status response's version hold, when the text says "Version of the Deal API in use" and the sellerstatus codes changed twice after the 1.0 tag while it stayed 1.0?

Gap Cited on main and at the tag 1.0-202602.

What the schemas do

The version string as the receiving system writes it, such as 1.0, compared exactly and never parsed.

Options

  • as-written Chosen

    The version string as the receiving system writes it, such as 1.0, compared exactly and never parsed.

  • semver

    A semantic version, major.minor.patch, which a receiver can order.

Why

The text gives no form, and the published version stays "1.0" across the three changes since the tag, two of which renumbered sellerstatus. A version string compared as written is all a receiver can rely on, and a build names its lock's commit for the rest.

What we ask the specification to state

Version the errata: "1.0" now names texts whose sellerstatus codes differ. A patch number, or a date, in version would let a receiver know which codes the other side reads.

The specification lines it rests on

Each line is quoted as the record pins it. Expand an item to read the quote.

main

  • Object: BuyerSeat, the version row L161 at 3028ddc
    version | string, required | Version of the Deal API in use

Tag 1.0-202602

  • Object: BuyerSeat, the version row L161 at 938a5d1
    version | string, required | Version of the Deal API in use

What it shapes

main: BuyerSeat.version

Tag 1.0-202602: BuyerSeat.version

The record's YAML file