Path parameters

• id string Required

  UUID of an existing diff from which to fetch diff details

Query parameters

• formats array[string]

  A list of formats to render in the response. Possible values are text, markdown, html or json. If not provided defaults to render both text and markdown formats.

Responses

• 200 application/json

  Diff successfully retrieved

  Hide response attributes Show response attributes object

  • id string

    Unique id of your diff

  • title string

    The title of the last parsed definition

  • public_url string

    The public URL of your diff

  • breaking boolean

    Identifies if the diff includes breaking changes

  • details array[object]

    Details of each change as a list of diff items. Present only if json format has been requested

    Hide details attributes Show details attributes object

    • id string

      The identifier of the diff change

    • name string

      The human name of diff change

    • status string

      Values are added, modified, or removed.

    • type string

      The object type of the diff change

    • breaking boolean

      Identifies if the item is a breaking change

    • previous object

      Object attributes values, before change. Possible attributes depend on the object type ('endpoint', 'body', 'response'…)

    • current object

      Object attributes values, after change. Possible attributes depend on the object type ('property', 'operation', 'message'…)

    • breaking_details object

      Represents breaking change reasons, used to give more context about this question: why is this change breaking?

      Hide breaking_details attributes Show breaking_details attributes

      • message_key string

        This property is used to generate the human message about breaking change reason

      • breaking_attributes array[string]

        When diff status is modified, this property is an array including every modified attribute responsible of the breaking change.

    • children array[object]

      A list of children item changes
  • previous_version_url string

    URL of previous version specification, in JSON format

  • current_version_url string

    URL of current version specification, in JSON format

  • markdown string

    The comparaison diff summary in markdown format. Present only if markdown format has been requested.

  • html string

    The comparaison diff summary in HTML format. Present only if html format has been requested.

  • text string

    The comparaison diff summary in plain text format. Present only if text format has been requested.

• 202

  Diff is still being processed. Please try again later

• 404

  Diff not found