Jsonschema-openai examples

Simple model

A simple model with some scalar properties.

{
  "definitions": {
    "Student": {
      "description": "A simple student struct",
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        }
      }
    }
  },
  "root": "Student"
}

Output

{
    "description": "A simple student struct",
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
        },
        "lastName": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        }
    },
    "required": [
        "firstName",
        "lastName",
        "age"
    ],
    "additionalProperties": false
}

Model with inheritance

A student struct which extends from a different struct.

{
  "definitions": {
    "Human": {
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        }
      }
    },
    "Student": {
      "parent": {
        "type": "reference",
        "target": "Human"
      },
      "type": "struct",
      "properties": {
        "studentId": {
          "type": "string"
        }
      }
    }
  },
  "root": "Student"
}

Output

{
    "$defs": {
        "Human": {
            "type": "object",
            "properties": {
                "firstName": {
                    "type": "string"
                },
                "lastName": {
                    "type": "string"
                },
                "age": {
                    "type": "integer"
                }
            },
            "required": [
                "firstName",
                "lastName",
                "age"
            ],
            "additionalProperties": false
        }
    },
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
        },
        "lastName": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        },
        "studentId": {
            "type": "string"
        }
    },
    "required": [
        "firstName",
        "lastName",
        "age",
        "studentId"
    ],
    "additionalProperties": false
}

Model with reference

A student struct which reference a faculty struct.

{
  "definitions": {
    "Student": {
      "description": "A student struct with an assigned faculty",
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        },
        "faculty": {
          "type": "reference",
          "target": "Faculty"
        }
      }
    },
    "Faculty": {
      "type": "struct",
      "properties": {
        "name": {
          "type": "string"
        }
      }
    }
  },
  "root": "Student"
}

Output

{
    "$defs": {
        "Faculty": {
            "type": "object",
            "properties": {
                "name": {
                    "type": "string"
                }
            },
            "required": [
                "name"
            ],
            "additionalProperties": false
        }
    },
    "description": "A student struct with an assigned faculty",
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
        },
        "lastName": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        },
        "faculty": {
            "$ref": "#/$defs/Faculty"
        }
    },
    "required": [
        "firstName",
        "lastName",
        "age",
        "faculty"
    ],
    "additionalProperties": false
}

Map with string values

A student struct which contains a map with arbitrary string values.

{
  "definitions": {
    "Student": {
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        },
        "properties": {
          "type": "map",
          "schema": {
            "type": "string"
          }
        }
      }
    }
  },
  "root": "Student"
}

Output

{
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
        },
        "lastName": {
            "type": "string"
        },
        "age": {
            "type": "integer"
        },
        "properties": {
            "type": "object",
            "properties": {},
            "additionalProperties": false
        }
    },
    "required": [
        "firstName",
        "lastName",
        "age",
        "properties"
    ],
    "additionalProperties": false
}

Model with discriminator

A struct which uses a discriminator mapping.

{
  "definitions": {
    "Human": {
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "location": {
          "type": "reference",
          "target": "Location"
        }
      }
    },
    "Location": {
      "type": "struct",
      "base": true,
      "properties": {
        "type": {
          "type": "string"
        }
      },
      "discriminator": "type",
      "mapping": {
        "Web": "web",
        "World": "world"
      }
    },
    "Web": {
      "parent": {
        "type": "reference",
        "target": "Location"
      },
      "type": "struct",
      "properties": {
        "url": {
          "type": "string"
        }
      }
    },
    "World": {
      "parent": {
        "type": "reference",
        "target": "Location"
      },
      "type": "struct",
      "properties": {
        "lat": {
          "type": "string"
        },
        "long": {
          "type": "string"
        }
      }
    }
  },
  "root": "Human"
}

Output

{
    "$defs": {
        "Location": {
            "anyOf": [
                {
                    "$ref": "#/$defs/Web"
                },
                {
                    "$ref": "#/$defs/World"
                }
            ]
        },
        "Web": {
            "type": "object",
            "properties": {
                "url": {
                    "type": "string"
                }
            },
            "required": [
                "url"
            ],
            "additionalProperties": false
        },
        "World": {
            "type": "object",
            "properties": {
                "lat": {
                    "type": "string"
                },
                "long": {
                    "type": "string"
                }
            },
            "required": [
                "lat",
                "long"
            ],
            "additionalProperties": false
        }
    },
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
        },
        "lastName": {
            "type": "string"
        },
        "location": {
            "$ref": "#/$defs/Location"
        }
    },
    "required": [
        "firstName",
        "lastName",
        "location"
    ],
    "additionalProperties": false
}

Model with generics

A struct which uses generics.

{
  "definitions": {
    "Student": {
      "type": "struct",
      "properties": {
        "matricleNumber": {
          "type": "integer"
        }
      }
    },
    "StudentMap": {
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "Map",
        "template": {
          "T": "Student"
        }
      }
    },
    "Map": {
      "type": "struct",
      "properties": {
        "totalResults": {
          "type": "integer"
        },
        "entries": {
          "type": "array",
          "schema": {
            "type": "generic",
            "name": "T"
          }
        }
      }
    }
  },
  "root": "StudentMap"
}

Output

{
    "$defs": {
        "Student": {
            "type": "object",
            "properties": {
                "matricleNumber": {
                    "type": "integer"
                }
            },
            "required": [
                "matricleNumber"
            ],
            "additionalProperties": false
        }
    },
    "type": "object",
    "properties": {
        "totalResults": {
            "type": "integer"
        },
        "entries": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/Student"
            }
        }
    },
    "required": [
        "totalResults",
        "entries"
    ],
    "additionalProperties": false
}

Import other TypeSchema specification

A struct which references an external TypeSchema.

{
  "import": {
    "my_ns": "file:///generic.json"
  },
  "definitions": {
    "Faculty": {
      "type": "struct",
      "properties": {
        "description": {
          "type": "string"
        },
        "students": {
          "type": "array",
          "schema": {
            "type": "reference",
            "target": "my_ns:StudentMap"
          }
        }
      }
    }
  },
  "root": "Faculty"
}

Output

{
    "type": "object",
    "properties": {
        "description": {
            "type": "string"
        },
        "students": {
            "type": "array",
            "items": {
                "$ref": "#/$defs/StudentMap"
            }
        }
    },
    "required": [
        "description",
        "students"
    ],
    "additionalProperties": false
}

Edit this page