Skip to content
Snippets Groups Projects
Commit e79936f8 authored by Justin Ehlert's avatar Justin Ehlert
Browse files

Refactor JSON Schemas and remove ABAO

parent 68a07fb0
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 730 additions and 172 deletions
raml/schemas/definitions/collection.json
+ 23
− 30
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions":{
"curator":{"$ref":"../definitions/user.json#/definitions/_id"},
"description": {"type": "string"},
"collection-input":{
"type": "object",
"properties": {
"public": {"$ref": "../definitions/container.json#/definitions/public"},
"label": {"$ref": "../definitions/container.json#/definitions/label"},
"info": {"$ref": "../definitions/container.json#/definitions/info"},
"description": {"$ref": "../definitions/project.json#/definitions/description"}
"public": {"$ref": "container.json#/definitions/public"},
"label": {"$ref": "common.json#/definitions/label"},
"info": {"$ref": "container.json#/definitions/info"},
"description": {"$ref": "common.json#/definitions/description"}
},
"additionalProperties": false
},
"collection-input-with-contents":{
"type": "object",
"properties": {
"public": {"$ref": "../definitions/container.json#/definitions/public"},
"label": {"$ref": "../definitions/container.json#/definitions/label"},
"info": {"$ref": "../definitions/container.json#/definitions/info"},
"description": {"$ref": "../definitions/project.json#/definitions/description"},
"contents": { "type": "object" }
"public": {"$ref": "container.json#/definitions/public"},
"label": {"$ref": "common.json#/definitions/label"},
"info": {"$ref": "container.json#/definitions/info"},
"description": {"$ref": "common.json#/definitions/description"},
"contents": { "type": "object" }
},
"additionalProperties": false
},
"collection-output":{
"type": "object",
"properties": {
"_id":{"$ref":"../definitions/objectid.json#"},
"public": {"$ref": "../definitions/container.json#/definitions/public"},
"label": {"$ref": "../definitions/container.json#/definitions/label"},
"description": {"$ref": "../definitions/collection.json#/definitions/description"},
"info": {"$ref": "../definitions/container.json#/definitions/info"},
"info_exists": {"$ref": "../definitions/container.json#/definitions/info_exists"},
"curator": {"$ref":"#/definitions/curator"},
"created":{"$ref":"../definitions/created-modified.json#/definitions/created"},
"modified":{"$ref":"../definitions/created-modified.json#/definitions/modified"},
"_id": {"$ref":"common.json#/definitions/objectid"},
"public": {"$ref": "container.json#/definitions/public"},
"label": {"$ref": "common.json#/definitions/label"},
"description": {"$ref": "common.json#/definitions/description"},
"info": {"$ref": "container.json#/definitions/info"},
"info_exists": {"$ref": "container.json#/definitions/info_exists"},
"curator": {"$ref": "common.json#/definitions/user-id"},
"created": {"$ref": "created-modified.json#/definitions/created"},
"modified": {"$ref": "created-modified.json#/definitions/modified"},
"permissions":{
"type":"array",
"items":{"$ref":"../definitions/permission.json#/definitions/permission-output-default-required"}
"items":{"$ref":"permission.json#/definitions/permission-output-default-required"}
},
"files":{
"type":"array",
"items":{
"allOf":[{"$ref":"../definitions/file.json#/definitions/file-output"}]
}
"items":{"$ref":"file.json#/definitions/file-output"}
},
"notes":{"allOf":[{"$ref":"../definitions/note.json#/definitions/notes-list-output"}]},
"tags":{"allOf":[{"$ref":"../definitions/tag.json#/definitions/tag-output-list"}]},
"notes": {"$ref":"note.json#/definitions/notes-list-output"},
"tags": {"$ref":"tag.json#/definitions/tag-output-list"},
"analyses":{
"type":"array",
"items":{
"type":"object",
"allOf":[{"$ref":"../definitions/analysis.json#/definitions/analysis-output"}]
}
"items":{"$ref":"analysis.json#/definitions/analysis-output"}
}
},
"additionalProperties":false
......
raml/schemas/definitions/common.json
+ 32
− 1
View file @ e79936f8
......@@ -6,6 +6,9 @@
"minLength": 1,
"maxLength": 256
},
"description": {
"type": "string"
},
"objectid": {
"type": "string",
"pattern": "^[a-fA-F0-9]{24}$"
......@@ -19,6 +22,34 @@
"user-id": {
"type": "string",
"format": "email"
}
},
"timestamp": {
"type": ["string", "null"],
"format": "date-time"
},
"deleted-count": {
"type":"object",
"properties": {
"deleted": {
"type": "integer"
}
}
},
"modified-count": {
"type": "object",
"properties": {
"modified": {
"type": "integer"
}
}
},
"object-created": {
"type": "object",
"properties": {
"_id": {
"type": "string"
}
}
}
}
}
\ No newline at end of file
raml/schemas/definitions/device.json
+ 36
− 4
View file @ e79936f8
......@@ -8,11 +8,24 @@
"type": "string"
}
},
"name": {"type": "string"},
"interval": {"type": "integer"},
"id": {"type": "string"},
"method": {"type": "string"},
"last_seen": {"type": ["string", "null"], "format": "date-time"},
"status-value": {
"type": "string",
"enum": ["ok", "missing", "error", "unknown"]
},
"device": {
"type": "object",
"properties": {
"_id": {"type":"string"},
"method": {"type":"string"},
"name": {"type":"string"},
"errors": {"$ref":"#/definitions/errors"},
"info": {"$ref":"#/definitions/info"},
"interval": {"$ref":"#/definitions/interval"},
"last_seen": {"$ref":"common.json#/definitions/timestamp"}
},
"additionalProperties": false
},
"device-input":{
"type": "object",
"properties": {
......@@ -21,6 +34,25 @@
"info": {"$ref":"#/definitions/info"}
},
"additionalProperties": false
},
"device-output": {
"type": "object",
"allOf": [{"$ref":"#/definitions/device"}],
"required": ["_id", "name", "method", "last_seen"]
},
"device-status": {
"type":"object",
"patternProperties": {
"^[0-9a-z.@_-]*$":{
"properties":{
"errors": {"$ref":"#/definitions/errors"},
"last_seen": {"$ref":"common.json#/definitions/timestamp"},
"status": {"$ref":"#/definitions/status-value"}
},
"additionalProperties":false,
"required": ["last_seen", "status"]
}
}
}
}
}
raml/schemas/definitions/download.json 0 → 100644
+ 70
− 0
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"filter-definition": {
"type": "object",
"properties": {
"+": {"$ref": "#/definitions/filter-items"},
"plus": {"$ref": "#definitions/filterItems"},
"-": {"$ref": "#/definitions/filter-items"},
"minus": {"$ref": "#definitions/filterItems"}
},
"additionalProperties": false
},
"filter-items": { "type": "array",
"minItems": 1,
"items": {
"type": "string"
}
},
"download-node": {
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": ["project", "session", "acquisition", "analysis"]
},
"_id": {
"type": "string",
"pattern": "^[0-9a-f]{24}$"
}
},
"required": ["level", "_id"],
"additionalProperties": false
},
"download-filter": {
"type": "object",
"properties": {
"tags": {"$ref": "#/definitions/filter-definition"},
"types": {"$ref": "#/definitions/filter-definition"}
}
},
"download-input": {
"title": "Download",
"type": "object",
"properties": {
"optional": { "type": "boolean" },
"nodes": {
"type": "array",
"minItems": 1,
"items": {"$ref": "#/definitions/download-node"}
},
"filters": {
"type": "array",
"minItems": 1,
"items": {"$ref": "#/definitions/download-filter"}
}
},
"required": ["optional", "nodes"],
"additionalProperties": false
},
"download-ticket": {
"type":"object",
"properties":{
"ticket":{"type":"string"}
},
"additionalProperties":false,
"required":["ticket"]
}
}
}
raml/schemas/definitions/enginemetadata.json 0 → 100644
+ 103
− 0
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"upload-acquisition-metadata-input": {
"type": "object",
"properties": {
"public": {"type": ["boolean", "null"]},
"label": {"type": ["string", "null"]},
"info": {"type": ["object", "null"]},
"uid": {"type": ["string", "null"]},
"timestamp": {"$ref":"container.json#/definitions/timestamp"},
"timezone": {"type": ["string", "null"]},
"files": {
"type": ["array", "null"],
"items": {"$ref": "file.json#/definitions/file-input"}
}
},
"additionalProperties": false
},
"engine-upload-input": {
"type": "object",
"properties": {
"project": {"$ref": "project.json#/definitions/project-metadata-input"},
"session": {"$ref": "session.json#/definitions/session-metadata-input"},
"acquisition": {"$ref": "acquisition.json#/definitions/acquisition-metadata-input"}
},
"additionalProperties": false
},
"label-upload-input": {
"type": "object",
"properties": {
"group": {
"type": "object",
"allOf": [{"$ref":"group.json#/definitions/group-metadata-input"}],
"required": ["_id"]
},
"project": {
"type": "object",
"allOf": [{"$ref":"project.json#/definitions/project-metadata-input"}],
"required": ["label"]
},
"session": {
"type": "object",
"allOf": [{"$ref":"session.json#/definitions/session-metadata-input"}],
"required": ["label"]
},
"acquisition": {
"type": "object",
"allOf": [{"$ref":"#/definitions/upload-acquisition-metadata-input"}],
"required": ["label"]
}
},
"required": ["group", "project"],
"additionalProperties": false
},
"uid-upload-input": {
"type": "object",
"properties": {
"group": {
"type": "object",
"allOf": [{"$ref":"group.json#/definitions/group-metadata-input"}],
"required": ["_id"]
},
"project": {
"type": "object",
"allOf": [{"$ref":"project.json#/definitions/project-metadata-input"}],
"required": ["label"]
},
"session": {
"type": "object",
"allOf": [{"$ref":"session.json#/definitions/session-metadata-input"}],
"required": ["uid"]
},
"acquisition": {
"type": "object",
"allOf": [{"$ref":"#/definitions/upload-acquisition-metadata-input"}],
"required": ["uid"]
}
},
"required": ["acquisition", "group", "project", "session"],
"additionalProperties": false
},
"uid-match-upload-input": {
"type": "object",
"properties": {
"project": {"$ref": "project.json#/definitions/project-metadata-input"},
"session": {
"type": "object",
"allOf": [{"$ref":"session.json#/definitions/session-metadata-input"}],
"required": ["uid"]
},
"acquisition": {
"type": "object",
"allOf": [{"$ref":"#/definitions/upload-acquisition-metadata-input"}],
"required": ["uid"]
}
},
"required": ["acquisition", "session"],
"additionalProperties": false
}
}
}
\ No newline at end of file
raml/schemas/definitions/file.json
+ 11
− 11
View file @ e79936f8
......@@ -52,16 +52,16 @@
]
},
"measurements": {"$ref":"#/definitions/measurements"},
"tags": {"$ref":"#/definitions/tags"},
"info": {"$ref":"#/definitions/info"},
"origin":{"$ref":"#/definitions/origin"},
"hash":{"$ref":"#/definitions/hash"},
"created":{"$ref":"../definitions/created-modified.json#/definitions/created"},
"modified":{"$ref":"../definitions/created-modified.json#/definitions/modified"},
"size":{"$ref":"#/definitions/size"},
"tags": {"$ref":"#/definitions/tags"},
"info": {"$ref":"#/definitions/info"},
"origin": {"$ref":"#/definitions/origin"},
"hash": {"$ref":"#/definitions/hash"},
"created": {"$ref":"created-modified.json#/definitions/created"},
"modified": {"$ref":"created-modified.json#/definitions/modified"},
"size": {"$ref":"#/definitions/size"},
"info_exists": {"type": "boolean"},
"input": {"type":"boolean"},
"output": {"type":"boolean"}
"input": {"type":"boolean"},
"output": {"type":"boolean"}
},
"additionalProperties": false
},
......@@ -73,8 +73,8 @@
"mimetype": {"$ref":"#/definitions/mimetype"},
"modality": {"$ref":"#/definitions/modality"},
"measurements": {"$ref":"#/definitions/measurements"},
"tags": {"$ref":"#/definitions/tags"},
"info": {"$ref":"#/definitions/info"}
"tags": {"$ref":"#/definitions/tags"},
"info": {"$ref":"#/definitions/info"}
},
"additionalProperties": false
},
......
raml/schemas/definitions/group.json
+ 24
− 32
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions":{
"_id":{"$ref":"../definitions/string-id.json#"},
"label": {
"maxLength": 64,
"minLength": 1,
......@@ -9,57 +8,50 @@
"title": "label",
"type": "string"
},
"group": {
"type": "object",
"properties": {
"_id":{"$ref":"common.json#/definitions/string-id"},
"label": {"$ref": "#/definitions/label"},
"permissions": {"$ref": "permission.json#/definitions/permission-output-list"},
"created": {"$ref":"created-modified.json#/definitions/created"},
"modified": {"$ref":"created-modified.json#/definitions/modified"}
},
"additionalProperties":false
},
"group-input":{
"type": "object",
"properties": {
"_id":{"$ref":"#/definitions/_id"},
"label": {"$ref": "../definitions/container.json#/definitions/label"}
"_id":{"$ref":"common.json#/definitions/string-id"},
"label": {"$ref": "#/definitions/label"}
},
"additionalProperties": false
},
"group-output":{
"group-metadata-input": {
"type": "object",
"properties": {
"_id":{"$ref":"#/definitions/_id"},
"label": {"$ref": "../definitions/container.json#/definitions/label"},
"permissions": {
"type": "array",
"items": {"$ref": "../definitions/permission.json#/definitions/permission-output-default-required"},
"uniqueItems": true
},
"created": {"$ref":"../definitions/created-modified.json#/definitions/created"},
"modified": {"$ref":"../definitions/created-modified.json#/definitions/modified"}
"_id":{"type":"string"}
},
"additionalProperties":false,
"additionalProperties": false
},
"group-output":{
"type": "object",
"allOf": [{"$ref":"#/definitions/group"}],
"required": ["permissions", "created","modified","_id"]
},
"group-output-list":{
"type":"array",
"items":{
"allOf":[{"$ref":"#/definitions/group-output"}]
}
"items":{"$ref":"#/definitions/group-output"}
},
"project-group-output":{
"type": "object",
"properties": {
"_id":{"$ref":"#/definitions/_id"},
"label": {"$ref": "../definitions/container.json#/definitions/label"},
"permissions": {
"type": "array",
"items": {"$ref": "../definitions/permission.json#/definitions/permission-output-default-required"},
"uniqueItems": true
},
"created": {"$ref":"../definitions/created-modified.json#/definitions/created"},
"modified": {"$ref":"../definitions/created-modified.json#/definitions/modified"}
},
"additionalProperties":false,
"allOf": [{"$ref":"#/definitions/group"}],
"required": ["_id"]
},
"project-group-output-list":{
"type":"array",
"items":{
"allOf":[{"$ref":"#/definitions/project-group-output"}]
}
"items":{"$ref":"#/definitions/project-group-output"}
}
}
}
raml/schemas/definitions/info.json 0 → 100644
+ 33
− 0
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"info-add-remove": {
"properties": {
"set": {"type": "object", "minProperties": 1},
"delete": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"info-replace": {
"properties": {
"replace": {"type": "object"}
},
"additionalProperties": false
},
"info-update-input": {
"description": "Helper endpoint for editing an object's info key",
"type": "object",
"oneOf": [
{"$ref":"#/definitions/info-add-remove"},
{"$ref":"#/definitions/info-replace"}
]
}
}
}
raml/schemas/definitions/job.json
+ 45
− 2
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"_id": {"$ref":"../definitions/objectid.json#"},
"gear_id": {"type":"string"},
"previous_job_id": {"type":"string"},
"inputs-property-type":{"type":"string"},
"inputs-property-id":{"type":"string"},
"inputs-property-name":{"type":"string"},
"inputs-object": {
"type": "object",
"additionalProperties": {
"properties": {
"type": "object",
"properties": {
"type": {"$ref":"#/definitions/inputs-property-type"},
......@@ -117,6 +119,47 @@
"target":{"type":"object"},
"outputs":{"type":"array"}
}
},
"job": {
"type":"object",
"properties":{
"id":{"$ref":"common.json#/definitions/objectid"},
"origin":{"$ref":"#/definitions/origin"},
"gear_id":{"$ref":"#/definitions/gear_id"},
"previous_job_id":{"type":"string"},
"inputs":{"$ref":"#/definitions/inputs-object"},
"destination":{"$ref":"#/definitions/destination"},
"tags":{"$ref":"#/definitions/tags"},
"state":{"$ref":"#/definitions/state"},
"attempt":{"$ref":"#/definitions/attempt"},
"created":{"$ref":"created-modified.json#/definitions/created"},
"modified":{"$ref":"created-modified.json#/definitions/modified"},
"config":{"$ref":"#/definitions/config"},
"request":{"$ref":"#/definitions/request"},
"saved_files":{"$ref":"#/definitions/saved_files"},
"produced_metadata":{"$ref":"#/definitions/produced_metadata"}
},
"additionalProperties":false
},
"job-input": {
"type":"object",
"properties": {
"gear_id":{"$ref":"#/definitions/gear_id"},
"inputs":{"$ref":"#/definitions/inputs-object"},
"destination":{"$ref":"#/definitions/destination"},
"tags":{"$ref":"#/definitions/tags"},
"config":{"$ref":"#/definitions/config"}
},
"required": ["gear_id"],
"additionalProperties":false
},
"job-output": {
"type": "object",
"allOf": [{"$ref":"#/definitions/job"}],
"required": [
"id", "gear_id", "inputs", "config",
"destination", "tags", "state", "attempt"
]
}
}
}
raml/schemas/definitions/note.json
+ 4
− 4
View file @ e79936f8
......@@ -16,11 +16,11 @@
"note-output":{
"type":"object",
"properties":{
"_id":{"$ref":"../definitions/objectid.json"},
"_id":{"$ref":"common.json#/definitions/objectid"},
"text":{"$ref":"#/definitions/text"},
"created":{"$ref":"../definitions/created-modified.json#/definitions/created"},
"modified":{"$ref":"../definitions/created-modified.json#/definitions/modified"},
"user":{"$ref":"../definitions/user.json#/definitions/_id"}
"created":{"$ref":"created-modified.json#/definitions/created"},
"modified":{"$ref":"created-modified.json#/definitions/modified"},
"user":{"$ref":"common.json#/definitions/user-id"}
},
"additionalProperties": false,
"required":["_id", "text", "created", "modified", "user"]
......
raml/schemas/definitions/packfile.json 0 → 100644
+ 59
− 0
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"packfile-project-input": {
"type": "object",
"properties": {
"_id": {"type": "string"}
},
"additionalProperties": false,
"required": ["_id"]
},
"packfile-session-input": {
"type": "object",
"properties": {
"label": {"type": "string"},
"subject": {"$ref": "subject.json#/definitions/subject-input"}
},
"additionalProperties": false,
"required": ["label"]
},
"packfile-acquisition-input": {
"type": "object",
"properties": {
"label": {"type": "string"},
"timestamp": {"type": ["string", "null"], "format": "date-time"},
"timezone": {"type": "string"}
},
"additionalProperties": false,
"required": ["label"]
},
"packfile-packfile-input": {
"type": "object",
"properties": {
"type": {"type": "string"}
},
"additionalProperties": false,
"required": ["type"]
},
"packfile-input": {
"title": "Packfile",
"type": "object",
"properties": {
"project": {"$ref":"#/definitions/packfile-project-input"},
"session": {"$ref":"#/definitions/packfile-session-input"},
"acquisition": {"$ref":"#/definitions/packfile-acquisition-input"},
"packfile": {"$ref":"#/definitions/packfile-packfile-input"}
},
"required": ["project", "session", "acquisition", "packfile"],
"additionalProperties": false
},
"packfile-start": {
"type":"object",
"properties":{
"token":{"$ref":"common.json#/definitions/objectid"}
}
}
}
}
raml/schemas/definitions/permission.json
+ 6
− 2
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"_id": { "type": "string" },
"access": { "enum": ["ro", "rw", "admin"] },
"permission":{
"type":"object",
"properties":{
"_id":{"$ref":"#/definitions/_id"},
"_id":{"$ref":"common.json#/definitions/user-id"},
"access":{"$ref":"#/definitions/access"}
},
"additionalProperties": false
......@@ -14,6 +13,11 @@
"permission-output-default-required":{
"allOf":[{"$ref":"#/definitions/permission"}],
"required":["_id", "access"]
},
"permission-output-list": {
"type": "array",
"items": {"$ref": "#/definitions/permission-output-default-required"},
"uniqueItems": true
}
}
}
raml/schemas/definitions/project.json
+ 33
− 27
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions":{
"description": {"type": "string"},
"project-input":{
"type": "object",
"properties": {
"public": {"$ref": "../definitions/container.json#/definitions/public"},
"label": {"$ref": "../definitions/container.json#/definitions/label"},
"info": {"$ref": "../definitions/container.json#/definitions/info"},
"description": {"$ref": "../definitions/project.json#/definitions/description"},
"group":{"$ref":"../definitions/group.json#/definitions/_id"}
"public": {"$ref":"container.json#/definitions/public"},
"label": {"$ref":"common.json#/definitions/label"},
"info": {"$ref":"container.json#/definitions/info"},
"description": {"$ref":"common.json#/definitions/description"},
"group": {"$ref":"common.json#/definitions/string-id"}
},
"additionalProperties": false
},
"project-metadata-input": {
"type": "object",
"properties": {
"public": {"type": ["boolean", "null"]},
"label": {"type": ["string", "null"]},
"info": {"type": ["object", "null"]},
"files": {
"type": ["array", "null"],
"items": {"$ref": "file.json#/definitions/file-input"}
}
},
"additionalProperties": false
},
"project-output":{
"type": "object",
"properties": {
"_id": {"$ref":"../definitions/objectid.json#"},
"public": {"$ref": "../definitions/container.json#/definitions/public"},
"label": {"$ref": "../definitions/container.json#/definitions/label"},
"info": {"$ref": "../definitions/container.json#/definitions/info"},
"info_exists": {"$ref": "../definitions/container.json#/definitions/info_exists"},
"description": {"$ref": "../definitions/project.json#/definitions/description"},
"group":{"$ref":"../definitions/group.json#/definitions/_id"},
"created":{"$ref":"../definitions/created-modified.json#/definitions/created"},
"modified":{"$ref":"../definitions/created-modified.json#/definitions/modified"},
"template":{"type":"object"},
"permissions":{
"type":"array",
"items":{"$ref":"../definitions/permission.json#/definitions/permission-output-default-required"}
},
"_id": {"$ref":"common.json#/definitions/objectid"},
"public": {"$ref":"container.json#/definitions/public"},
"label": {"$ref":"common.json#/definitions/label"},
"info": {"$ref":"container.json#/definitions/info"},
"info_exists": {"$ref":"container.json#/definitions/info_exists"},
"description": {"$ref":"common.json#/definitions/description"},
"group": {"$ref":"common.json#/definitions/string-id"},
"created": {"$ref":"created-modified.json#/definitions/created"},
"modified": {"$ref":"created-modified.json#/definitions/modified"},
"template": {"type":"object"},
"permissions": {"$ref":"permission.json#/definitions/permission-output-list"},
"files":{
"type":"array",
"items":{
"allOf":[{"$ref":"../definitions/file.json#/definitions/file-output"}]
"allOf":[{"$ref":"file.json#/definitions/file-output"}]
}
},
"notes":{"allOf":[{"$ref":"../definitions/note.json#/definitions/notes-list-output"}]},
"tags":{"allOf":[{"$ref":"../definitions/tag.json#/definitions/tag-output-list"}]},
"notes": {"$ref":"note.json#/definitions/notes-list-output"},
"tags": {"$ref":"tag.json#/definitions/tag-output-list"},
"analyses":{
"type":"array",
"items":{
"type":"object",
"allOf":[{"$ref":"../definitions/analysis.json#/definitions/analysis-output"}]
}
"items":{"$ref":"analysis.json#/definitions/analysis-output"}
}
},
"additionalProperties": false
......
raml/schemas/definitions/report.json 0 → 100644
+ 113
− 0
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type":"object",
"definitions":{
"gender_count":{
"type":"object",
"properties":{
"Male": {"type":"integer"},
"Unknown or Not Reported":{"type":"integer"},
"Female":{"type":"integer"}
},
"additionalProperties":false,
"required":["Male", "Female", "Unknown or Not Reported"]
},
"ethnicity_grid":{
"type":"object",
"properties":{
"Not Hispanic or Latino":{
"allOf":[{"$ref":"#/definitions/gender_count"}]
},
"Hispanic or Latino":{
"allOf":[{"$ref":"#/definitions/gender_count"}]
},
"Unknown or Not Reported":{
"allOf":[{"$ref":"#/definitions/gender_count"}]
},
"Total":{"type":"integer"}
}
},
"demographics_grid": {
"type":"object",
"properties":{
"Black or African American":{
"allOf":[{"$ref":"#/definitions/ethnicity_grid"}]
},
"Unknown or Not Reported":{
"allOf":[{"$ref":"#/definitions/ethnicity_grid"}]
},
"American Indian or Alaska Native":{
"allOf":[{"$ref":"#/definitions/ethnicity_grid"}]
},
"Asian":{
"allOf":[{"$ref":"#/definitions/ethnicity_grid"}]
},
"White":{
"allOf":[{"$ref":"#/definitions/ethnicity_grid"}]
},
"Total":{
"allOf":[{"$ref":"#/definitions/ethnicity_grid"}]
},
"Native Hawaiian or Other Pacific Islander":{
"allOf":[{"$ref":"#/definitions/ethnicity_grid"}]
},
"More Than One Race":{
"allOf":[{"$ref":"#/definitions/ethnicity_grid"}]
},
"male_count": {"type":"integer"},
"group_label": {"$ref":"common.json#/definitions/label"},
"over_18_count": {"type":"integer"},
"under_18_count": {"type":"integer"},
"female_count": {"type":"integer"},
"subjects_count": {"type":"integer"},
"other_count": {"type":"integer"},
"name": {"$ref":"common.json#/definitions/label"},
"session_count": {"type":"integer"},
"admins": {
"type":"array",
"items":{
"type":"string"
}
},
"demographics_total": {"type":"integer"}
}
},
"group-report": {
"type":"object",
"properties":{
"project_count":{"type":"integer"},
"label":{
"oneOf":[
{"$ref":"group.json#/definitions/label"},
{"type":"null"}
]
},
"session_count":{"type":"integer"}
},
"additionalProperties":false,
"required":["project_count", "label", "session_count"]
},
"report-project": {
"type":"object",
"properties":{
"projects":{
"type":"array",
"items":{"$ref":"#/definitions/demographics_grid"}
}
}
},
"report-site": {
"type":"object",
"properties":{
"group_count":{"type":"integer"},
"groups":{
"type":"array",
"items":{"$ref":"#/definitions/group-report"}
}
},
"additionalProperties":false,
"required":["group_count", "groups"]
}
}
}
raml/schemas/definitions/session.json
+ 75
− 40
View file @ e79936f8
......@@ -8,63 +8,98 @@
"session-input":{
"type": "object",
"properties": {
"operator": {"$ref": "#/definitions/operator"},
"public": {"$ref": "../definitions/container.json#/definitions/public"},
"label": {"$ref": "../definitions/container.json#/definitions/label"},
"info": {"$ref": "../definitions/container.json#/definitions/info"},
"operator": {"$ref":"#/definitions/operator"},
"public": {"$ref":"container.json#/definitions/public"},
"label": {"$ref":"common.json#/definitions/label"},
"info": {"$ref":"container.json#/definitions/info"},
"project": {"$ref":"#/definitions/project"},
"uid": {"$ref":"../definitions/container.json#/definitions/uid"},
"timestamp": {"$ref":"../definitions/container.json#/definitions/timestamp"},
"timezone": {"$ref":"../definitions/container.json#/definitions/timezone"},
"subject": {
"allOf":[{"$ref": "../definitions/subject.json#/definitions/subject-input"}]
}
"uid": {"$ref":"container.json#/definitions/uid"},
"timestamp": {"$ref":"container.json#/definitions/timestamp"},
"timezone": {"$ref":"container.json#/definitions/timezone"},
"subject": {"$ref": "subject.json#/definitions/subject-input"}
},
"additionalProperties": false
},
"session-metadata-input": {
"type": "object",
"properties": {
"public": {"type": ["boolean", "null"]},
"label": {"type": ["string", "null"]},
"info": {"type": ["object", "null"]},
"operator": {"type": ["string", "null"]},
"uid": {"type": ["string", "null"]},
"timestamp": {"type": ["string", "null"], "format": "date-time"},
"timezone": {"type": ["string", "null"]},
"subject": {"$ref": "subject.json#/definitions/subject-input"},
"files": {
"type": ["array", "null"],
"items": {"$ref": "file.json#/definitions/file-input"}
}
},
"additionalProperties": false
},
"session-output":{
"type": "object",
"properties": {
"_id": {"$ref":"../definitions/objectid.json#"},
"public": {"$ref": "../definitions/container.json#/definitions/public"},
"label": {"$ref": "../definitions/container.json#/definitions/label"},
"info": {"$ref": "../definitions/container.json#/definitions/info"},
"info_exists": {"$ref": "../definitions/container.json#/definitions/info_exists"},
"operator": {"$ref": "#/definitions/operator"},
"_id": {"$ref":"common.json#/definitions/objectid"},
"public": {"$ref":"container.json#/definitions/public"},
"label": {"$ref":"common.json#/definitions/label"},
"info": {"$ref":"container.json#/definitions/info"},
"info_exists": {"$ref":"container.json#/definitions/info_exists"},
"operator": {"$ref":"#/definitions/operator"},
"project": {"$ref":"#/definitions/project"},
"uid": {"$ref":"../definitions/container.json#/definitions/uid"},
"timestamp": {"$ref":"../definitions/container.json#/definitions/timestamp"},
"timezone": {"$ref":"../definitions/container.json#/definitions/timezone"},
"subject": {
"type":"object",
"allOf":[{"$ref": "../definitions/subject.json#/definitions/subject-output-default-required"}]
},
"created":{"$ref":"../definitions/created-modified.json#/definitions/created"},
"modified":{"$ref":"../definitions/created-modified.json#/definitions/modified"},
"permissions":{
"type":"array",
"items":{"$ref":"../definitions/permission.json#/definitions/permission-output-default-required"}
},
"group":{"$ref":"../definitions/group.json#/definitions/_id"},
"project_has_template":{"$ref":"#/definitions/project_has_template"},
"satisfies_template":{"$ref":"#/definitions/satisfies_template"},
"uid": {"$ref":"container.json#/definitions/uid"},
"timestamp": {"$ref":"container.json#/definitions/timestamp"},
"timezone": {"$ref":"container.json#/definitions/timezone"},
"subject": {"$ref":"subject.json#/definitions/subject-output-default-required"},
"created": {"$ref":"created-modified.json#/definitions/created"},
"modified": {"$ref":"created-modified.json#/definitions/modified"},
"permissions": {"$ref":"permission.json#/definitions/permission-output-list"},
"group": {"$ref":"common.json#/definitions/string-id"},
"project_has_template": {"$ref":"#/definitions/project_has_template"},
"satisfies_template": {"$ref":"#/definitions/satisfies_template"},
"files":{
"type":"array",
"items":{
"allOf":[{"$ref":"../definitions/file.json#/definitions/file-output"}]
}
"items":{"$ref":"file.json#/definitions/file-output"}
},
"notes":{"allOf":[{"$ref":"../definitions/note.json#/definitions/notes-list-output"}]},
"tags":{"allOf":[{"$ref":"../definitions/tag.json#/definitions/tag-output-list"}]},
"notes": {"$ref":"note.json#/definitions/notes-list-output"},
"tags": {"$ref":"tag.json#/definitions/tag-output-list"},
"analyses":{
"type":"array",
"items":{"$ref":"analysis.json#/definitions/analysis-output"}
}
},
"additionalProperties": false
},
"session-jobs-output": {
"type": "object",
"properties":{
"jobs":{
"type":"array",
"items":{"$ref": "job.json#/definitions/job-output"}
},
"containers":{
"patternProperties": {
"^[a-fA-F0-9]{24}$":{
"type": "object"
}
}
}
},
"additionalProperties":false
},
"session-template-recalc-output": {
"type": "object",
"properties":{
"sessions_changed":{
"type":"array",
"items":{
"type":"object",
"allOf":[{"$ref":"../definitions/analysis.json#/definitions/analysis-output"}]
"allOf":[{"$ref":"common.json#/definitions/objectid"}]
}
}
},
"additionalProperties": false
"additionalProperties":false,
"required":["sessions_changed"]
}
}
}
raml/schemas/definitions/subject.json
+ 3
− 7
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions":{
"_id": {"$ref":"../definitions/objectid.json#"},
"_id": {"$ref":"common.json#/definitions/objectid"},
"firstname": { "type": "string", "maxLength": 64 },
"lastname": { "type": "string", "maxLength": 64 },
"age": { "type": ["integer", "null"] },
......@@ -29,9 +29,7 @@
"info": {"$ref":"#/definitions/info"},
"files":{
"type":"array",
"items":{
"allOf":[{"$ref":"../definitions/file.json#/definitions/file-input"}]
}
"items":{"$ref":"file.json#/definitions/file-input"}
}
},
"additionalProperties": false
......@@ -54,9 +52,7 @@
"info_exists": {"$ref": "../definitions/container.json#/definitions/info_exists"},
"files":{
"type":"array",
"items":{
"allOf":[{"$ref":"../definitions/file.json#/definitions/file-output"}]
}
"items":{"$ref":"file.json#/definitions/file-output"}
}
},
"additionalProperties": false
......
raml/schemas/definitions/user.json
+ 30
− 10
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"_id": {
"format": "email",
"title": "ID",
"type": "string"
},
"firstname": {
"maxLength": 64,
"minLength": 1,
......@@ -42,7 +37,7 @@
"type":"object",
"properties":{
"key": {"type": "string"},
"created": {"$ref":"../definitions/created-modified.json#/definitions/created"},
"created": {"$ref":"created-modified.json#/definitions/created"},
"last_used": {}
},
"additionalProperties":false
......@@ -50,7 +45,7 @@
"user-input":{
"type":"object",
"properties":{
"_id":{"$ref":"#/definitions/_id"},
"_id":{"$ref":"common.json#/definitions/user-id"},
"firstname":{"$ref":"#/definitions/firstname"},
"lastname":{"$ref":"#/definitions/lastname"},
"email":{"$ref":"#/definitions/email"},
......@@ -68,7 +63,7 @@
"user-output":{
"type":"object",
"properties":{
"_id":{"$ref":"#/definitions/_id"},
"_id":{"$ref":"common.json#/definitions/user-id"},
"firstname":{"$ref":"#/definitions/firstname"},
"lastname":{"$ref":"#/definitions/lastname"},
"email":{"$ref":"#/definitions/email"},
......@@ -80,10 +75,35 @@
"wechat":{"$ref":"#/definitions/wechat"},
"firstlogin":{"$ref":"#/definitions/firstlogin"},
"lastlogin":{"$ref":"#/definitions/lastlogin"},
"created":{"$ref":"../definitions/created-modified.json#/definitions/created"},
"modified":{"$ref":"../definitions/created-modified.json#/definitions/modified"}
"created":{"$ref":"created-modified.json#/definitions/created"},
"modified":{"$ref":"created-modified.json#/definitions/modified"}
},
"additionalProperties":false
},
"user-output-api-key": {
"type":"object",
"properties":{
"_id":{"$ref":"common.json#/definitions/user-id"},
"api_key":{"$ref":"#/definitions/api_key"},
"firstname":{"$ref":"#/definitions/firstname"},
"lastname":{"$ref":"#/definitions/lastname"},
"email":{"$ref":"#/definitions/email"},
"avatar":{"$ref":"#/definitions/avatar"},
"avatars":{"$ref":"#/definitions/avatars"},
"root":{"$ref":"#/definitions/root"},
"disabled":{"$ref":"#/definitions/disabled"},
"preferences":{"$ref":"#/definitions/preferences"},
"wechat":{"$ref":"#/definitions/wechat"},
"firstlogin":{"$ref":"#/definitions/firstlogin"},
"lastlogin":{"$ref":"#/definitions/lastlogin"},
"created":{"$ref":"created-modified.json#/definitions/created"},
"modified":{"$ref":"created-modified.json#/definitions/modified"}
},
"additionalProperties":false,
"required":[
"_id", "firstname", "lastname",
"root", "email", "created", "modified"
]
}
}
}
raml/schemas/definitions/version.json 0 → 100644
+ 20
− 0
View file @ e79936f8
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"version-output": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"database": {
"type": "integer"
}
},
"required": [
"_id",
"database"
]
}
}
}
raml/schemas/input/acquisition-update.json
+ 4
− 1
View file @ e79936f8
......@@ -2,5 +2,8 @@
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Acquisition",
"type": "object",
"allOf": [{"$ref": "../definitions/acquisition.json#/definitions/acquisition-input"}]
"allOf": [{"$ref": "../definitions/acquisition.json#/definitions/acquisition-input"}],
"example": {
"label": "example-acquisition-new-label"
}
}
raml/schemas/input/acquisition.json
+ 6
− 1
View file @ e79936f8
......@@ -3,5 +3,10 @@
"title": "Acquisition",
"type": "object",
"allOf": [{"$ref": "../definitions/acquisition.json#/definitions/acquisition-input"}],
"required": ["label", "session"]
"required": ["label", "session"],
"example": {
"label": "example-acquisition",
"session": "57e45328466d8e000e33a85b",
"public": false
}
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment