Definition

JSON Schema definition for a parameter or output

Application DependenciesCloud NativeIntegrationResearchSpecificationsWorkload Specifications

Properties

Name	Type	Description
$id	string
$schema	string
$ref	string
$comment	string
title	string
description	string
type	object
default	True
examples	array
enum	array
const	True
format	string
pattern	string
minLength	integer
maxLength	integer
minimum	integer
maximum	integer
exclusiveMinimum	integer
exclusiveMaximum	integer
multipleOf	integer
minItems	integer
maxItems	integer
uniqueItems	boolean
minProperties	integer
maxProperties	integer
required	array
properties	object
additionalProperties	object
items	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Definition",
  "title": "Definition",
  "type": [
    "object",
    "boolean"
  ],
  "description": "JSON Schema definition for a parameter or output",
  "properties": {
    "$id": {
      "type": "string",
      "format": "uri-reference"
    },
    "$schema": {
      "type": "string",
      "format": "uri"
    },
    "$ref": {
      "type": "string",
      "format": "uri-reference"
    },
    "$comment": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/SimpleType"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/SimpleType"
          },
          "minItems": 1,
          "uniqueItems": true
        }
      ]
    },
    "default": true,
    "examples": {
      "type": "array"
    },
    "enum": {
      "type": "array",
      "minItems": 1,
      "uniqueItems": true
    },
    "const": true,
    "format": {
      "type": "string"
    },
    "pattern": {
      "type": "string",
      "format": "regex"
    },
    "minLength": {
      "type": "integer",
      "minimum": 0
    },
    "maxLength": {
      "type": "integer",
      "minimum": 0
    },
    "minimum": {
      "type": "integer"
    },
    "maximum": {
      "type": "integer"
    },
    "exclusiveMinimum": {
      "type": "integer"
    },
    "exclusiveMaximum": {
      "type": "integer"
    },
    "multipleOf": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "minItems": {
      "type": "integer",
      "minimum": 0
    },
    "maxItems": {
      "type": "integer",
      "minimum": 0
    },
    "uniqueItems": {
      "type": "boolean",
      "default": false
    },
    "minProperties": {
      "type": "integer",
      "minimum": 0
    },
    "maxProperties": {
      "type": "integer",
      "minimum": 0
    },
    "required": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "properties": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/Definition"
      }
    },
    "additionalProperties": {
      "oneOf": [
        {
          "type": "boolean"
        },
        {
          "$ref": "#/components/schemas/Definition"
        }
      ]
    },
    "items": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/Definition"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Definition"
          },
          "minItems": 1
        }
      ]
    }
  }
}