Skip to content

Instantly share code, notes, and snippets.

@bravo-kernel

bravo-kernel/example-2019-09.md

Created December 18, 2021 13:09
Show Gist options
  • Save bravo-kernel/ebf7a3652b7e0d5b6e414a77f2c9d7ae to your computer and use it in GitHub Desktop.
Save bravo-kernel/ebf7a3652b7e0d5b6e414a77f2c9d7ae to your computer and use it in GitHub Desktop.
Download ZIP
Raw
example-2019-09.md

JSON Schema Draft 2019-09

These schemas were automatically generated on 2021-12-18 using these Sequelize models and the most recent version of sequelize-to-json-schemas. To confirm that these are indeed all valid schemas use:

User Model

{
  "$schema": "https://json-schema.org/draft/2019-09/schema#",
  "$id": "https://api.example.com/user.json",
  "title": "Custom User Title",
  "description": "Custom User Description",
  "type": "object",
  "properties": {
    "id": {
      "$id": "https://api.example.com/properties/id",
      "type": "integer",
      "format": "int32"
    },
    "createdAt": {
      "$id": "https://api.example.com/properties/createdAt",
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "$id": "https://api.example.com/properties/updatedAt",
      "type": "string",
      "format": "date-time"
    },
    "ARRAY_INTEGERS": {
      "$id": "https://api.example.com/properties/ARRAY_INTEGERS",
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int32"
      }
    },
    "ARRAY_TEXTS": {
      "$id": "https://api.example.com/properties/ARRAY_TEXTS",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "ARRAY_ALLOWNULL_EXPLICIT": {
      "$id": "https://api.example.com/properties/ARRAY_ALLOWNULL_EXPLICIT",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "ARRAY_ALLOWNULL_IMPLICIT": {
      "$id": "https://api.example.com/properties/ARRAY_ALLOWNULL_IMPLICIT",
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "ARRAY_ENUM_STRINGS": {
      "$id": "https://api.example.com/properties/ARRAY_ENUM_STRINGS",
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "hello",
          "world"
        ]
      }
    },
    "BLOB": {
      "$id": "https://api.example.com/properties/BLOB",
      "type": "string",
      "contentEncoding": "base64"
    },
    "CITEXT": {
      "$id": "https://api.example.com/properties/CITEXT",
      "type": "string"
    },
    "INTEGER": {
      "$id": "https://api.example.com/properties/INTEGER",
      "type": "integer",
      "format": "int32",
      "default": 0
    },
    "STRING": {
      "$id": "https://api.example.com/properties/STRING",
      "type": "string",
      "default": "Default value for STRING"
    },
    "STRING_ALLOWNULL_EXPLICIT": {
      "$id": "https://api.example.com/properties/STRING_ALLOWNULL_EXPLICIT",
      "type": [
        "string",
        "null"
      ]
    },
    "STRING_ALLOWNULL_IMPLICIT": {
      "$id": "https://api.example.com/properties/STRING_ALLOWNULL_IMPLICIT",
      "type": [
        "string",
        "null"
      ]
    },
    "STRING_1234": {
      "$id": "https://api.example.com/properties/STRING_1234",
      "type": "string",
      "maxLength": 1234
    },
    "STRING_DOT_BINARY": {
      "$id": "https://api.example.com/properties/STRING_DOT_BINARY",
      "type": "string",
      "format": "binary"
    },
    "TEXT": {
      "$id": "https://api.example.com/properties/TEXT",
      "type": "string"
    },
    "UUIDV4": {
      "$id": "https://api.example.com/properties/UUIDV4",
      "type": "string",
      "format": "uuid"
    },
    "JSON": {
      "$id": "https://api.example.com/properties/JSON",
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "array"
        },
        {
          "type": "boolean"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        }
      ],
      "type": "object"
    },
    "JSONB_ALLOWNULL": {
      "$id": "https://api.example.com/properties/JSONB_ALLOWNULL",
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "array"
        },
        {
          "type": "boolean"
        },
        {
          "type": "integer"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "VIRTUAL": {
      "$id": "https://api.example.com/properties/VIRTUAL",
      "type": "boolean"
    },
    "VIRTUAL_DEPENDENCY": {
      "$id": "https://api.example.com/properties/VIRTUAL_DEPENDENCY",
      "type": "integer",
      "format": "int32"
    },
    "CUSTOM_DESCRIPTION": {
      "$id": "https://api.example.com/properties/CUSTOM_DESCRIPTION",
      "type": "string",
      "description": "Custom attribute description"
    },
    "CUSTOM_COMMENT": {
      "$id": "https://api.example.com/properties/CUSTOM_COMMENT",
      "type": "string",
      "$comment": "Custom comment"
    },
    "CUSTOM_EXAMPLES": {
      "$id": "https://api.example.com/properties/CUSTOM_EXAMPLES",
      "type": "string",
      "examples": [
        "Custom example 1",
        "Custom example 2"
      ]
    },
    "CUSTOM_READONLY": {
      "$id": "https://api.example.com/properties/CUSTOM_READONLY",
      "type": "string",
      "readOnly": true
    },
    "CUSTOM_WRITEONLY": {
      "$id": "https://api.example.com/properties/CUSTOM_WRITEONLY",
      "type": "string",
      "writeOnly": true
    },
    "companyId": {
      "$id": "https://api.example.com/properties/companyId",
      "type": [
        "integer",
        "null"
      ],
      "format": "int32"
    },
    "bossId": {
      "$id": "https://api.example.com/properties/bossId",
      "type": [
        "integer",
        "null"
      ],
      "format": "int32"
    },
    "profile": {
      "$ref": "#/definitions/profile"
    },
    "company": {
      "$ref": "#/definitions/company"
    },
    "documents": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/document"
      }
    },
    "boss": {
      "$ref": "#/definitions/user"
    },
    "friends": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "$ref": "#/definitions/user"
          },
          {
            "type": "object",
            "properties": {
              "friendships": {
                "$ref": "#/definitions/friendship"
              }
            }
          }
        ]
      }
    }
  },
  "required": [
    "id",
    "createdAt",
    "updatedAt",
    "ARRAY_INTEGERS",
    "ARRAY_TEXTS",
    "ARRAY_ENUM_STRINGS",
    "BLOB",
    "CITEXT",
    "INTEGER",
    "STRING",
    "STRING_1234",
    "STRING_DOT_BINARY",
    "TEXT",
    "UUIDV4",
    "JSON",
    "VIRTUAL",
    "VIRTUAL_DEPENDENCY",
    "CUSTOM_DESCRIPTION",
    "CUSTOM_COMMENT",
    "CUSTOM_EXAMPLES",
    "CUSTOM_READONLY",
    "CUSTOM_WRITEONLY"
  ]
}

Profile Model

{
  "$schema": "https://json-schema.org/draft/2019-09/schema#",
  "$id": "https://api.example.com/profile.json",
  "title": "Profile",
  "type": "object",
  "properties": {
    "id": {
      "$id": "https://api.example.com/properties/id",
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "$id": "https://api.example.com/properties/name",
      "type": [
        "string",
        "null"
      ]
    },
    "userId": {
      "$id": "https://api.example.com/properties/userId",
      "type": [
        "integer",
        "null"
      ],
      "format": "int32"
    }
  },
  "required": [
    "id"
  ]
}

Document Model

{
  "$schema": "https://json-schema.org/draft/2019-09/schema#",
  "$id": "https://api.example.com/document.json",
  "title": "Document",
  "type": "object",
  "properties": {
    "id": {
      "$id": "https://api.example.com/properties/id",
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "$id": "https://api.example.com/properties/name",
      "type": [
        "string",
        "null"
      ]
    },
    "userId": {
      "$id": "https://api.example.com/properties/userId",
      "type": [
        "integer",
        "null"
      ],
      "format": "int32"
    }
  },
  "required": [
    "id"
  ]
}

Company Model

{
  "$schema": "https://json-schema.org/draft/2019-09/schema#",
  "$id": "https://api.example.com/company.json",
  "title": "Company",
  "type": "object",
  "properties": {
    "id": {
      "$id": "https://api.example.com/properties/id",
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "$id": "https://api.example.com/properties/name",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id"
  ]
}

Friendship Model

{
  "$schema": "https://json-schema.org/draft/2019-09/schema#",
  "$id": "https://api.example.com/friendship.json",
  "title": "Friendship",
  "type": "object",
  "properties": {
    "isBestFriend": {
      "$id": "https://api.example.com/properties/isBestFriend",
      "type": [
        "boolean",
        "null"
      ],
      "default": false
    },
    "userId": {
      "$id": "https://api.example.com/properties/userId",
      "type": [
        "integer",
        "null"
      ],
      "format": "int32"
    },
    "friendId": {
      "$id": "https://api.example.com/properties/friendId",
      "type": [
        "integer",
        "null"
      ],
      "format": "int32"
    }
  },
  "required": [
    "isBestFriend"
  ]
}

Full Schema

Please note that sequelize-to-json-schemas does NOT generate full schemas. This is just an example of how to integrate the generated model schemas into a full JSON Schema Draft 2019-09 document (by adding model schemas to definitions).

{
  "$schema": "https://json-schema.org/draft-07/schema#",
  "definitions": {
    "user": {
      "$schema": "https://json-schema.org/draft/2019-09/schema#",
      "$id": "https://api.example.com/user.json",
      "title": "Custom User Title",
      "description": "Custom User Description",
      "type": "object",
      "properties": {
        "id": {
          "$id": "https://api.example.com/properties/id",
          "type": "integer",
          "format": "int32"
        },
        "createdAt": {
          "$id": "https://api.example.com/properties/createdAt",
          "type": "string",
          "format": "date-time"
        },
        "updatedAt": {
          "$id": "https://api.example.com/properties/updatedAt",
          "type": "string",
          "format": "date-time"
        },
        "ARRAY_INTEGERS": {
          "$id": "https://api.example.com/properties/ARRAY_INTEGERS",
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int32"
          }
        },
        "ARRAY_TEXTS": {
          "$id": "https://api.example.com/properties/ARRAY_TEXTS",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ARRAY_ALLOWNULL_EXPLICIT": {
          "$id": "https://api.example.com/properties/ARRAY_ALLOWNULL_EXPLICIT",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "ARRAY_ALLOWNULL_IMPLICIT": {
          "$id": "https://api.example.com/properties/ARRAY_ALLOWNULL_IMPLICIT",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "ARRAY_ENUM_STRINGS": {
          "$id": "https://api.example.com/properties/ARRAY_ENUM_STRINGS",
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "hello",
              "world"
            ]
          }
        },
        "BLOB": {
          "$id": "https://api.example.com/properties/BLOB",
          "type": "string",
          "contentEncoding": "base64"
        },
        "CITEXT": {
          "$id": "https://api.example.com/properties/CITEXT",
          "type": "string"
        },
        "INTEGER": {
          "$id": "https://api.example.com/properties/INTEGER",
          "type": "integer",
          "format": "int32",
          "default": 0
        },
        "STRING": {
          "$id": "https://api.example.com/properties/STRING",
          "type": "string",
          "default": "Default value for STRING"
        },
        "STRING_ALLOWNULL_EXPLICIT": {
          "$id": "https://api.example.com/properties/STRING_ALLOWNULL_EXPLICIT",
          "type": [
            "string",
            "null"
          ]
        },
        "STRING_ALLOWNULL_IMPLICIT": {
          "$id": "https://api.example.com/properties/STRING_ALLOWNULL_IMPLICIT",
          "type": [
            "string",
            "null"
          ]
        },
        "STRING_1234": {
          "$id": "https://api.example.com/properties/STRING_1234",
          "type": "string",
          "maxLength": 1234
        },
        "STRING_DOT_BINARY": {
          "$id": "https://api.example.com/properties/STRING_DOT_BINARY",
          "type": "string",
          "format": "binary"
        },
        "TEXT": {
          "$id": "https://api.example.com/properties/TEXT",
          "type": "string"
        },
        "UUIDV4": {
          "$id": "https://api.example.com/properties/UUIDV4",
          "type": "string",
          "format": "uuid"
        },
        "JSON": {
          "$id": "https://api.example.com/properties/JSON",
          "anyOf": [
            {
              "type": "object"
            },
            {
              "type": "array"
            },
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "number"
            },
            {
              "type": "string"
            }
          ],
          "type": "object"
        },
        "JSONB_ALLOWNULL": {
          "$id": "https://api.example.com/properties/JSONB_ALLOWNULL",
          "anyOf": [
            {
              "type": "object"
            },
            {
              "type": "array"
            },
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "number"
            },
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "VIRTUAL": {
          "$id": "https://api.example.com/properties/VIRTUAL",
          "type": "boolean"
        },
        "VIRTUAL_DEPENDENCY": {
          "$id": "https://api.example.com/properties/VIRTUAL_DEPENDENCY",
          "type": "integer",
          "format": "int32"
        },
        "CUSTOM_DESCRIPTION": {
          "$id": "https://api.example.com/properties/CUSTOM_DESCRIPTION",
          "type": "string",
          "description": "Custom attribute description"
        },
        "CUSTOM_COMMENT": {
          "$id": "https://api.example.com/properties/CUSTOM_COMMENT",
          "type": "string",
          "$comment": "Custom comment"
        },
        "CUSTOM_EXAMPLES": {
          "$id": "https://api.example.com/properties/CUSTOM_EXAMPLES",
          "type": "string",
          "examples": [
            "Custom example 1",
            "Custom example 2"
          ]
        },
        "CUSTOM_READONLY": {
          "$id": "https://api.example.com/properties/CUSTOM_READONLY",
          "type": "string",
          "readOnly": true
        },
        "CUSTOM_WRITEONLY": {
          "$id": "https://api.example.com/properties/CUSTOM_WRITEONLY",
          "type": "string",
          "writeOnly": true
        },
        "companyId": {
          "$id": "https://api.example.com/properties/companyId",
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "bossId": {
          "$id": "https://api.example.com/properties/bossId",
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "profile": {
          "$ref": "#/definitions/profile"
        },
        "company": {
          "$ref": "#/definitions/company"
        },
        "documents": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/document"
          }
        },
        "boss": {
          "$ref": "#/definitions/user"
        },
        "friends": {
          "type": "array",
          "items": {
            "allOf": [
              {
                "$ref": "#/definitions/user"
              },
              {
                "type": "object",
                "properties": {
                  "friendships": {
                    "$ref": "#/definitions/friendship"
                  }
                }
              }
            ]
          }
        }
      },
      "required": [
        "id",
        "createdAt",
        "updatedAt",
        "ARRAY_INTEGERS",
        "ARRAY_TEXTS",
        "ARRAY_ENUM_STRINGS",
        "BLOB",
        "CITEXT",
        "INTEGER",
        "STRING",
        "STRING_1234",
        "STRING_DOT_BINARY",
        "TEXT",
        "UUIDV4",
        "JSON",
        "VIRTUAL",
        "VIRTUAL_DEPENDENCY",
        "CUSTOM_DESCRIPTION",
        "CUSTOM_COMMENT",
        "CUSTOM_EXAMPLES",
        "CUSTOM_READONLY",
        "CUSTOM_WRITEONLY"
      ]
    },
    "profile": {
      "$schema": "https://json-schema.org/draft/2019-09/schema#",
      "$id": "https://api.example.com/profile.json",
      "title": "Profile",
      "type": "object",
      "properties": {
        "id": {
          "$id": "https://api.example.com/properties/id",
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "$id": "https://api.example.com/properties/name",
          "type": [
            "string",
            "null"
          ]
        },
        "userId": {
          "$id": "https://api.example.com/properties/userId",
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        }
      },
      "required": [
        "id"
      ]
    },
    "document": {
      "$schema": "https://json-schema.org/draft/2019-09/schema#",
      "$id": "https://api.example.com/document.json",
      "title": "Document",
      "type": "object",
      "properties": {
        "id": {
          "$id": "https://api.example.com/properties/id",
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "$id": "https://api.example.com/properties/name",
          "type": [
            "string",
            "null"
          ]
        },
        "userId": {
          "$id": "https://api.example.com/properties/userId",
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        }
      },
      "required": [
        "id"
      ]
    },
    "company": {
      "$schema": "https://json-schema.org/draft/2019-09/schema#",
      "$id": "https://api.example.com/company.json",
      "title": "Company",
      "type": "object",
      "properties": {
        "id": {
          "$id": "https://api.example.com/properties/id",
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "$id": "https://api.example.com/properties/name",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id"
      ]
    },
    "friendship": {
      "$schema": "https://json-schema.org/draft/2019-09/schema#",
      "$id": "https://api.example.com/friendship.json",
      "title": "Friendship",
      "type": "object",
      "properties": {
        "isBestFriend": {
          "$id": "https://api.example.com/properties/isBestFriend",
          "type": [
            "boolean",
            "null"
          ],
          "default": false
        },
        "userId": {
          "$id": "https://api.example.com/properties/userId",
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "friendId": {
          "$id": "https://api.example.com/properties/friendId",
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        }
      },
      "required": [
        "isBestFriend"
      ]
    }
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment