optolith-database-schema 0.1.4 → 0.1.7

package/schema/prerequisites/single/CulturePrerequisite.schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/CulturePrerequisite.schema.json",
+  "definitions": {
+    "CulturePrerequisite": {
+      "title": "Culture Prerequisite",
+      "description": "Requires a specific culture or one of a specific set of cultures.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Culture"
+        },
+        "id": {
+          "$ref": "../../_Identifier.schema.json#/definitions/OneOrManyNumericIdentifiers"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/EnhancementPrerequisite.schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/EnhancementPrerequisite.schema.json",
+  "definitions": {
+    "ExternalEnhancementPrerequisite": {
+      "title": "External Enhancement Prerequisite",
+      "description": "Requires a specific enhancement from a skill. This should **not** be used\nfor enhancements themselves; they can only require enhancements from the same\nskill they enhance.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Enhancement"
+        },
+        "skill_id": {
+          "description": "The required skill's identifier.",
+          "$ref": "../../_Identifier.schema.json#/definitions/SkillWithEnhancementsIdentifier"
+        },
+        "enhancement_id": {
+          "description": "The required enhancement's identifier.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "skill_id",
+        "enhancement_id"
+      ],
+      "additionalProperties": false
+    },
+    "InternalEnhancementPrerequisite": {
+      "title": "Internal Enhancement Prerequisite",
+      "description": "Requires a specific enhancement from a skill. This can only be used by an\nenhancement to require another enhancement from the same skill.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Enhancement"
+        },
+        "id": {
+          "description": "The enhancement's identifier.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "tag",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/InfluencePrerequisite.schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/InfluencePrerequisite.schema.json",
+  "definitions": {
+    "InfluencePrerequisite": {
+      "title": "Influence Prerequisite",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Influence"
+        },
+        "id": {
+          "description": "The influence's identifier.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "active": {
+          "description": "If the referenced influence must or must not be chosen.",
+          "type": "boolean"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id",
+        "active"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/PactPrerequisite.schema.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/PactPrerequisite.schema.json",
+  "definitions": {
+    "PactPrerequisite": {
+      "title": "Pact Prerequisite",
+      "description": "Requires a specific pact.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Pact"
+        },
+        "category_id": {
+          "description": "The required pact category's identifier.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "domain_id": {
+          "description": "The required domains' identifiers.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/DomainId"
+          }
+        },
+        "level": {
+          "description": "The required pact level.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "category_id"
+      ],
+      "additionalProperties": false
+    },
+    "DomainId": {
+      "description": "A domain's identifier.",
+      "type": "integer",
+      "minimum": 1
+    }
+  }
+}

package/schema/prerequisites/single/PrimaryAttributePrerequisite.schema.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/PrimaryAttributePrerequisite.schema.json",
+  "definitions": {
+    "PrimaryAttributePrerequisite": {
+      "title": "Primary Attribute Prerequisite",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "PrimaryAttribute"
+        },
+        "category": {
+          "description": "Is the required primary attribute for spellcasters or blessed ones?",
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Blessed"
+                }
+              },
+              "required": [
+                "tag"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Magical"
+                }
+              },
+              "required": [
+                "tag"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "value": {
+          "description": "Required value of the attribute",
+          "type": "integer",
+          "minimum": 9
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "category",
+        "value"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/PublicationPrerequisite.schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/PublicationPrerequisite.schema.json",
+  "definitions": {
+    "PublicationPrerequisite": {
+      "title": "Publication Prerequisite",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Publication"
+        },
+        "id": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/RacePrerequisite.schema.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/RacePrerequisite.schema.json",
+  "definitions": {
+    "RacePrerequisite": {
+      "title": "Race Prerequisite",
+      "description": "Requires a specific race or one of a specific set of races. You can also\nprovide an object to say whether the hero must meet one of the races or\nif the entry does not allow one of the races.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Culture"
+        },
+        "id": {
+          "$ref": "../../_Identifier.schema.json#/definitions/OneOrManyNumericIdentifiers"
+        },
+        "active": {
+          "type": "boolean"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id",
+        "active"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/RatedPrerequisite.schema.json

@@ -0,0 +1,184 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/RatedPrerequisite.schema.json",
+  "definitions": {
+    "RatedPrerequisite": {
+      "title": "Rated Prerequisite",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Rated"
+        },
+        "id": {
+          "description": "The rated entry's identifier.",
+          "$ref": "../../_Identifier.schema.json#/definitions/RatedIdentifier"
+        },
+        "value": {
+          "description": "The required minimum value.",
+          "type": "integer",
+          "minimum": 0
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id",
+        "value"
+      ],
+      "additionalProperties": false
+    },
+    "RatedSetPrerequisite": {
+      "title": "Rated Set Prerequisite",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "RatedSet"
+        },
+        "id": {
+          "description": "The possible rated entries' identifiers.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_Identifier.schema.json#/definitions/RatedIdentifier"
+          },
+          "minItems": 2
+        },
+        "value": {
+          "description": "The required minimum value.",
+          "type": "integer",
+          "minimum": 0
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id",
+        "value"
+      ],
+      "additionalProperties": false
+    },
+    "RatedMinimumNumberPrerequisite": {
+      "title": "Rated Minimum Number Prerequisite",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "RatedMinimumNumber"
+        },
+        "number": {
+          "description": "The minimum number of skills that need to be on the defined minimum skill\nrating.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "value": {
+          "description": "The minimum skill rating the defined minimum number of skills need to be\non.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "targets": {
+          "description": "The targets that contribute to satisfying the prerequisite.",
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Skills"
+                },
+                "skills": {
+                  "description": "The skills that are taken into account for satisfying the prerequisite.",
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "id": {
+                        "description": "The skill's identifier.",
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "id"
+                    ],
+                    "additionalProperties": false
+                  },
+                  "minItems": 2,
+                  "uniqueItems": true
+                }
+              },
+              "required": [
+                "tag",
+                "skills"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Spellworks"
+                },
+                "property": {
+                  "description": "Spellworks with the referenced property are taken into account for\nsatisfying the prerequisite.",
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "description": "The property's identifier.",
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "id"
+                  ],
+                  "additionalProperties": false
+                }
+              },
+              "required": [
+                "tag",
+                "property"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Liturgies"
+                },
+                "aspect": {
+                  "description": "Liturgies with the referenced aspect are taken into account for\nsatisfying the prerequisite.",
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "description": "The aspect's identifier.",
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "id"
+                  ],
+                  "additionalProperties": false
+                }
+              },
+              "required": [
+                "tag",
+                "aspect"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "number",
+        "value",
+        "targets"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/RulePrerequisite.schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/RulePrerequisite.schema.json",
+  "definitions": {
+    "RulePrerequisite": {
+      "title": "Rule Prerequisite",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Rule"
+        },
+        "id": {
+          "$ref": "../../_Identifier.schema.json#/definitions/ExtensionRuleIdentifier"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/SexPrerequisite.schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/SexPrerequisite.schema.json",
+  "definitions": {
+    "SexPrerequisite": {
+      "title": "Sex Prerequisite",
+      "description": "Requires a specific sex.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Sex"
+        },
+        "id": {
+          "$ref": "../../_Sex.schema.json#/definitions/BinarySex"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/SocialStatusPrerequisite.schema.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/SocialStatusPrerequisite.schema.json",
+  "definitions": {
+    "SocialStatusPrerequisite": {
+      "title": "Social Status Prerequisite",
+      "description": "Requires a minimum social status.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "SocialStatus"
+        },
+        "id": {
+          "description": "The minimum social status' identifier.",
+          "type": "integer",
+          "maximum": 5,
+          "minimum": 2
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/StatePrerequisite.schema.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/StatePrerequisite.schema.json",
+  "definitions": {
+    "StatePrerequisite": {
+      "title": "State Prerequisite",
+      "description": "Requires a specific state or one of a specific set of states.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Culture"
+        },
+        "id": {
+          "$ref": "../../_Identifier.schema.json#/definitions/OneOrManyNumericIdentifiers"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/definitions/DisplayOption"
+        }
+      },
+      "required": [
+        "tag",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/TextPrerequisite.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "/prerequisites/single/TextPrerequisite.schema.json",
+  "definitions": {
+    "TextPrerequisite": {
+      "title": "Impossible Prerequisite",
+      "description": "A prerequisite that is either not verifyable in general – e.g. roleplay or\nbackground information – or the referenced entities were not made available\nfor use yet – e.g. races –, but which should be displayed, because it is part\nof the prerequisite string from the sources.",
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Text"
+        },
+        "verification": {
+          "description": "The method how the prerequisite should be verified. Either is passes all\nverification text or it denies all verification tests. The latter results\nin the associated entry to never be available for purchase.",
+          "oneOf": [
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Pass"
+                }
+              },
+              "required": [
+                "tag"
+              ],
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "properties": {
+                "tag": {
+                  "const": "Deny"
+                }
+              },
+              "required": [
+                "tag"
+              ],
+              "additionalProperties": false
+            }
+          ]
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "type": "string",
+              "minLength": 1
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "tag",
+        "verification",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}