Sign in

v1

latestOpenAPI 3.0.02026-07-1717219.3 KB
harvest

Gets the harvested file for a component revision.

get/harvest/{type}/{provider}/{namespace}/{name}/{revision}/{tool}/{toolVersion}

Path parameters

type'composer' | 'conda' | 'condasrc' | 'crate' | 'deb' | 'debsrc' | 'gem' | 'git' | 'go' | 'maven' | 'npm' | 'nuget' | 'pod' | 'pypi' | 'sourcearchive' required

the type of component

provider'anaconda-main' | 'anaconda-r' | 'cocoapods' | 'conda-forge' | 'cratesio' | 'debian' | 'github' | 'gitlab' | 'mavencentral' | 'mavengoogle' | 'gradleplugin' | 'npmjs' | 'nuget' | 'packagist' | 'pypi' | 'rubygems' required

where the component can be found

namespacestring required

many component systems have namespaces. GitHub orgs, NPM namespace, Maven group id, Conda Subdir/Architecture ... This segment must be supplied. If your component does not have a namespace, use '-' (ASCII hyphen).

namestring required

the name of the component you want. Given the namespace segment mentioned above, this is just the simple name.

revisionstring required

components typically have some differentiator like a version or commit id. Use that here. If this segment is omitted, the latest revision is used (if that makes sense for the provider).

toolstring required

the identifier of the tool

toolVersionstring required

the identifier of the tool version

Query parameters

form'summary' | 'streamed' | 'raw' | 'list'

Form of the response:

  • summary - summarized harvested file
  • raw or streamed - content of the harvested file
  • list - list of matching harvested files

Response

Harvested file.