aspace_client 0.0.1

data/lib/aspace_client/schemas/accession_parts_relationship.rb

@@ -0,0 +1,31 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "subtype" => "ref",
+    "properties" => {
+      "relator" => {
+        "type" => "string",
+        "dynamic_enum" => "accession_parts_relator",
+        "ifmissing" => "error"
+      },
+
+      "relator_type" => {
+        "type" => "string",
+        "dynamic_enum" => "accession_parts_relator_type",
+        "ifmissing" => "error"
+      },
+
+      "ref" => {
+        "type" => "JSONModel(:accession) uri",
+        "ifmissing" => "error"
+      },
+
+      "_resolved" => {
+        "type" => "object",
+        "readonly" => "true"
+      }
+    }
+  }
+}

data/lib/aspace_client/schemas/accession_sibling_relationship.rb

@@ -0,0 +1,31 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "subtype" => "ref",
+    "properties" => {
+      "relator" => {
+        "type" => "string",
+        "dynamic_enum" => "accession_sibling_relator",
+        "ifmissing" => "error"
+      },
+
+      "relator_type" => {
+        "type" => "string",
+        "dynamic_enum" => "accession_sibling_relator_type",
+        "ifmissing" => "error"
+      },
+
+      "ref" => {
+        "type" => "JSONModel(:accession) uri",
+        "ifmissing" => "error"
+      },
+
+      "_resolved" => {
+        "type" => "object",
+        "readonly" => "true"
+      }
+    }
+  }
+}

data/lib/aspace_client/schemas/active_edits.rb

@@ -0,0 +1,23 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "uri" => "/update_monitor",
+    "type" => "object",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "active_edits" => {
+        "type" => "array",
+        "items" => {
+          "type" => "object",
+          "properties" => {
+            "user" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error"},
+            "uri" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error"},
+            "time" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error"},
+          }
+        }
+      }
+    },
+  },
+}

data/lib/aspace_client/schemas/advanced_query.rb

@@ -0,0 +1,12 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+
+      "query" => {"type" => ["JSONModel(:boolean_query) object", "JSONModel(:field_query) object", "JSONModel(:date_field_query) object", "JSONModel(:boolean_field_query) object"]},
+
+    },
+  },
+}

data/lib/aspace_client/schemas/agent_contact.rb

@@ -0,0 +1,25 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+
+    "properties" => {
+      "name" => {"type" => "string", "maxLength" => 65000, "ifmissing" => "error"},
+      "salutation" => {"type" => "string", "dynamic_enum" => "agent_contact_salutation"},
+      "address_1" => {"type" => "string", "maxLength" => 65000},
+      "address_2" => {"type" => "string", "maxLength" => 65000},
+      "address_3" => {"type" => "string", "maxLength" => 65000},
+      "city" => {"type" => "string", "maxLength" => 65000},
+      "region" => {"type" => "string", "maxLength" => 65000},
+      "country" => {"type" => "string", "maxLength" => 65000},
+      "post_code" => {"type" => "string", "maxLength" => 65000},
+      "telephone" => {"type" => "string", "maxLength" => 65000},
+      "telephone_ext" => {"type" => "string", "maxLength" => 65000},
+      "fax" => {"type" => "string", "maxLength" => 65000},
+      "email" => {"type" => "string", "maxLength" => 65000},
+      "email_signature" => {"type" => "string", "maxLength" => 65000},
+      "note" => {"type" => "string", "maxLength" => 65000},
+    },
+  },
+}

data/lib/aspace_client/schemas/agent_corporate_entity.rb

@@ -0,0 +1,32 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_agent",
+    "uri" => "/agents/corporate_entities",
+    "properties" => {
+      "names" => {
+        "type" => "array",
+        "items" => {"type" => "JSONModel(:name_corporate_entity) object"},
+        "ifmissing" => "error",
+        "minItems" => 1
+      },
+
+      "display_name" => {
+        "type" => "JSONModel(:name_corporate_entity) object",
+        "readonly" => true
+      },
+
+      "related_agents" => {
+        "type" => "array",
+        "items" => {
+          "type" => [{"type" => "JSONModel(:agent_relationship_subordinatesuperior) object"},
+                     {"type" => "JSONModel(:agent_relationship_earlierlater) object"},
+                     {"type" => "JSONModel(:agent_relationship_associative) object"}],
+        }
+      }
+    },
+
+  },
+}

data/lib/aspace_client/schemas/agent_family.rb

@@ -0,0 +1,29 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_agent",
+    "uri" => "/agents/families",
+    "properties" => {
+      "names" => {
+        "type" => "array",
+        "items" => {"type" => "JSONModel(:name_family) object"},
+        "ifmissing" => "error",
+        "minItems" => 1
+      },
+
+      "display_name" => {
+        "type" => "JSONModel(:name_family) object",
+        "readonly" => true
+      },
+
+      "related_agents" => {
+        "type" => "array",
+        "items" => {"type" => [{"type" => "JSONModel(:agent_relationship_earlierlater) object"},
+                               {"type" => "JSONModel(:agent_relationship_associative) object"}]},
+      }
+
+    },
+  },
+}

data/lib/aspace_client/schemas/agent_person.rb

@@ -0,0 +1,31 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_agent",
+    "uri" => "/agents/people",
+    "properties" => {
+      "names" => {
+        "type" => "array",
+        "items" => {"type" => "JSONModel(:name_person) object"},
+        "ifmissing" => "error",
+        "minItems" => 1
+      },
+
+      "display_name" => {
+        "type" => "JSONModel(:name_person) object",
+        "readonly" => true
+      },
+
+      "related_agents" => {
+        "type" => "array",
+        "items" => {
+          "type" => [{"type" => "JSONModel(:agent_relationship_parentchild) object"},
+                     {"type" => "JSONModel(:agent_relationship_earlierlater) object"},
+                     {"type" => "JSONModel(:agent_relationship_associative) object"}],
+        }
+      },
+    },
+  },
+}

data/lib/aspace_client/schemas/agent_relationship_associative.rb

@@ -0,0 +1,28 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "subtype" => "ref",
+    "parent" => "abstract_agent_relationship",
+    "properties" => {
+      "relator" => {
+        "type" => "string",
+        "dynamic_enum" => "agent_relationship_associative_relator",
+        "ifmissing" => "error"
+      },
+
+      "ref" => {
+        "type" => [{"type" => "JSONModel(:agent_person) uri"},
+                   {"type" => "JSONModel(:agent_family) uri"},
+                   {"type" => "JSONModel(:agent_corporate_entity) uri"}],
+        "ifmissing" => "error"
+      },
+
+      "_resolved" => {
+        "type" => "object",
+        "readonly" => "true"
+      }
+    }
+  }
+}

data/lib/aspace_client/schemas/agent_relationship_earlierlater.rb

@@ -0,0 +1,28 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_agent_relationship",
+    "subtype" => "ref",
+    "properties" => {
+      "relator" => {
+        "type" => "string",
+        "dynamic_enum" => "agent_relationship_earlierlater_relator",
+        "ifmissing" => "error"
+      },
+
+      "ref" => {
+        "type" => [{"type" => "JSONModel(:agent_person) uri"},
+                   {"type" => "JSONModel(:agent_corporate_entity) uri"},
+                   {"type" => "JSONModel(:agent_family) uri"}],
+        "ifmissing" => "error"
+      },
+
+      "_resolved" => {
+        "type" => "object",
+        "readonly" => "true"
+      }
+    }
+  }
+}

data/lib/aspace_client/schemas/agent_relationship_parentchild.rb

@@ -0,0 +1,26 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_agent_relationship",
+    "subtype" => "ref",
+    "properties" => {
+      "relator" => {
+        "type" => "string",
+        "dynamic_enum" => "agent_relationship_parentchild_relator",
+        "ifmissing" => "error"
+      },
+
+      "ref" => {
+        "type" => [{"type" => "JSONModel(:agent_person) uri"}],
+        "ifmissing" => "error"
+      },
+
+      "_resolved" => {
+        "type" => "object",
+        "readonly" => "true"
+      }
+    }
+  }
+}

data/lib/aspace_client/schemas/agent_relationship_subordinatesuperior.rb

@@ -0,0 +1,26 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_agent_relationship",
+    "subtype" => "ref",
+    "properties" => {
+      "relator" => {
+        "type" => "string",
+        "dynamic_enum" => "agent_relationship_subordinatesuperior_relator",
+        "ifmissing" => "error"
+      },
+
+      "ref" => {
+        "type" => [{"type" => "JSONModel(:agent_corporate_entity) uri"}],
+        "ifmissing" => "error"
+      },
+
+      "_resolved" => {
+        "type" => "object",
+        "readonly" => "true"
+      }
+    }
+  }
+}

data/lib/aspace_client/schemas/agent_software.rb

@@ -0,0 +1,22 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_agent",
+    "uri" => "/agents/software",
+    "properties" => {
+      "display_name" => {
+        "type" => "JSONModel(:name_software) object",
+        "readonly" => true
+      },
+
+      "names" => {
+        "type" => "array",
+        "items" => {"type" => "JSONModel(:name_software) object"},
+        "ifmissing" => "error",
+        "minItems" => 1
+      },
+    },
+  },
+}

data/lib/aspace_client/schemas/archival_object.rb

@@ -0,0 +1,60 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_archival_object",
+    "uri" => "/repositories/:repo_id/archival_objects",
+    "properties" => {
+      "ref_id" => {"type" => "string", "maxLength" => 255, "pattern" => "\\A[a-zA-Z0-9\\-_:\\.]*\\z"},
+      "component_id" => {"type" => "string", "maxLength" => 255, "required" => false, "default" => ""},
+
+      "level" => {"type" => "string", "ifmissing" => "error", "dynamic_enum" => "archival_record_level"},
+      "other_level" => {"type" => "string", "maxLength" => 255},
+
+      "title" => {"type" => "string", "maxLength" => 8192, "ifmissing" => nil},
+      "display_string" => {"type" => "string", "maxLength" => 8192, "readonly" => true},
+
+      "restrictions_apply" => {"type" => "boolean", "default" => false},
+      "repository_processing_note" => {"type" => "string", "maxLength" => 65000},
+
+      "parent" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {"type" => "JSONModel(:archival_object) uri"},
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          }
+        }
+      },
+
+      "resource" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {"type" => "JSONModel(:resource) uri"},
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          }
+        }
+      },
+
+      "position" => {"type" => "integer", "required" => false},
+
+      "instances" => {"type" => "array", "items" => {"type" => "JSONModel(:instance) object"}},
+
+      "notes" => {
+        "type" => "array",
+        "items" => {"type" => [{"type" => "JSONModel(:note_bibliography) object"},
+                               {"type" => "JSONModel(:note_index) object"},
+                               {"type" => "JSONModel(:note_multipart) object"},
+                               {"type" => "JSONModel(:note_singlepart) object"}]},
+      },
+
+      "has_unpublished_ancestor" => {"type" => "boolean", "readonly" => "true"},
+    },
+  },
+}

data/lib/aspace_client/schemas/archival_record_children.rb

@@ -0,0 +1,15 @@
+ {
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+
+      "children" => {
+        "type" => "array",
+        "items" => {"type" => "JSONModel(:archival_object) object"}
+      },
+
+    },
+  },
+}

data/lib/aspace_client/schemas/boolean_field_query.rb

@@ -0,0 +1,13 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+
+      "field" => {"type" => "string", "ifmissing" => "error"},
+      "value" => {"type" => "boolean", "ifmissing" => "error", "default" => true},
+
+    },
+  },
+}