schema-07.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/pyrox0/fursona-schema/main/schema-07.json",
  "additionalProperties": false,
  "title": "Schema for .well-known/fursona, version 1.1",
  "description": "A description of someone's fursona(s).",
  "type": "object",
  "properties": {
    "sonas": {
      "description": "The list of fursonas.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/sona"
      }
    }
  },
  "required": [
    "sonas"
  ],
  "definitions": {
    "galleryItem": {
      "$id": "galleryItem",
      "description": "An image gallery item",
      "type": "object",
      "required": [
        "image"
      ],
      "properties": {
        "image": {
          "type": "string",
          "format": "uri",
          "qt-uri-protocols": [
            "http",
            "https",
            "gemini",
            "ftp"
          ]
        },
        "imageAlt": {
          "type": "string"
        },
        "imageAttribution": {
          "type": "string"
        },
        "description": {
          "type": "string",
          "maxLength": 500
        }
      }
    },
    "sona": {
      "$id": "sona",
      "description": "A single fursona",
      "type": "object",
      "required": [
        "ref"
      ],
      "properties": {
        "name": {
          "description": "The name of this fursona.",
          "type": "string"
        },
        "pronouns": {
          "description": "This fursona's pronouns.",
          "type": "string"
        },
        "gender": {
          "description": "This fursona's gender.",
          "type": "string"
        },
        "species": {
          "description": "This fursona's species.",
          "type": "string"
        },
        "description": {
          "description": "Any additional notes or links for this fursona.",
          "type": "string",
          "maxLength": 250
        },
        "ref": {
          "description": "A link to a ref for this fursona. Should be an image file.",
          "type": "string",
          "format": "uri",
          "qt-uri-protocols": [
            "http",
            "https",
            "gemini",
            "ftp"
          ]
        },
        "refAlt": {
          "description": "Alt text to be added to the ref sheet image. Not required but highly encouraged.",
          "type": "string"
        },
        "refAttribution": {
          "description": "Attribution for the ref sheet, in whatever format you want. Not required, but strongly encouraged.",
          "type": "string"
        },
        "avatar": {
          "description": "An image file to use as an avatar, if needed.",
          "type": "string",
          "format": "uri",
          "qt-uri-protocols": [
            "http",
            "https",
            "gemini",
            "ftp"
          ]
        },
        "avatarAlt": {
          "description": "Alt text for the avatar. Like refAlt, not required but highly encouraged.",
          "type": "string"
        },
        "avatarAttribution": {
          "description": "Attribution for the avatar image, in whatever format you want. Not required, but strongly encouraged.",
          "type": "string"
        },
        "age": {
          "description": "This fursona's age.",
          "type": "integer"
        },
        "birthdate": {
          "description": "The birthdate of the fursona.",
          "type": "string"
        },
        "colors": {
          "description": "The fursona's colors. Should be an array of 3 or 6-digit hex codes, which can be prefixed with a hashtag.",
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^#?([0-9a-fA-F]{6}|[0-9a-fA-F]{3})$"
          }
        },
        "gallery": {
          "description": "A list of additional images to display",
          "type": "array",
          "items": {
            "$ref": "galleryItem"
          }
        }
      }
    }
  }
}