-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #255 from CBIIT/EVSSIP-322
Evssip 322
- Loading branch information
Showing
133 changed files
with
166,627 additions
and
245 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,256 @@ | ||
id: _definitions | ||
|
||
uuid: | ||
$ref: "_terms.yaml#/uuid" | ||
type: string | ||
pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" | ||
systemAlias: node_id | ||
|
||
parent_uuids: | ||
type: array | ||
minItems: 1 | ||
items: | ||
$ref: "#/uuid" | ||
uniqueItems: true | ||
|
||
foreign_key_project: | ||
type: object | ||
# Allow true here because we can have other unique keys defined on | ||
# a target type | ||
additionalProperties: True | ||
# Can either use 'id' which are GDC IDs (uuid) or 'submitter_id' | ||
# which are user defined IDs ("submitter IDs in the backend") | ||
properties: | ||
id: | ||
$ref: "#/uuid" | ||
submitter_id: | ||
type: string | ||
|
||
to_one_project: | ||
anyOf: | ||
- type: array | ||
items: | ||
$ref: "#/foreign_key_project" | ||
minItems: 1 | ||
maxItems: 1 | ||
- $ref: "#/foreign_key_project" | ||
|
||
to_many_project: | ||
anyOf: | ||
- type: array | ||
items: | ||
$ref: "#/foreign_key_project" | ||
minItems: 1 | ||
- $ref: "#/foreign_key_project" | ||
|
||
foreign_key: | ||
type: object | ||
# Allow true here because we can have other unique keys defined on | ||
# a target type | ||
additionalProperties: True | ||
# Can either use 'id' which are GDC IDs (uuid) or 'submitter_id' | ||
# which are user defined IDs ("submitter IDs in the backend") | ||
properties: | ||
id: | ||
$ref: "#/uuid" | ||
submitter_id: | ||
type: string | ||
|
||
to_one: | ||
anyOf: | ||
- type: array | ||
items: | ||
$ref: "#/foreign_key" | ||
minItems: 1 | ||
maxItems: 1 | ||
- $ref: "#/foreign_key" | ||
|
||
to_many: | ||
anyOf: | ||
- type: array | ||
items: | ||
$ref: "#/foreign_key" | ||
minItems: 1 | ||
- $ref: "#/foreign_key" | ||
|
||
datetime: | ||
$ref: "_terms.yaml#/datetime" | ||
oneOf: | ||
- type: string | ||
format: date-time | ||
- type: 'null' | ||
|
||
file_name: | ||
$ref: "_terms.yaml#/file_name/common" | ||
type: string | ||
|
||
file_size: | ||
$ref: "_terms.yaml#/file_size/common" | ||
type: integer | ||
|
||
file_format: | ||
$ref: "_terms.yaml#/file_format" | ||
type: string | ||
|
||
md5sum: | ||
$ref: "_terms.yaml#/md5sum/common" | ||
type: string | ||
pattern: "^[a-f0-9]{32}$" | ||
|
||
release_state: | ||
description: >- | ||
Release state of an entity. | ||
default: unreleased | ||
enum: | ||
- unreleased | ||
- released | ||
- redacted | ||
|
||
data_bundle_state: | ||
description: >- | ||
State of a data bundle. | ||
default: submitted | ||
enum: | ||
- submitted | ||
- validated | ||
- error | ||
- released | ||
- suppressed | ||
- redacted | ||
|
||
data_file_error_type: | ||
$ref: "_terms.yaml#/data_file_error_type" | ||
enum: | ||
- file_size | ||
- file_format | ||
- md5sum | ||
|
||
state: | ||
$ref: "_terms.yaml#/state" | ||
default: validated | ||
downloadable: | ||
- uploaded | ||
- md5summed | ||
- validating | ||
- validated | ||
- error | ||
- invalid | ||
- released | ||
public: | ||
- live | ||
oneOf: | ||
- enum: #This list covers legacy data | ||
- uploading | ||
- uploaded | ||
- md5summing | ||
- md5summed | ||
- validating | ||
- error | ||
- invalid | ||
- suppressed | ||
- redacted | ||
- live | ||
- enum: #This list covers all future data 1/15/16 | ||
- validated | ||
- submitted | ||
- released | ||
|
||
file_state: | ||
$ref: "_terms.yaml#/file_state" | ||
default: registered | ||
enum: | ||
- registered | ||
- uploading | ||
- uploaded | ||
- validating | ||
- validated | ||
- submitted | ||
- processing | ||
- processed | ||
- released | ||
- error | ||
- deleted | ||
|
||
qc_metrics_state: | ||
$ref: "_terms.yaml#/qc_metric_state" | ||
enum: | ||
- FAIL | ||
- PASS | ||
- WARN | ||
- Unknown | ||
- Not Reported | ||
|
||
project_id: | ||
$ref: "_terms.yaml#/project_id" | ||
type: string | ||
|
||
data_file_properties: | ||
$ref: "#/ubiquitous_properties" | ||
|
||
file_name: | ||
$ref: "#/file_name" | ||
|
||
file_size: | ||
$ref: "#/file_size" | ||
|
||
md5sum: | ||
$ref: "#/md5sum" | ||
|
||
file_state: | ||
$ref: "#/file_state" | ||
|
||
error_type: | ||
$ref: "#/data_file_error_type" | ||
|
||
state_comment: | ||
description: >- | ||
Optional comment about why the file is in the current state, mainly for invalid state. | ||
type: string | ||
|
||
workflow_properties: | ||
$ref: "#/ubiquitous_properties" | ||
|
||
workflow_link: | ||
$ref: "_terms.yaml#/workflow_link/common" | ||
type: string | ||
|
||
workflow_version: | ||
$ref: "_terms.yaml#/workflow_version/common" | ||
type: string | ||
|
||
workflow_start_datetime: | ||
$ref: "#/datetime" | ||
|
||
workflow_end_datetime: | ||
$ref: "#/datetime" | ||
|
||
ubiquitous_properties: | ||
type: | ||
type: string | ||
|
||
id: | ||
$ref: "#/uuid" | ||
|
||
submitter_id: | ||
description: >- | ||
A project-specific identifier for a node. This property is the calling card/nickname/alias | ||
for a unit of submission. It can be used in place of the uuid for identifying | ||
or recalling a node. | ||
type: string | ||
|
||
batch_id: | ||
description: >- | ||
GDC submission batch indicator. It is unique within the context of a project. | ||
type: integer | ||
|
||
state: | ||
$ref: "#/state" | ||
|
||
project_id: | ||
$ref: "#/project_id" | ||
|
||
created_datetime: | ||
$ref: "#/datetime" | ||
|
||
updated_datetime: | ||
$ref: "#/datetime" |
Oops, something went wrong.