Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-015 What does a deal do with inventory unless dinventory is 1, when the text says it "should only be included when the deal is for a static set of sites or applications (dinventory=1)"?

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

What the schemas do

A rule, at the should level: a deal that sends inventory with dinventory other than 1 gets a warning.

Options

  • warning-rule Chosen

    A rule, at the should level: a deal that sends inventory with dinventory other than 1 gets a warning.

  • schema

    The schema rejects inventory unless dinventory is 1.

Why

The sentence says should, so a deal that breaks it is still valid, and the rule reports it as a warning. It is stated twice, in the Deal table and in the guidance; the table's sentence carries the rule, and the guidance's restates it.

What we ask the specification to state

None needed beyond the level: say "should" or "must" in capitals, and state it once.

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, a requirement L99 at 3028ddc
    This object should only be included when the deal is for a static set of sites or applications (dinventory=1).
  • Inventory Object, a requirement L241 at 3028ddc
    This object should only be included when the deal is for a static set of sites or applications (dinventory=1).
  • Object: Deal, the inventory row L99 at 3028ddc
    inventory | object | Information about the inventory included in the deal. This object should only be included when the deal is for a static set of sites or applications (dinventory=1). See Object: Inventory for additional detail
  • Object: Deal, the dinventory row L97 at 3028ddc
    dinventory | int | Indicates if the inventory for the deal is dynamic, meaning sites or applications included in the deal may update after the deal is live where: 0 = undisclosed 1 = inventory will NOT update once the deal goes live 2 = inventory where this deal may run is updated dynamically. See implementation guidance for additional detail

Tag 1.0-202602

  • Object: Deal, a requirement L99 at 938a5d1
    This object should only be included when the deal is for a static set of sites or applications (dinventory=1).
  • Inventory Object, a requirement L241 at 938a5d1
    This object should only be included when the deal is for a static set of sites or applications (dinventory=1).
  • Object: Deal, the inventory row L99 at 938a5d1
    inventory | object | Information about the inventory included in the deal. This object should only be included when the deal is for a static set of sites or applications (dinventory=1). See Object: Inventory for additional detail
  • Object: Deal, the dinventory row L97 at 938a5d1
    dinventory | int | Indicates if the inventory for the deal is dynamic, meaning sites or applications included in the deal may update after the deal is live where: 0 = undisclosed 1 = inventory will NOT update once the deal goes live 2 = inventory where this deal may run is updated dynamically. See implementation guidance for additional detail

What it shapes

main: Deal.dinventory, Deal.inventory

Tag 1.0-202602: Deal.dinventory, Deal.inventory

The record's YAML file