Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-029 What does sellerstatus mean when absent, when the cell says both "default 0" and "recommended"?

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

What the schemas do

An absent sellerstatus is 0, deal is active; recommended means a sender should send it, which a payload can't be checked for.

Options

  • default-0 Chosen

    An absent sellerstatus is 0, deal is active; recommended means a sender should send it, which a payload can't be checked for.

  • no-default

    No default: recommended means a sender should send it.

Why

The cell states both, and they don't conflict: a sender should send sellerstatus, and a receiver reads an absent one as 0, active. The schema states the default and leaves the field optional.

What we ask the specification to state

None needed: the default settles it.

The specification lines it rests on

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

main

  • Object: Deal, the sellerstatus row L88 at 3028ddc
    sellerstatus | int, default 0, recommended | Status of the deal in the sellers system where: 0 = deal is active 1 = deal is paused 2 = deal is pending 3 = deal is complete (ie. selling scomplete (ie. selling system shows deal has completed) 4 = deal is archived (cannot be active again)

Tag 1.0-202602

  • Object: Deal, the sellerstatus row L88 at 938a5d1
    sellerstatus | int, default 0, recommended | Status of the deal in the sellers system where: 0 = deal is active 1 = deal is paused 2 = deal is pending 4 = deal is complete (ie. selling scomplete (ie. selling system shows deal has completed) 4 = deal is archived (cannot be active again)

What it shapes

main: Deal.sellerstatus

Tag 1.0-202602: Deal.sellerstatus

The record's YAML file