Sign in
hosted

Non-idempotent operation for creating new revisions of hosted tools.

patch/containers/hostedEntry/{entryId}

Path parameters

entryIdinteger required

Entry to modify

Request body

absolutePathstring required

Absolute path of sourcefile in git repo

contentstring
frozenboolean
idinteger
pathstring required

Path to sourcefile relative to its parent

state'COMPLETE' | 'NOT_STORED' | 'STUB' required

Enumerates the file state

type'DOCKSTORE_SMK' | 'SMK_TEST_PARAMS' | 'DOCKSTORE_CWL' | 'CWL_TEST_JSON' | 'DOCKSTORE_WDL' | 'WDL_TEST_JSON' | 'DOCKSTORE_WORKFLOW_OTHER' | 'DOCKERFILE' | 'NEXTFLOW' | 'NEXTFLOW_CONFIG' | 'NEXTFLOW_TEST_PARAMS' | 'DOCKSTORE_YML' | 'DOCKSTORE_SERVICE_YML' | 'DOCKSTORE_SERVICE_TEST_JSON' | 'DOCKSTORE_SERVICE_OTHER' | 'DOCKSTORE_GXFORMAT2' | 'GXFORMAT2_TEST_FILE' | 'DOCKSTORE_SWL' | 'SWL_TEST_JSON' | 'DOCKSTORE_JUPYTER' | 'DOCKSTORE_NOTEBOOK_REES' | 'DOCKSTORE_NOTEBOOK_DEVCONTAINER' | 'DOCKSTORE_NOTEBOOK_TEST_FILE' | 'DOCKSTORE_NOTEBOOK_OTHER' required

Enumerates the type of file

verifiedBySourceobject

Response

default response

aliasesobject
approvedAITopicboolean

Indicates if the topicAI has been approved by the user

archivedboolean
checker_idinteger
conceptDoistring

The Digital Object Identifier (DOI) representing all of the versions of your workflow

conceptDoisobject

The Digital Object Identifier (DOI) representing all of the versions of your workflow

custom_docker_registry_pathstring
customerDockerRegistryPathstring
dbCreateDateinteger
dbUpdateDateinteger
defaultCWLTestParameterFilestring
defaultVersionstring
defaultWDLTestParameterFilestring
default_cwl_pathstring
default_dockerfile_pathstring
default_wdl_pathstring
deletableboolean
descriptionstring
descriptorTypestring[]
doiSelection'USER' | 'DOCKSTORE' | 'GITHUB'

The Digital Object Identifier (DOI) to display publicly

entryType'TOOL' | 'WORKFLOW' | 'SERVICE' | 'APPTOOL' | 'NOTEBOOK'

Entry type

forumUrlstring
gitUrlstring
has_checkerboolean
idinteger
is_publishedboolean
lastBuildstring date-time
lastUpdatedinteger
last_modifiedinteger
last_modified_dateinteger
metricsByPlatformobject
mode'AUTO_DETECT_QUAY_TAGS_AUTOMATED_BUILDS' | 'AUTO_DETECT_QUAY_TAGS_WITH_MIXED' | 'MANUAL_IMAGE_PATH' | 'HOSTED'
namestring
namespacestring
pathstring
private_accessboolean
registry'QUAY_IO' | 'DOCKER_HUB' | 'GITLAB' | 'AMAZON_ECR' | 'SEVEN_BRIDGES' | 'GITHUB_CONTAINER_REGISTRY'
registry_stringstring
tool_maintainer_emailstring
tool_pathstring
toolnamestring
topicstring
topicAIstring

Short description of the entry generated by AI

topicAutomaticstring

Short description of the entry gotten automatically

topicIdinteger
topicManualstring

Short description of the entry manually updated

topicSelection'AUTOMATIC' | 'MANUAL' | 'AI'

Which topic to display to the public users

trsIdstring
userIdToOrcidPutCodeobject

The presence of the put code for a userid indicates the entry was exported to ORCID for the corresponding Dockstore user.

Example response

{
  "metadataFromVersion": {
    "name": "latest",
    "reference": "master"
  },
  "tags": [
    {
      "name": "latest",
      "reference": "master"
    }
  ],
  "workflowVersions": [
    {
      "name": "latest",
      "reference": "master"
    }
  ]
}

Changes