nissaga-schema.json

{
  "title": "Nissaga",
  "description": "Top level element containing the data required to build a family tree",
  "type": "object",
  "properties": {
    "styles": {
      "title": "Styles",
      "type": "object"
    },
    "families": {
      "title": "Families",
      "type": "array",
      "items": {
        "$ref": "#/definitions/Family"
      }
    },
    "people": {
      "title": "People",
      "default": {},
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/Person"
      }
    }
  },
  "additionalProperties": false,
  "definitions": {
    "Person": {
      "title": "Person",
      "description": "Represents the data of a person",
      "type": "object",
      "properties": {
        "fullname": {
          "title": "Fullname",
          "description": "Surnames are placed first, followed by a comma and then the first name. If no comma, it is just considered the first name",
          "type": "string"
        },
        "name": {
          "title": "Name",
          "description": "TODO: Explain difference between id, name, fullname and alias. ",
          "type": "string"
        },
        "alias": {
          "title": "Alias",
          "description": "TODO: Explain difference between id, name, fullname and alias. ",
          "type": "string"
        },
        "born": {
          "title": "Born",
          "description": "Date of birth or false to indicate stillborn, or true to indicate unknown date or a year or a string annotation.",
          "default": true,
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "string"
            }
          ]
        },
        "died": {
          "title": "Died",
          "description": "Date of death of true to indicate dead but unknown date or a year or a string annotation.",
          "default": false,
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "string"
            }
          ]
        },
        "age": {
          "title": "Age",
          "description": "Age at death, instead of `died`. Just for the record, not shown. Sometimes is the only information available in gravestones.",
          "type": "integer"
        },
        "from": {
          "title": "From",
          "description": "Place of origin. Just for the record, not shown.",
          "type": "string"
        },
        "comment": {
          "title": "Comment",
          "description": "Any comments regarding the person information gathering. Just for the record, not shown.",
          "default": [],
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "notes": {
          "title": "Notes",
          "description": "Any comments regardin the person.Just for the record, not shown.",
          "default": [],
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "todo": {
          "title": "Todo",
          "description": "A list of pending tasks about the person information gathering. Just for the record, not shown.",
          "default": [],
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "pics": {
          "title": "Pics",
          "description": "A list of image files containing pictures of the person. The first one is used as avatar and it should have an almost squared aspect ratio.",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "docs": {
          "title": "Docs",
          "description": "A list of files serving as documentation of the gathered information.",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "links": {
          "title": "Links",
          "description": "A list of links related to the person. Clicking on the person box will go to the first one.",
          "default": [],
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 65536,
            "format": "uri"
          }
        },
        "gender": {
          "title": "Gender",
          "description": "Not used yet.",
          "type": "string"
        },
        "class": {
          "title": "Class",
          "description": "Space separated style classes for the person. Specific attributes can be specified for the persons having a given class.",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "Family": {
      "title": "Family",
      "description": "Represents a family kernel with parents and children and any descendant family",
      "type": "object",
      "properties": {
        "parents": {
          "title": "Parents",
          "description": "Parents of the family. You can use the person's id, or detail the person inline.",
          "default": [],
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "object",
                "additionalProperties": {
                  "$ref": "#/definitions/Person"
                }
              }
            ]
          }
        },
        "children": {
          "title": "Children",
          "description": "Children of the family. You can use the person's id, or detail the person inline.",
          "default": [],
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "object",
                "additionalProperties": {
                  "$ref": "#/definitions/Person"
                }
              }
            ]
          }
        },
        "married": {
          "title": "Married",
          "description": "Date of marriage. False to indicate unmarried couple, or true to indicate unknown date or a year or a string annotation after the marriage symbol.",
          "default": true,
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "string"
            }
          ]
        },
        "divorced": {
          "title": "Divorced",
          "description": "Date of divorce. If false, the default, nothing is shown. Set to true to show a divorce symbol. If it is a date, an integer (year) or any other string, will be displayeed after the divorce symbol.",
          "default": false,
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "integer"
            },
            {
              "type": "string",
              "format": "date"
            },
            {
              "type": "string"
            }
          ]
        },
        "house": {
          "title": "House",
          "description": "House the family belongs to. It is represented by a labeled gray box grouping the persons",
          "type": "string"
        },
        "notes": {
          "title": "Notes",
          "description": "Any comments regardin the family.Just for the record, not shown.",
          "default": [],
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "docs": {
          "title": "Docs",
          "description": "A list of files serving as documentation of the gathered information.",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "families": {
          "title": "Families",
          "description": "Subfamilies. They can be defined when children become parents in their own families. Nesting is not mandatory, just to keep data in a tree like structure if you prefer that. You could alternatively define children's families at the same level.",
          "default": [],
          "type": "array",
          "items": {
            "$ref": "#/definitions/Family"
          }
        }
      },
      "additionalProperties": false
    }
  }
}