@lincs.project/webannotation-schema 1.0.0

package/dist/defs.jsonld

@@ -0,0 +1,949 @@
+{
+  "$id": "https://wa.lincsproject.ca/v1/defs.jsonld",
+  "type": "object",
+  "definitions": {
+    "creator": {
+      "type": "object",
+      "description": "Software Agent",
+      "properties": {
+        "id": {
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "uri"
+            },
+            {
+              "type": "string",
+              "const": "anonymous"
+            }
+          ],
+          "description": "The URI that identifies the agent (Creator or Contributor)."
+        },
+        "type": {
+          "type": "string",
+          "const": "crm:E21_Person"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The name of the agent."
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "name"
+      ]
+    },
+    "software": {
+      "type": "object",
+      "description": "Software Agent",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uri",
+          "description": "The IRI that identifies the agent (software)."
+        },
+        "type": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": [
+            {
+              "type": "string",
+              "const": "Software"
+            },
+            {
+              "type": "string",
+              "const": "crm:P16_used_specific_object"
+            }
+          ],
+          "description": "The type of the Agent."
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The name of the software."
+        },
+        "softwareVersion": {
+          "type": "string",
+          "description": "The software version."
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "label"
+      ]
+    },
+    "target": {
+      "type": "object",
+      "description": "Web Annotation Target",
+      "properties": {
+        "id": {
+          "anyOf": [
+            {
+              "type": "string",
+              "format": "uri",
+              "description": "This document URI"
+            },
+            {
+              "type": "string",
+              "format": "uuid"
+            }
+          ],
+          "description": "The IRI that identifies the Target resource."
+        },
+        "type": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": [
+            {
+              "type": "string",
+              "const": "SpecificResource"
+            },
+            {
+              "type": "string",
+              "const": "crm:E73_Information_Object"
+            }
+          ],
+          "description": "The class of the Specific Resource."
+        },
+        "format": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The format of the Web Resource's content. The value of the property should be the media-type of the format, following the [rfc6838] specification."
+          },
+          "description": "The formats of the Web Resource's content. The value of the property should and array of  media-types of the format, following the [rfc6838] specification."
+        },
+        "language": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 2,
+            "maxLength": 3,
+            "description": "The language of the Web Resource's content. The value of the property should be a language code following the [bcp47] specification."
+          },
+          "minItems": 1,
+          "description": "The languages of the Web Resource's content. The value of the property should be an array of language code following the [bcp47] specification."
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The title of the document being annotated."
+        },
+        "renderedVia": {
+          "$ref": "defs.jsonld#/definitions/software",
+          "description": "The relationship between the Specific Resource that represents the Target in the annotation, and the piece of software or other system that was used to render the Target when the annotation was created."
+        },
+        "selector": {
+          "type": "object",
+          "oneOf": [
+            {
+              "$ref": "defs.jsonld#/definitions/textQuoteSelector"
+            },
+            {
+              "$ref": "defs.jsonld#/definitions/rangeSelector"
+            },
+            {
+              "$ref": "defs.jsonld#/definitions/xpathSelector"
+            },
+            {
+              "$ref": "defs.jsonld#/definitions/textPositionSelector"
+            }
+          ],
+          "description": "The relationship between a Specific Resource and a Selector. ",
+          "required": [
+            "id",
+            "type"
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "type"
+      ],
+      "allOf": [
+        {
+          "if": {
+            "type": "object",
+            "properties": {
+              "selector": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": [
+                      {
+                        "type": "string",
+                        "const": "TextQuoteSelector"
+                      },
+                      {
+                        "type": "string",
+                        "const": "crm:E33_Linguistic_Object"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          },
+          "then": {
+            "type": "object",
+            "properties": {
+              "selector": {
+                "type": "object",
+                "required": [
+                  "type",
+                  "exact"
+                ]
+              }
+            }
+          },
+          "required": [
+            "selector"
+          ]
+        },
+        {
+          "if": {
+            "type": "object",
+            "properties": {
+              "selector": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": [
+                      {
+                        "type": "string",
+                        "const": "RangeSelector"
+                      },
+                      {
+                        "type": "string",
+                        "const": "crm:E73_Information_Object"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          },
+          "then": {
+            "type": "object",
+            "properties": {
+              "selector": {
+                "type": "object",
+                "required": [
+                  "type",
+                  "startSelector",
+                  "endSelector"
+                ]
+              }
+            },
+            "required": [
+              "selector"
+            ]
+          }
+        },
+        {
+          "if": {
+            "type": "object",
+            "properties": {
+              "selector": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": [
+                      {
+                        "type": "string",
+                        "const": "XPathSelector"
+                      },
+                      {
+                        "type": "string",
+                        "const": "crm:E73_Information_Object"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          },
+          "then": {
+            "type": "object",
+            "properties": {
+              "selector": {
+                "type": "object",
+                "required": [
+                  "type",
+                  "value"
+                ]
+              }
+            },
+            "required": [
+              "selector"
+            ]
+          }
+        },
+        {
+          "if": {
+            "type": "object",
+            "properties": {
+              "selector": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": [
+                      {
+                        "type": "string",
+                        "const": "TextPositionSelector"
+                      },
+                      {
+                        "type": "string",
+                        "const": "crm:E73_Information_Object"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          },
+          "then": {
+            "type": "object",
+            "properties": {
+              "selector": {
+                "type": "object",
+                "required": [
+                  "type",
+                  "start",
+                  "end"
+                ]
+              }
+            },
+            "required": [
+              "selector"
+            ]
+          }
+        }
+      ]
+    },
+    "textQuoteSelector": {
+      "type": "object",
+      "description": "Quote Selector",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "UUID that identifies the selector."
+        },
+        "type": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": [
+            {
+              "type": "string",
+              "const": "TextQuoteSelector"
+            },
+            {
+              "type": "string",
+              "const": "crm:E33_Linguistic_Object"
+            }
+          ],
+          "description": "The class of the Selector"
+        },
+        "exact": {
+          "type": "string",
+          "description": "A copy of the text which is being selected, after normalization."
+        },
+        "prefix": {
+          "type": "string",
+          "description": "The snippet of text that occurs immediately before the text which is being selected."
+        },
+        "sufix": {
+          "type": "string",
+          "description": "The snippet of text that occurs immediately after the text which is being selected."
+        },
+        "refinedBy": {
+          "type": "object",
+          "description": "The relationship between a broader selector and the more specific selector that should be applied to the results of the first.",
+          "oneOf": [
+            {
+              "$ref": "defs.jsonld#/definitions/rangeSelector"
+            },
+            {
+              "$ref": "defs.jsonld#/definitions/xpathSelector"
+            },
+            {
+              "$ref": "defs.jsonld#/definitions/textPositionSelector"
+            }
+          ],
+          "required": []
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "exact"
+      ]
+    },
+    "rangeSelector": {
+      "type": "object",
+      "description": "Range Selector",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "UUID that identifies the selector."
+        },
+        "type": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": [
+            {
+              "type": "string",
+              "const": "RangeSelector"
+            },
+            {
+              "type": "string",
+              "const": "crm:E73_Information_Object"
+            }
+          ],
+          "description": "The class of the Selector,"
+        },
+        "startSelector": {
+          "$ref": "defs.jsonld#/definitions/xpathSelector"
+        },
+        "endSelector": {
+          "$ref": "defs.jsonld#/definitions/xpathSelector"
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "startSelector",
+        "endSelector"
+      ]
+    },
+    "xpathSelector": {
+      "type": "object",
+      "description": "Xpath Selector",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "UUID that identifies the selector."
+        },
+        "type": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": [
+            {
+              "type": "string",
+              "const": "XPathSelector"
+            },
+            {
+              "type": "string",
+              "const": "crm:E73_Information_Object"
+            }
+          ],
+          "description": "The class of the Selector,"
+        },
+        "value": {
+          "type": "string",
+          "description": "Web Annotation Target Select Xpath"
+        },
+        "refinedBy": {
+          "$ref": "defs.jsonld#/definitions/textPositionSelector",
+          "description": "The relationship between a broader selector and the more specific selector that should be applied to the results of the first."
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "value"
+      ]
+    },
+    "textPositionSelector": {
+      "type": "object",
+      "description": "TextPosition Selector",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "UUID that identifies the selector."
+        },
+        "type": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": [
+            {
+              "type": "string",
+              "const": "TextPositionSelector"
+            },
+            {
+              "type": "string",
+              "const": "crm:E73_Information_Object"
+            }
+          ],
+          "description": "The class of the Selector."
+        },
+        "start": {
+          "type": "number",
+          "minimum": 0,
+          "description": "The starting position of the segment. The first byte is character position 0."
+        },
+        "end": {
+          "type": "number",
+          "minimum": 0,
+          "description": "The end position of the segment. The last character is not included within the segment."
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "start",
+        "end"
+      ]
+    },
+    "body": {
+      "type": "object",
+      "description": "Web Annotation Body",
+      "properties": {
+        "id": {
+          "oneOf": [
+            {
+              "type": "string",
+              "format": "uri",
+              "description": "The IRI that identifies the Body resource"
+            },
+            {
+              "type": "string",
+              "format": "uuid"
+            }
+          ]
+        },
+        "type": {
+          "type": "string",
+          "const": "TextualBody"
+        },
+        "entityType": {
+          "oneOf": [
+            {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2,
+              "items": [
+                {
+                  "type": "string",
+                  "const": "Person"
+                },
+                {
+                  "oneOf": [
+                    {
+                      "type": "string",
+                      "const": "crm:E21_Person",
+                      "description": "Real Person"
+                    },
+                    {
+                      "type": "string",
+                      "const": "crm:E89_Propositional_Object",
+                      "description": "Fictional Person"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "oneOf": [
+                {
+                  "type": "string",
+                  "const": "cwrc:place"
+                },
+                {
+                  "type": "array",
+                  "minItems": 2,
+                  "maxItems": 2,
+                  "items": [
+                    {
+                      "type": "string",
+                      "const": "cwrc:place"
+                    },
+                    {
+                      "type": "string",
+                      "const": "crm:E89_Propositional_Object",
+                      "description": "Fictional Place"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2,
+              "items": [
+                {
+                  "type": "string",
+                  "const": "foaf:Organization"
+                },
+                {
+                  "oneOf": [
+                    {
+                      "type": "string",
+                      "const": "crm:E74_Group",
+                      "description": "Real Organization"
+                    },
+                    {
+                      "type": "string",
+                      "const": "crm:E89_Propositional_Object",
+                      "description": "Fictional Organization"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2,
+              "items": [
+                {
+                  "type": "string",
+                  "const": "crm:E89_Propositional_Object"
+                },
+                {
+                  "oneOf": [
+                    {
+                      "type": "string",
+                      "const": "frbroo:F1",
+                      "description": "Real Work"
+                    },
+                    {
+                      "type": "string",
+                      "const": "wikidata:Q15306849",
+                      "description": "Fictional Work"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "oneOf": [
+                {
+                  "type": "string",
+                  "const": "crm:E18_Physical_Thing"
+                },
+                {
+                  "type": "array",
+                  "minItems": 2,
+                  "maxItems": 2,
+                  "items": [
+                    {
+                      "type": "string",
+                      "const": "crm:E18_Physical_Thing"
+                    },
+                    {
+                      "type": "string",
+                      "const": "wikidata:Q15831596",
+                      "description": "Fictional Physical Thing"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "oneOf": [
+                {
+                  "type": "string",
+                  "const": "crm:E28_Conceptual_Object"
+                },
+                {
+                  "type": "array",
+                  "minItems": 2,
+                  "maxItems": 2,
+                  "items": [
+                    {
+                      "type": "string",
+                      "const": "crm:E28_Conceptual_Object"
+                    },
+                    {
+                      "type": "string",
+                      "const": "wikidata:Q15831596",
+                      "description": "Fictional Conceptual Object"
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2,
+              "items": [
+                {
+                  "type": "string",
+                  "const": "cito:Citation"
+                },
+                {
+                  "type": "string",
+                  "const": "crm:E73_Information_Object"
+                }
+              ]
+            },
+            {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2,
+              "items": [
+                {
+                  "type": "string",
+                  "const": "xsd:date"
+                },
+                {
+                  "type": "string",
+                  "const": "crm:E52_Time-Span"
+                }
+              ]
+            },
+            {
+              "type": "string",
+              "const": "crm:E33_Linguistic_Object"
+            },
+            {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2,
+              "items": [
+                {
+                  "type": "string",
+                  "const": "fabio:Correction"
+                },
+                {
+                  "type": "string",
+                  "const": "crm:E33_Linguistic_Object"
+                }
+              ]
+            },
+            {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2,
+              "items": [
+                {
+                  "type": "string",
+                  "const": "crm:E55_Type"
+                },
+                {
+                  "type": "string",
+                  "const": "crmdig:D1_Digital_Object"
+                }
+              ]
+            },
+            {
+              "type": "array",
+              "minItems": 2,
+              "maxItems": 2,
+              "items": [
+                {
+                  "type": "string",
+                  "const": "crm:E55_Type"
+                },
+                {
+                  "type": "string",
+                  "const": "crm:E33_Linguistic_Object"
+                }
+              ]
+            },
+            {
+              "type": "string",
+              "const": "crmdig:D1_Digital_Object"
+            }
+          ]
+        },
+        "additionalType": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
+        },
+        "value": {
+          "type": "string"
+        },
+        "certainty": {
+          "type": "string",
+          "enum": [
+            "edit:qualityLow",
+            "edit:qualityMedium",
+            "edit:qualityHigh",
+            "edit:qualityUnknown"
+          ],
+          "description": "Indicates the degree of certainty associated with some aspect of an assertion, description, identification, or entity linked to the annotation body."
+        },
+        "precision": {
+          "type": "string",
+          "enum": [
+            "edit:qualityLow",
+            "edit:qualityMedium",
+            "edit:qualityHigh",
+            "edit:qualityUnknown"
+          ],
+          "description": "Indicates the degree of precision associated with the location of the entity linked to the annotation body."
+        },
+        "label": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The title or name of a linked resource or named entity."
+        },
+        "description": {
+          "type": "string",
+          "description": "Short description of the linked resources or named entity."
+        }
+      },
+      "required": [
+        "id",
+        "entityType"
+      ],
+      "anyOf": [
+        {
+          "if": {
+            "type": "object",
+            "properties": {
+              "entityType": {
+                "anyOf": [
+                  {
+                    "const": "crm:E33_Linguistic_Object"
+                  },
+                  {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": [
+                      {
+                        "const": "xsd:date"
+                      },
+                      {
+                        "const": "crm:E52_Time-Span"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": [
+                      {
+                        "const": "fabio:Correction"
+                      },
+                      {
+                        "const": "crm:E33_Linguistic_Object"
+                      }
+                    ]
+                  },
+                  {
+                    "type": "array",
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "items": [
+                      {
+                        "const": "crm:E55_Type"
+                      },
+                      {
+                        "const": "crm:E33_Linguistic_Object"
+                      }
+                    ]
+                  }
+                ]
+              }
+            }
+          },
+          "then": {
+            "type": "object",
+            "required": [
+              "type",
+              "value"
+            ],
+            "properties": {
+              "id": {
+                "type": "string",
+                "format": "uuid"
+              },
+              "type": {
+                "type": "string",
+                "const": "TextualBody"
+              }
+            },
+            "if": {
+              "type": "object",
+              "properties": {
+                "entityType": {
+                  "type": "array",
+                  "minItems": 2,
+                  "maxItems": 2,
+                  "items": [
+                    {
+                      "const": "xsd:date"
+                    },
+                    {
+                      "const": "crm:E52_Time-Span"
+                    }
+                  ]
+                }
+              }
+            },
+            "then": {
+              "type": "object",
+              "properties": {
+                "value": {
+                  "type": "string",
+                  "pattern": "^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}(?:.\\d*)?)((-(\\d{2}):(\\d{2})|Z)?)\\/(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}(?:.\\d*)?)((-(\\d{2}):(\\d{2})|Z)?)$"
+                }
+              }
+            },
+            "else": {
+              "type": "object",
+              "properties": {
+                "value": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "else": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "format": "uri"
+              }
+            }
+          }
+        }
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": []
+}