aspace_client 0.0.1

data/lib/aspace_client/schemas/note_text.rb

@@ -0,0 +1,17 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+
+    "properties" => {
+      "content" => {
+        "type" => "string",
+        "maxLength" => 65000,
+        "ifmissing" => "error",
+      },
+
+      "publish" => {"type" => "boolean"},
+    },
+  },
+}

data/lib/aspace_client/schemas/permission.rb

@@ -0,0 +1,15 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/permissions",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "permission_code" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error", "minLength" => 1},
+      "description" => {"type" => "string", "maxLength" => 65000, "ifmissing" => "error", "minLength" => 1},
+      "level" => {"type" => "string", "ifmissing" => "error", "enum" => ["repository", "global"]},
+    },
+  },
+}

data/lib/aspace_client/schemas/preference.rb

@@ -0,0 +1,16 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/:repo_id/preferences",
+
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "user_id" => {"type" => "integer"},
+
+      "defaults" => {"type" => "JSONModel(:defaults) object"},
+    },
+  },
+}

data/lib/aspace_client/schemas/record_tree.rb

@@ -0,0 +1,17 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+      "id" => {"type" => "integer", "ifmissing" => "error"},
+      "record_uri" => {"type" => "string", "ifmissing" => "error"},
+      "title" => {"type" => "string", "minLength" => 1, "required" => false, "maxLength" => 16384},
+      "suppressed" => {"type" => "boolean", "default" => false},
+      "publish" => {"type" => "boolean"},
+      "has_children" => {"type" => "boolean", "readonly" => true},
+      "node_type" => {"type" => "string", "maxLength" => 255},
+    },
+  },
+}

data/lib/aspace_client/schemas/repository.rb

@@ -0,0 +1,32 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "repo_code" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error", "minLength" => 1},
+      "name" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error", "default" => ""},
+      "org_code" => {"type" => "string", "maxLength" => 255},
+      "country" => {"type" => "string", "required" => false, "dynamic_enum" => "country_iso_3166"},
+      "parent_institution_name" => {"type" => "string", "maxLength" => 255},
+      "url" => {"type" => "string", "maxLength" => 255, "pattern" => "\\Ahttps?:\\/\\/[\\\S]+\\z"},
+      "image_url" => {"type" => "string", "maxLength" => 255, "pattern" => "\\Ahttps?:\\/\\/[\\\S]+\\z"},
+      "contact_persons" => {"type" => "string", "maxLength" => 65000},
+
+      "agent_representation" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {
+            "type" => "JSONModel(:agent_corporate_entity) uri",
+            "ifmissing" => "error",
+            "readonly" => "true"
+          }
+        }
+      },
+    },
+  },
+}

data/lib/aspace_client/schemas/repository_with_agent.rb

@@ -0,0 +1,14 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/with_agent",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "repository" => {"type" => "JSONModel(:repository) object", "ifmissing" => "error"},
+      "agent_representation" => {"type" => "JSONModel(:agent_corporate_entity) object"},
+    },
+  },
+}

data/lib/aspace_client/schemas/resource.rb

@@ -0,0 +1,112 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_archival_object",
+    "uri" => "/repositories/:repo_id/resources",
+    "properties" => {
+
+      "id_0" => {"type" => "string", "ifmissing" => "error", "maxLength" => 255},
+      "id_1" => {"type" => "string", "maxLength" => 255},
+      "id_2" => {"type" => "string", "maxLength" => 255},
+      "id_3" => {"type" => "string", "maxLength" => 255},
+
+      "level" => {"type" => "string", "ifmissing" => "error", "dynamic_enum" => "archival_record_level"},
+      "other_level" => {"type" => "string", "maxLength" => 255},
+
+      "language" => {"ifmissing" => "warn"},
+
+      "resource_type" => {"type" => "string", "dynamic_enum" => "resource_resource_type"},
+      "tree" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {
+              "type" => "JSONModel(:resource_tree) uri",
+              "ifmissing" => "error"
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+      },
+
+      "restrictions" => {"type" => "boolean", "default" => false},
+
+      "repository_processing_note" => {"type" => "string", "maxLength" => 65000},
+
+      "ead_id" => {"type" => "string", "maxLength" => 255},
+      "ead_location" => {"type" => "string", "maxLength" => 255},
+
+      # Finding aid
+      "finding_aid_title" => {"type" => "string", "maxLength" => 65000},
+      "finding_aid_filing_title" => {"type" => "string", "maxLength" => 65000},
+      "finding_aid_date" => {"type" => "string", "maxLength" => 255},
+      "finding_aid_author" => {"type" => "string", "maxLength" => 65000},
+      "finding_aid_description_rules" => {"type" => "string", "dynamic_enum" => "resource_finding_aid_description_rules"},
+      "finding_aid_language" => {"type" => "string", "maxLength" => 255},
+      "finding_aid_sponsor" => {"type" => "string", "maxLength" => 65000},
+      "finding_aid_edition_statement" => {"type" => "string", "maxLength" => 65000},
+      "finding_aid_series_statement" => {"type" => "string", "maxLength" => 65000},
+      "finding_aid_revision_date" => {"type" => "string", "maxLength" => 255},
+      "finding_aid_revision_description" => {"type" => "string", "maxLength" => 65000},
+      "finding_aid_status" => {"type" => "string", "dynamic_enum" => "resource_finding_aid_status"},
+      "finding_aid_note" => {"type" => "string", "maxLength" => 65000},
+
+      # Extents (overrides abstract schema)
+      "extents" => {"type" => "array", "ifmissing" => "error", "minItems" => 1, "items" => {"type" => "JSONModel(:extent) object"}},
+      
+      # Dates (overrides abstract schema)
+      "dates" => {"type" => "array", "ifmissing" => "error", "minItems" => 1, "items" => {"type" => "JSONModel(:date) object"}},
+
+      "instances" => {"type" => "array", "items" => {"type" => "JSONModel(:instance) object"}},
+      "deaccessions" => {"type" => "array", "items" => {"type" => "JSONModel(:deaccession) object"}},
+      "collection_management" => {"type" => "JSONModel(:collection_management) object"},
+      "user_defined" => {"type" => "JSONModel(:user_defined) object"},
+
+      "related_accessions" => {
+        "type" => "array",
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {"type" => [{"type" => "JSONModel(:accession) uri"}],
+                      "ifmissing" => "error"},
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+
+      "classification" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {
+            "type" => [{"type" => "JSONModel(:classification) uri"},
+                       {"type" => "JSONModel(:classification_term) uri"}],
+            "ifmissing" => "error"
+          },
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          }
+        }
+      },
+
+      "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"}]},
+      },
+
+    },
+  },
+}

data/lib/aspace_client/schemas/resource_tree.rb

@@ -0,0 +1,20 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/:repo_id/resources/:resource_id/tree",
+    "parent" => "record_tree",
+    "properties" => {
+      "finding_aid_filing_title" => {"type" => "string", "maxLength" => 65000},
+      "level" => {"type" => "string", "maxLength" => 255},
+      "instance_types" => {"type" => "array", "items" => {"type" => "string"}},
+      "containers" => {"type" => "array", "items" => {"type" => "object"}},
+      "children" => {
+        "type" => "array",
+        "additionalItems" => false,
+        "items" => { "type" => "JSONModel(:resource_tree) object" }
+      }
+    },
+  },
+}

data/lib/aspace_client/schemas/rights_statement.rb

@@ -0,0 +1,35 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+
+    "properties" => {
+      "rights_type" => {"type" => "string", "minLength" => 1, "ifmissing" => "error", "dynamic_enum" => "rights_statement_rights_type"},
+      "identifier" => {"type" => "string", "maxLength" => 255, "minLength" => 1, "required" => false},
+
+      "active" => {"type" => "boolean", "default" => true},
+
+      "materials" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "ip_status" => {"type" => "string", "required" => false, "dynamic_enum" => "rights_statement_ip_status"},
+      "ip_expiration_date" => {"type" => "date", "required" => false},
+
+      "license_identifier_terms" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "statute_citation" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "jurisdiction" => {"type" => "string", "required" => false, "dynamic_enum" => "country_iso_3166"},
+      "type_note" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "permissions" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "restrictions" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "restriction_start_date" => {"type" => "date", "required" => false},
+      "restriction_end_date" => {"type" => "date", "required" => false},
+
+      "granted_note" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "external_documents" => {"type" => "array", "items" => {"type" => "JSONModel(:external_document) object"}},
+    },
+  },
+}

data/lib/aspace_client/schemas/subject.rb

@@ -0,0 +1,30 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/subjects",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "title" => {"type" => "string", "readonly" => true},
+
+      "external_ids" => {"type" => "array", "items" => {"type" => "JSONModel(:external_id) object"}},
+
+      "is_linked_to_published_record" => {"type" => "boolean", "readonly" => true},
+
+      "publish" => {"type" => "boolean", "default" => true, "readonly" => true},
+
+      "source" => {"type" => "string",  "dynamic_enum" => "subject_source", "ifmissing" => "error"},
+
+      "scope_note" => {"type" => "string"},
+
+      "terms" => {"type" => "array", "items" => {"type" => "JSONModel(:term) uri_or_object"}, "ifmissing" => "error", "minItems" => 1},
+
+      "vocabulary" => {"type" => "JSONModel(:vocabulary) uri", "ifmissing" => "error"},
+      "authority_id" => {"type" => "string", "maxLength" => 255},
+
+      "external_documents" => {"type" => "array", "items" => {"type" => "JSONModel(:external_document) object"}},
+    },
+  },
+}

data/lib/aspace_client/schemas/term.rb

@@ -0,0 +1,16 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/terms",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "term" => {"type" => "string", "maxLength" => 255, "minLength" => 1, "ifmissing" => "error"},
+      "term_type" => {"type" => "string", "minLength" => 1, "ifmissing" => "error", "dynamic_enum" => "subject_term_type"},
+
+      "vocabulary" => {"type" => "JSONModel(:vocabulary) uri", "ifmissing" => "error"}
+    },
+  },
+}

data/lib/aspace_client/schemas/user.rb

@@ -0,0 +1,56 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/users",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "username" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error", "minLength" => 1},
+      "name" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error", "minLength" => 1},
+
+      "is_system_user" => {"type" => "boolean", "readonly" => true},
+
+      "permissions" => {
+        "type" => "object",
+        "readonly" => true,
+      },
+
+      "groups" => {
+        "type" => "array",
+        "items" => {
+          "type" => "JSONModel(:group) uri"
+        }
+      },
+
+      "email" => {"type" => "string", "maxLength" => 255},
+      "first_name" => {"type" => "string", "maxLength" => 255},
+      "last_name" => {"type" => "string", "maxLength" => 255},
+      "telephone" => {"type" => "string", "maxLength" => 255},
+      "title" => {"type" => "string", "maxLength" => 255},
+      "department" => {"type" => "string", "maxLength" => 255},
+      "additional_contact" => {"type" => "string", "maxLength" => 65000},
+
+      "agent_record" => {
+        "type" => "object",
+        "readonly" => true,
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {
+            "type" => [{"type" => "JSONModel(:agent_person) uri"}, {"type" => "JSONModel(:agent_software) uri"}]
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+      },
+
+      "is_admin" => {
+        "type" => "boolean",
+        "default" => false
+      }
+    },
+  },
+}

data/lib/aspace_client/schemas/user_defined.rb

@@ -0,0 +1,42 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+
+    "properties" => {
+
+      "boolean_1" => {"type" => "boolean", "default" => false},
+      "boolean_2" => {"type" => "boolean", "default" => false},
+      "boolean_3" => {"type" => "boolean", "default" => false},
+
+      "integer_1" => {"type" => "string", "maxlength" => 255, "required" => false},
+      "integer_2" => {"type" => "string", "maxlength" => 255, "required" => false},
+      "integer_3" => {"type" => "string", "maxlength" => 255, "required" => false},
+
+      "real_1" => {"type" => "string", "maxlength" => 13, "required" => false},
+      "real_2" => {"type" => "string", "maxlength" => 13, "required" => false},
+      "real_3" => {"type" => "string", "maxlength" => 13, "required" => false},
+
+      "string_1" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "string_2" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "string_3" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "string_4" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "text_1" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "text_2" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "text_3" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "text_4" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "text_5" => {"type" => "string", "maxLength" => 65000, "required" => false},
+
+      "date_1" => {"type" => "date", "required" => false},
+      "date_2" => {"type" => "date", "required" => false},
+      "date_3" => {"type" => "date", "required" => false},
+
+      "enum_1" => {"type" => "string", "dynamic_enum" => "user_defined_enum_1"},
+      "enum_2" => {"type" => "string", "dynamic_enum" => "user_defined_enum_2"},
+      "enum_3" => {"type" => "string", "dynamic_enum" => "user_defined_enum_3"},
+      "enum_4" => {"type" => "string", "dynamic_enum" => "user_defined_enum_4"},
+    },
+  },
+}

data/lib/aspace_client/schemas/vocabulary.rb

@@ -0,0 +1,15 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/vocabularies",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+      "ref_id" => {"type" => "string", "maxLength" => 255, "minLength" => 1, "ifmissing" => "error"},
+      "name" => {"type" => "string", "maxLength" => 255, "minLength" => 1, "ifmissing" => "error"},
+
+      "terms" => {"type" => "array", "items" => {"type" => "JSONModel(:term) uri"}, "readonly" => true},
+    },
+  },
+}