optolith-database-schema 0.2.4 → 0.4.1

package/schema/_ActivatableSkillRange.schema.json

@@ -0,0 +1,241 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/_ActivatableSkillRange.schema.json",
+  "$defs": {
+    "Range": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "$ref": "#/$defs/RangeValue"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/RangeTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false
+    },
+    "RangeValue": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Modifiable"
+            },
+            "modifiable": {
+              "$ref": "#/$defs/ModifiableRange"
+            }
+          },
+          "required": [
+            "tag",
+            "modifiable"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Sight"
+            },
+            "sight": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "sight"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Self"
+            },
+            "self": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "self"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Global"
+            },
+            "global": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "global"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Fixed"
+            },
+            "fixed": {
+              "$ref": "#/$defs/FixedRange"
+            }
+          },
+          "required": [
+            "tag",
+            "fixed"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "CheckResultBased"
+            },
+            "check_result_based": {
+              "$ref": "#/$defs/CheckResultBasedRange"
+            }
+          },
+          "required": [
+            "tag",
+            "check_result_based"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "ModifiableRange": {
+      "type": "object",
+      "properties": {
+        "is_maximum": {
+          "description": "If `true`, the range is a maximum range.",
+          "const": true
+        },
+        "initial_modification_level": {
+          "description": "The initial skill modification identifier/level.",
+          "type": "integer",
+          "maximum": 6,
+          "minimum": 1
+        },
+        "is_radius": {
+          "description": "If `true`, the range is a radius.",
+          "const": true
+        }
+      },
+      "required": [
+        "initial_modification_level"
+      ],
+      "additionalProperties": false
+    },
+    "FixedRange": {
+      "type": "object",
+      "properties": {
+        "is_maximum": {
+          "description": "If `true`, the range is a maximum range.",
+          "const": true
+        },
+        "value": {
+          "description": "The (unitless) range value.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "unit": {
+          "description": "The unit of the `value`.",
+          "$ref": "#/$defs/RangeUnit"
+        },
+        "is_radius": {
+          "description": "If `true`, the range is a radius.",
+          "const": true
+        }
+      },
+      "required": [
+        "value",
+        "unit"
+      ],
+      "additionalProperties": false
+    },
+    "CheckResultBasedRange": {
+      "description": "Defines the range being based on a check result.",
+      "type": "object",
+      "properties": {
+        "base": {
+          "description": "The base value that is derived from the check result.",
+          "$ref": "./_ActivatableSkillCheckResultBased.schema.json#/$defs/CheckResultValue"
+        },
+        "modifier": {
+          "description": "If defined, it modifies the base value.",
+          "$ref": "./_ActivatableSkillCheckResultBased.schema.json#/$defs/CheckResultBasedModifier"
+        },
+        "is_maximum": {
+          "description": "If the range is the maximum range.",
+          "const": true
+        },
+        "unit": {
+          "description": "The duration unit.",
+          "$ref": "#/$defs/RangeUnit"
+        },
+        "is_radius": {
+          "description": "If `true`, the range is a radius.",
+          "const": true
+        }
+      },
+      "required": [
+        "base",
+        "unit"
+      ],
+      "additionalProperties": false
+    },
+    "RangeTranslation": {
+      "type": "object",
+      "properties": {
+        "note": {
+          "description": "A note, appended to the generated string in parenthesis. If the\ngenerated is modified using `replacement`, the note is appended to\nthe modifier string.",
+          "$ref": "./_ResponsiveText.schema.json#/$defs/ResponsiveTextOptional"
+        },
+        "replacement": {
+          "description": "A replacement string. If `note` is provided, it is appended to the\nreplaced string.",
+          "$ref": "./_ResponsiveText.schema.json#/$defs/ResponsiveTextReplace"
+        }
+      },
+      "required": [],
+      "minProperties": 1,
+      "additionalProperties": false
+    },
+    "RangeUnit": {
+      "enum": [
+        "Steps",
+        "Miles"
+      ]
+    }
+  }
+}

package/schema/_ActivatableSkillTargetCategory.schema.json

@@ -0,0 +1,145 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/_ActivatableSkillTargetCategory.schema.json",
+  "$defs": {
+    "TargetCategory": {
+      "description": "The target category – the kind of creature or object – the skill affects.\n\nIf no target categories are given, the skill applies to all target\ncategories.",
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/SpecificTargetCategory"
+      }
+    },
+    "SpecificTargetCategory": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/TargetCategoryIdentifier"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/SpecificTargetCategoryTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "additionalProperties": false
+    },
+    "SpecificTargetCategoryTranslation": {
+      "type": "object",
+      "properties": {
+        "note": {
+          "description": "A note, appended to the generated string in parenthesis.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        }
+      },
+      "required": [
+        "note"
+      ],
+      "additionalProperties": false
+    },
+    "TargetCategoryIdentifier": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Self"
+            },
+            "self": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "self"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Zone"
+            },
+            "zone": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "zone"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "LiturgicalChantsAndCeremonies"
+            },
+            "liturgical_chants_and_ceremonies": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "liturgical_chants_and_ceremonies"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Cantrips"
+            },
+            "cantrips": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "cantrips"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Predefined"
+            },
+            "predefined": {
+              "$ref": "./_SimpleReferences.schema.json#/$defs/TargetCategoryReference"
+            }
+          },
+          "required": [
+            "tag",
+            "predefined"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  }
+}

package/schema/_AlternativeNames.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/_AlternativeNames.schema.json",
+  "$defs": {
+    "AlternativeName": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "An alternative name of the disease.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "region": {
+          "description": "The region where this alternative name is used.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/_ArcaneTradition.schema.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/_ArcaneTradition.schema.json",
+  "$ref": "#/$defs/ArcaneTradition",
+  "$defs": {
+    "ArcaneTradition": {
+      "title": "Arcane Tradition",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The arcane tradition's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "prerequisites": {
+          "$ref": "./_Prerequisite.schema.json#/$defs/ArcaneTraditionPrerequisites"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/ArcaneTraditionTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "prerequisites",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "ArcaneTraditionTranslation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The arcane tradition's name.",
+          "$ref": "./_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/_Blessed.schema.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/_Blessed.schema.json",
+  "$defs": {
+    "SkillTradition": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "GeneralAspect"
+            },
+            "general_aspect": {
+              "$ref": "./_SimpleReferences.schema.json#/$defs/AspectReference"
+            }
+          },
+          "required": [
+            "tag",
+            "general_aspect"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Tradition"
+            },
+            "tradition": {
+              "$ref": "#/$defs/SkillTraditionWithAspects"
+            }
+          },
+          "required": [
+            "tag",
+            "tradition"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "SkillTraditionWithAspects": {
+      "type": "object",
+      "properties": {
+        "tradition": {
+          "description": "The blessed tradition.",
+          "$ref": "./_SimpleReferences.schema.json#/$defs/BlessedTraditionReference"
+        },
+        "aspects": {
+          "description": "The aspect(s) from the tradition the ceremony belongs to. Note that not\nall traditions have aspects. Traditions with aspects must have at least one\naspect specified.",
+          "type": "array",
+          "items": {
+            "$ref": "./_SimpleReferences.schema.json#/$defs/AspectReference"
+          },
+          "minItems": 1,
+          "maxItems": 2
+        }
+      },
+      "required": [
+        "tradition"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/_CommonnessRatedAdvantageDisadvantage.schema.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
   "$id": "/_CommonnessRatedAdvantageDisadvantage.schema.json",
-  "definitions": {
+  "$defs": {
     "CommonnessRatedAdvantageDisadvantage": {
       "title": "Commonness-rated Advantage/Disadvantage",
       "description": "Reference to a commonness-rated advantage or disadvantage. Commonness-rating terms used in the source books are strongly recommended, common, uncommon, suggested and unsuitable.",

package/schema/_Dice.schema.json

@@ -1,7 +1,7 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
   "$id": "/_Dice.schema.json",
-  "definitions": {
+  "$defs": {
     "Dice": {
       "title": "Dice",
       "type": "object",
@@ -13,7 +13,7 @@
         },
         "sides": {
           "description": "Number of sides on every die. Example: 6 in 2D6.",
-          "$ref": "#/definitions/DieType"
+          "$ref": "#/$defs/DieType"
         }
       },
       "required": [