containers

Changed on

Get the corresponding descriptor file.

get/containers/{containerId}/descriptor/{relative-path}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/containers/{containerId}/descriptor/{relative-path}
  • Auth
    HTTP bearer

Path parameters

containerIdinteger required
relative-pathstring required

Query parameters

tagstring
languagestring

Response

default response

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

Changes

  • ec3f84f1e69eRevision changes
    • warning

      added the new DOCKSTORE_WORKFLOW_OTHER enum value to the response property for the response status

  • 52f0ecb5c8caRevision changes
    • info

      removed the DOCKSTORE_WORKFLOW_OTHER enum value from the response property for the response status