v1
latestOpenAPI 3.0.02026-07-1717219.3 KBdefinitions
Previews the definition of a component revision with the proposed curation.
get/definitions/{type}/{provider}/{namespace}/{name}/{revision}/pr/{pr}
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).
prnumber required
the GitHub PR number to apply to the existing harvested and curated data. Note that that this parameter must be preceded by a 'pr' segment.
Response
Component definition.