Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
{
	"description": "The upload destination contains information to start an upload of a file generated according to the underlying <a href=\"${org.sagebionetworks.repo.model.project.StorageLocationSetting}\">StorageLocationSetting</a>.",
	"type": "interface",
	"properties": {
        "concreteType": {
            "type": "string",
            "description": "Indicates which implementation this object represents."
        },
		"storageLocationId": {
			"type": "integer",
			"description": "the unique id for the storage location, that points to the <a href=\"${org.sagebionetworks.repo.model.project.StorageLocationSetting}\">StorageLocationSetting</a>"
		},
		"uploadType": {
			"$ref": "org.sagebionetworks.repo.model.file.UploadType"
		},
		"banner": {
			"type": "string",
			"description": "If set, the client should show this banner every time an upload is initiated"
		},
		"destinationProjectId": {
			"type": "string",
			"description": "The ID of the project where this file will be uploaded."
		},
		"projectStorageLocationUsage": {
			"$ref": "org.sagebionetworks.repo.model.limits.ProjectStorageLocationUsage",
			"description": "This object includes information about size and limits associated with this project storage location.  Clients should not attempt to upload a file to this location if isOverLimit=true or if (<size_new_file> + sumFileBytes) is greater than maxAllowedFileBytes."
		}
	}
}

TermsOfServiceState.json:

Code Block
{
	"type": "string",
	"description": "The user's current ToS state defines what action if any they will need to take to meet ToS requirements.",
	"enum": [
		{
			"name": "MUST_AGREE_NOW",
			"description": "The user must agree to the new ToS before they can use the service."
		},
		{
			"name": "MUST_AGREE_SOON",
			"description": "The user currently has agreed to an older ToS and they will need to agree to the new ToS before new required date."
		},
		{
			"name": "UP_TO_DATE",
			"description": "The user has agreed to the latest ToS so they are up-to-date"
		}
	]
}