aspace_client 0.0.1

data/lib/aspace_client/schemas/digital_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(:digital_object_component) object"}
+      },
+
+    },
+  },
+}

data/lib/aspace_client/schemas/enumeration.rb

@@ -0,0 +1,29 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/config/enumerations",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "name" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error"},
+      "default_value" => {"type" => "string"},
+      "editable" => {"type" => "boolean", "readonly" => true},
+      "values" => {
+        "type" => "array",
+        "ifmissing" => "error",
+        "items" => {
+          "type" => "string",
+        }
+      },
+      "readonly_values" => {
+        "type" => "array",
+        "readonly" => true,
+        "items" => {
+          "type" => "string",
+        }
+      }
+    },
+  },
+}

data/lib/aspace_client/schemas/enumeration_migration.rb

@@ -0,0 +1,14 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/config/enumerations/migration",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+      "enum_uri" => {"type" => "JSONModel(:enumeration) uri", "ifmissing" => "error"},
+      "from" => {"type" => "string", "ifmissing" => "error"},
+      "to" => {"type" => "string", "ifmissing" => "error"},
+    },
+  },
+}

data/lib/aspace_client/schemas/event.rb

@@ -0,0 +1,88 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/:repo_id/events",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "external_ids" => {"type" => "array", "items" => {"type" => "JSONModel(:external_id) object"}},
+
+      "event_type" => {
+        "type" => "string",
+        "ifmissing" => "error",
+        "dynamic_enum" => "event_event_type"
+      },
+
+      "date" => {"type" => "JSONModel(:date) object"},
+      "timestamp" => {"type" => "string"},
+      "outcome" => {"type" => "string", "dynamic_enum" => "event_outcome"},
+      "outcome_note" => {"type" => "string", "maxLength" => 16384},
+
+      "suppressed" => {"type" => "boolean"},
+
+      "linked_agents" => {
+        "type" => "array",
+        "ifmissing" => "error",
+        "minItems" => 1,
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "role" => {
+              "type" => "string",
+              "dynamic_enum" => "linked_agent_event_roles",
+              "ifmissing" => "error",
+            },
+            "ref" => {"type" => [
+                                 {"type" => "JSONModel(:agent_corporate_entity) uri"},
+                                 {"type" => "JSONModel(:agent_family) uri"},
+                                 {"type" => "JSONModel(:agent_person) uri"},
+                                 {"type" => "JSONModel(:agent_software) uri"}],
+              "ifmissing" => "error"},
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+      "linked_records" => {
+        "type" => "array",
+        "ifmissing" => "error",
+        "minItems" => 1,
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "role" => {
+              "type" => "string",
+              "dynamic_enum" => "linked_event_archival_record_roles",
+              "ifmissing" => "error",
+            },
+            "ref" => {
+              "type" => [{"type" => "JSONModel(:agent_person) uri"},
+                         {"type" => "JSONModel(:agent_family) uri"},
+                         {"type" => "JSONModel(:agent_corporate_entity) uri"},
+                         {"type" => "JSONModel(:agent_software) uri"},
+                         {"type" => "JSONModel(:accession) uri"},
+                         {"type" => "JSONModel(:resource) uri"},
+                         {"type" => "JSONModel(:digital_object) uri"},
+                         {"type" => "JSONModel(:archival_object) uri"},
+                         {"type" => "JSONModel(:digital_object_component) uri"}],
+              "ifmissing" => "error"
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+      "suppressed" => {"type" => "boolean", "readonly" => "true"},
+    },
+  }
+}

data/lib/aspace_client/schemas/extent.rb

@@ -0,0 +1,17 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+
+    "properties" => {
+      "portion" => {"type" => "string", "minLength" => 1, "ifmissing" => "error", "dynamic_enum" => "extent_portion"},
+      "number" => {"type" => "string", "maxLength" => 255, "minLength" => 1, "ifmissing" => "error"},
+      "extent_type" => {"type" => "string", "minLength" => 1, "ifmissing" => "error", "dynamic_enum" => "extent_extent_type"},
+
+      "container_summary" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "physical_details" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "dimensions" => {"type" => "string", "maxLength" => 255, "required" => false},
+    },
+  },
+}

data/lib/aspace_client/schemas/external_document.rb

@@ -0,0 +1,12 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "title" => {"type" => "string", "maxLength" => 16384, "ifmissing" => "error", "minLength" => 1},
+      "location" => {"type" => "string", "maxLength" => 16384, "ifmissing" => "error", "default" => ""},
+      "publish" => {"type" => "boolean"},
+    },
+  },
+}

data/lib/aspace_client/schemas/external_id.rb

@@ -0,0 +1,11 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "external_id" => {"type" => "string", "maxLength" => 255},
+      "source" => {"type" => "string", "maxLength" => 255},
+    }
+  },
+}

data/lib/aspace_client/schemas/field_query.rb

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

data/lib/aspace_client/schemas/file_version.rb

@@ -0,0 +1,26 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "identifier" => {"type" => "string", "readonly" => true},
+      "file_uri" => {"type" => "string", "maxLength" => 16384, "ifmissing" => "error"},
+      "publish" => {"type" => "boolean"},
+      "use_statement" => {"type" => "string", "dynamic_enum" => "file_version_use_statement"},
+
+      "xlink_actuate_attribute" => {"type" => "string", "dynamic_enum" => "file_version_xlink_actuate_attribute"},
+
+      "xlink_show_attribute" => {"type" => "string", "dynamic_enum" => "file_version_xlink_show_attribute"},
+
+
+      "file_format_name" => {"type" => "string", "dynamic_enum" => "file_version_file_format_name"},
+      "file_format_version" => {"type" => "string", "maxLength" => 255},
+      "file_size_bytes" => {"type" => "integer"},
+
+      "checksum" => {"type" => "string", "maxLength" => 255},
+      "checksum_method" => {"type" => "string", "dynamic_enum" => "file_version_checksum_methods"},
+
+    },
+  },
+}

data/lib/aspace_client/schemas/group.rb

@@ -0,0 +1,17 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/:repo_id/groups",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "group_code" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error", "minLength" => 1},
+      "description" => {"type" => "string", "maxLength" => 65000, "ifmissing" => "error", "default" => ""},
+
+      "member_usernames" => {"type" => "array", "items" => {"type" => "string", "minLength" => 1}},
+      "grants_permissions" => {"type" => "array", "items" => {"type" => "string", "minLength" => 1}},
+    },
+  },
+}

data/lib/aspace_client/schemas/instance.rb

@@ -0,0 +1,27 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "instance_type" => {"type" => "string", "minLength" => 1, "ifmissing" => "error", "dynamic_enum" => "instance_instance_type"},
+
+      "container" => {"type" => "JSONModel(:container) object"},
+
+      "digital_object" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {
+            "type" => "JSONModel(:digital_object) uri",
+            "ifmissing" => "error"
+          },
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          }
+        }
+      },
+    },
+  },
+}

data/lib/aspace_client/schemas/job.rb

@@ -0,0 +1,57 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/:repo_id/jobs",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "filenames" => {
+        "type" => "array",
+        "ifmissing" => "error",
+        "minItems" => 1,
+        "items" => {
+          "type" => "string",
+        }
+      },
+
+      "time_submitted" => {
+        "type" => "date-time",
+        "readonly" => true
+      },
+
+      "time_started" => {
+        "type" => "date-time",
+        "readonly" => true
+      },
+
+      "time_finished" => {
+        "type" => "date-time",
+        "readonly" => true
+      },
+
+      "owner" => {
+        "type" => "string",
+        "readonly" => true
+      },
+
+      "status" => {
+        "type" => "string",
+        "enum" => ["running", "completed", "canceled", "queued", "failed"],
+        "default" => "queued",
+        "readonly" => true
+      },
+
+      "import_type" => {
+        "type" => "string",
+        "ifmissing" => "error"
+      },
+
+      "queue_position" => {
+        "type" => "number",
+        "readonly" => true
+      }
+    },
+  },
+}

data/lib/aspace_client/schemas/location.rb

@@ -0,0 +1,36 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/locations",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "title" => {"type" => "string", "readonly" => true},
+
+      "external_ids" => {"type" => "array", "items" => {"type" => "JSONModel(:external_id) object"}},
+
+      "building" => {"type" => "string", "maxLength" => 255, "minLength" => 1, "ifmissing" => "error"},
+
+      "floor" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "room" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "area" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "barcode" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "classification" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "coordinate_1_label" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "coordinate_1_indicator" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "coordinate_2_label" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "coordinate_2_indicator" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "coordinate_3_label" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "coordinate_3_indicator" => {"type" => "string", "maxLength" => 255, "required" => false},
+
+      "temporary" => {"type" => "string", "dynamic_enum" => "location_temporary"},
+
+    },
+  },
+}

data/lib/aspace_client/schemas/location_batch.rb

@@ -0,0 +1,45 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "location",
+    "properties" => {
+
+      "coordinate_1_range" => {
+        "type" => "object",
+        "ifmissing" => "error",
+        "properties" => {
+          "label" => {"type" => "string", "ifmissing" => "error"},
+          "start" => {"type" => "string", "ifmissing" => "error", "minLength" => 1},
+          "end" => {"type" => "string", "ifmissing" => "error", "minLength" => 1},
+          "prefix" => {"type" => "string"},
+          "suffix" => {"type" => "string"},
+        }
+      },
+
+      "coordinate_2_range" => {
+        "type" => "object",
+        "properties" => {
+          "label" => {"type" => "string", "ifmissing" => "error"},
+          "start" => {"type" => "string", "ifmissing" => "error", "minLength" => 1},
+          "end" => {"type" => "string", "ifmissing" => "error", "minLength" => 1},
+          "prefix" => {"type" => "string"},
+          "suffix" => {"type" => "string"},
+        }
+      },
+
+      "coordinate_3_range" => {
+        "type" => "object",
+        "properties" => {
+          "label" => {"type" => "string", "ifmissing" => "error"},
+          "start" => {"type" => "string", "ifmissing" => "error", "minLength" => 1},
+          "end" => {"type" => "string", "ifmissing" => "error", "minLength" => 1},
+          "prefix" => {"type" => "string"},
+          "suffix" => {"type" => "string"},
+        }
+      }
+
+    },
+  },
+}

data/lib/aspace_client/schemas/merge_request.rb

@@ -0,0 +1,48 @@
+MERGEABLE_TYPES = [
+                   {"type" => "JSONModel(:subject) uri"},
+                   {"type" => "JSONModel(:agent_person) uri"},
+                   {"type" => "JSONModel(:agent_corporate_entity) uri"},
+                   {"type" => "JSONModel(:agent_software) uri"},
+                   {"type" => "JSONModel(:agent_family) uri"},
+                   {"type" => "JSONModel(:resource) uri"},
+                   {"type" => "JSONModel(:digital_object) uri"}
+                  ]
+
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "uri" => "/merge_requests/:record_type",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "target" => {
+        "type" => "object",
+        "ifmissing" => "error",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {
+            "type" => MERGEABLE_TYPES,
+            "ifmissing" => "error"
+          },
+        }
+      },
+
+      "victims" => {
+        "type" => "array",
+        "minItems" => 1,
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {
+              "type" => MERGEABLE_TYPES,
+              "ifmissing" => "error"
+            },
+          }
+        }
+      },
+    },
+  },
+}