Codat · Schema

Push option

Unified-API

Properties

Name	Type	Description
type	object
displayName	object
description	object
required	object
properties	object
options	array
validation	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PushOption",
  "title": "Push option",
  "x-internal": true,
  "required": [
    "displayName",
    "required",
    "type"
  ],
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/PushOption/definitions/pushOptionType"
    },
    "displayName": {
      "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName"
    },
    "description": {
      "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description"
    },
    "required": {
      "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required"
    },
    "properties": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty"
      },
      "nullable": true
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PushOption/definitions/pushOptionChoice"
      },
      "nullable": true
    },
    "validation": {
      "$ref": "#/components/schemas/PushOption/definitions/pushValidationInfo",
      "nullable": true
    }
  },
  "definitions": {
    "pushOptionProperty": {
      "title": "Push Option Property",
      "required": [
        "description",
        "displayName",
        "required",
        "type"
      ],
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/components/schemas/PushOption/definitions/pushOptionType"
        },
        "displayName": {
          "minLength": 1,
          "type": "string",
          "description": "The property's display name."
        },
        "description": {
          "type": "string",
          "description": "A description of the property."
        },
        "required": {
          "type": "boolean",
          "description": "The property is required if `True`."
        },
        "properties": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty"
          },
          "nullable": true
        },
        "options": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PushOption/definitions/pushOptionChoice"
          },
          "nullable": true
        },
        "validation": {
          "$ref": "#/components/schemas/PushOption/definitions/pushValidationInfo"
        }
      }
    },
    "pushValidationInfo": {
      "title": "Push validation info",
      "type": "object",
      "properties": {
        "warnings": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PushOption/definitions/pushFieldValidation"
          },
          "nullable": true
        },
        "information": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PushOption/definitions/pushFieldValidation"
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    },
    "pushFieldValidation": {
      "title": "Push field validation",
      "required": [
        "details"
      ],
      "type": "object",
      "properties": {
        "field": {
          "type": "string",
          "description": "Field name that resulted in the validation issue."
        },
        "details": {
          "minLength": 1,
          "type": "string",
          "description": "Details on the validation issue."
        },
        "ref": {
          "type": "string",
          "format": "uri",
          "nullable": true,
          "description": "Unique reference identifier for the validation issue."
        }
      },
      "additionalProperties": false
    },
    "pushOptionType": {
      "title": "Option Type",
      "description": "The option type.",
      "enum": [
        "Array",
        "Object",
        "String",
        "Number",
        "Boolean",
        "DateTime",
        "File",
        "MultiPart"
      ],
      "type": "string"
    },
    "pushOptionChoice": {
      "title": "Push Option Choice",
      "type": "object",
      "properties": {
        "value": {
          "type": "string",
          "minLength": 1,
          "description": "Allowed value for field."
        },
        "type": {
          "$ref": "#/components/schemas/PushOption/definitions/pushOptionType"
        },
        "displayName": {
          "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/displayName"
        },
        "description": {
          "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description"
        },
        "required": {
          "$ref": "#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/codat-pushoption"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.