aliases

Changed on

Add aliases linked to a workflow version in Dockstore.

post/aliases/workflow-versions/{workflowVersionId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/aliases/workflow-versions/{workflowVersionId}
  • Auth
    HTTP bearer

Path parameters

workflowVersionIdinteger required

Query parameters

aliasesstring

Response

default response

aiTopicProcessedboolean
aliasesobject
authorstring
commitIDstring
dbUpdateDateinteger
descriptionSource'README' | 'CUSTOM_README' | 'DESCRIPTOR'
dirtyBitboolean
doiStatus'NOT_REQUESTED' | 'REQUESTED' | 'CREATED'
doiURLstring
doisobject

The DOIs for the version of the entry

emailstring
frozenboolean
hiddenboolean
idinteger
kernelImagePathstring

User-specified notebook kernel image reference

last_modifiedinteger
legacyVersionboolean
metricsByPlatformobject
namestring required

Implementation specific, can be a quay.io or docker hub tag name

readMePathstring
referencestring required

git commit/tag/branch

referenceType'COMMIT' | 'TAG' | 'BRANCH' | 'NOT_APPLICABLE' | 'UNSET'
syncedboolean
userFilesstring[]
validboolean
verifiedboolean
verifiedPlatformsstring[]

Verified platforms for the version

verifiedSourcestring
verifiedSourcesstring[]
workflow_pathstring
workingDirectorystring

Example response

{
  "name": "latest",
  "reference": "master"
}

Changes

  • e7ba6b990428Revision changes
    • info

      added the optional property ////// to the response with the status

  • 58d7abe5af40Revision changes
    • warning

      added the new YEAR enum value to the //////// response property for the response status

    • warning

      added the new YEAR enum value to the //////// response property for the response status

    • warning

      added the new YEAR enum value to the //////// response property for the response status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status