Deals API 1.0 JSON Schema Unofficial

Decision records ·

D-025 Which payloads does the Deals API define, when it states no paths, request body, responses, or authorization?

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

What the schemas do

Two: the deal the origin system pushes, and the buyer seat's status the receiving system returns; the request that asks for a status, its paths, and its authorization are left out.

Options

  • two-documents Chosen

    Two: the deal the origin system pushes, and the buyer seat's status the receiving system returns; the request that asks for a status, its paths, and its authorization are left out.

  • openapi

    An HTTP description of both endpoints, with paths and authorization, which the text would have to state.

Why

The text defines the objects of two exchanges, the deal the origin system pushes and the status the receiving system returns, and says nothing of the request for a status, the paths, the responses' codes, or authorization, so only the two payloads are defined.

What we ask the specification to state

Specify the endpoints: the paths, the request that asks for a deal's status, the responses and their codes, and how each side authorizes the other.

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 id row L85 at 3028ddc
    id | string; required | A unique identifier for the direct deal in origin's namespace.
  • Object: BuyerSeat, the version row L161 at 3028ddc
    version | string, required | Version of the Deal API in use

Tag 1.0-202602

  • Object: Deal, the id row L85 at 938a5d1
    id | string; required | A unique identifier for the direct deal in origin's namespace.
  • Object: BuyerSeat, the version row L161 at 938a5d1
    version | string, required | Version of the Deal API in use

What it shapes

main: BuyerSeat.version, Deal.id

Tag 1.0-202602: BuyerSeat.version, Deal.id

The record's YAML file