Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-019 May a buying system's status of a seat send no member at all, when the table requires none?

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

What the schemas do

Yes: every member is optional, as the table writes them, and an empty status is valid though it says nothing.

Options

  • schema-as-written Chosen

    Yes: every member is optional, as the table writes them, and an empty status is valid though it says nothing.

  • min-one

    No: a status names at least one member.

Why

The table states no presence for either member, so the schema rejects nothing the text allows: an empty BuyerStatus is valid. A status with neither the seat nor its status tells the origin system nothing, so the feedback asks for buyerseatid and status to be required.

What we ask the specification to state

Require buyerseatid and status in a buyer's status: a status that names neither says nothing.

The specification lines it rests on

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

main

  • Object: BuyerStatus, the buyerseatid row L173 at 3028ddc
    buyerseatid | string | Seat ID in the buying system that the response refers to
  • Object: BuyerStatus, the status row L174 at 3028ddc
    status | int | Status of the deal in the buying system: 0 = pending approval 1 = buyer has approved (ie. non PG deal is ready for bid requests) 2 = buyer has rejected 3 = ready to serve (ie. deal is in a campaign - ready to receive bid requests, relevant especially for PG deals) 4 = active (i.e. deal is actively serving impressions) 5 = paused 6 = complete (ie. buying system shows deal has completed)

Tag 1.0-202602

  • Object: BuyerStatus, the buyerseatid row L173 at 938a5d1
    buyerseatid | string | Seat ID in the buying system that the response refers to
  • Object: BuyerStatus, the status row L174 at 938a5d1
    status | int | Status of the deal in the buying system: 0 = pending approval 1 = buyer has approved (ie. non PG deal is ready for bid requests) 2 = buyer has rejected 3 = ready to serve (ie. deal is in a campaign - ready to receive bid requests, relevant especially for PG deals) 4 = active (i.e. deal is actively serving impressions) 5 = paused 6 = complete (ie. buying system shows deal has completed)

What it shapes

main: BuyerStatus.buyerseatid, BuyerStatus.status

Tag 1.0-202602: BuyerStatus.buyerseatid, BuyerStatus.status

The record's YAML file