Deals API 1.0 JSON Schema Unofficial

Decision records

Generating the schemas took 33 recorded decisions: 32 gaps, where the text leaves a point open, and 1 proposals, where we propose a change to what the text or its examples settle. Our implementation feedback to the specification's owners will number them; until then they are listed by kind.

Points the text leaves open 32

Where the text leaves a point open, and a decision fills it.

  1. ·D-001Which sentences of the Deals API state a requirement, when the text adopts no RFC 2119 convention and writes its keywords in lowercase?Gap
  2. ·D-002How is a deal's created, startdate, and enddate written, when the text says "UTC timestamp in seconds in ISO-8601"?Gap
  3. ·D-003How does an evergreen deal leave enddate blank?Gap
  4. ·D-005What currency is cur in, when the text calls it the "Bid currency"?Gap
  5. ·D-006Must a deal that sends dealfloor or totalcost also send cur, when cur defaults to "USD"?Gap
  6. ·D-007Which field must a fixed-price deal provide, when the text says "Price attribute must be provided if the deal is a fixed price deal"?Gap
  7. ·D-008Does pricetype default to 2, Second Price Plus, though 0, Dynamic, defers to the bid request's auction type?Gap
  8. ·D-009Which codes may pricetype take beyond 0 to 3, when the text says "Exchange-specific auction types can be defined using values 500 and greater"?Gap
  9. ·D-010What does sellerstatus code 4 mean on the tag 1.0-202602, where it is both "deal is complete" and "deal is archived"?Gap
  10. ·D-011What 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
  11. ·D-012Which field does the guidance's curationfee name, when the Curation table names the fee type curfeetype?Gap
  12. ·D-013Which field does inclinventory.adtype=1,2 name, when inclinventory has no member adtype?Gap
  13. ·D-014Are adtypes' and inclinventory's codes kept as written, though both name audio and inclinventory names an undefined "endemic"?Gap
  14. ·D-015What 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
  15. ·D-016May a deal send both wseat and bseat, when "At most, only one of wseat and bseat should be used in the same request"?Gap
  16. ·D-017What do origin, seller, and curator hold, when the table and the guidance define each twice?Gap
  17. ·D-018How is guar written, and what does a missing guar mean?Gap
  18. ·D-019May a buying system's status of a seat send no member at all, when the table requires none?Gap
  19. ·D-020What does a guaranteed deal do with units and totalcost, which "should be provided" if the deal is guaranteed?Gap
  20. ·D-021Does a Deals API object accept members its table doesn't name, and what is ext?Gap
  21. ·D-022Is desc at most 250 characters, and each sellerids value at most 64, when the text says "strongly recommended" and "Should be limited"?Gap
  22. ·D-023What does a deal's cat mean without cattax, which "defines" the taxonomy?Gap
  23. ·D-024What does an empty or missing list mean in adtypes, countries, inclinventory, sellerids, sitedomains, and appbundles?Gap
  24. ·D-025Which payloads does the Deals API define, when it states no paths, request body, responses, or authorization?Gap
  25. ·D-026Which ID must match which, when a deal's id must match the bid request's deal.id and a status response's id "should always be the same id as deal.id"?Gap
  26. ·D-027Which AdCOM list do devicetype and cattax take, when the text links List: Device Type and List: Category Taxonomies on AdCOM's main?Gap
  27. ·D-028Is adtypes its own list, though it restates OpenRTB 2.6's Bid.mtype codes without citing them?Gap
  28. ·D-029What does sellerstatus mean when absent, when the cell says both "default 0" and "recommended"?Gap
  29. ·D-030What is the Example Scenarios table, the text's only example in a table?Gap
  30. ·D-031What is each of the Deals API's own code lists called?Gap
  31. ·D-032Which of the Deals API's statements bind a party, as obligations no payload shows?Gap
  32. ·D-033What do the schemas keep of a Type cell's wording, when the text writes int and integer, a ; and a , before what follows the type, and recommended?Gap

Changes we propose 1

Where the text or its examples settle a point, and we propose to write it differently.

  1. ·D-004What is a country code in countries, which the text writes as "ISO-3166-3"?Proposal