API Docs
API Documentation
GET /api/catalog/packages
Retrieves version and compatibility data for OSS components.
Query Parameters
| Name | Type | Description |
|---|---|---|
page | string | Optional Page number (1-indexed) |
size | string | Optional Number of results per page (default 25) |
type | string | Optional Filter by type (e.g. npm, maven) |
namespace | string | Optional Filter by namepsace (e.g. @angular) |
name | string | Optional Filter by name (e.g. passport) |
version | string | Optional Filter by version (e.g. 2.2.0) |
cve | string | Optional Filter by CVE (e.g. CVE-2022-22976) |
api | string | Optional Request a specific version of API (e.g. 1.0.0) |
Available API Versions
- 1.0.0
Response Example
{
"version": "1.0.0",
"totalPages": 21,
"page": 1,
"results": [
{
"versions": [
{
"nes": {
"purl": "pkg:npm/@neverendingsupport/passport",
"latest": "0.2.2-passport-0.2.3",
"versions": [
{
"name": "pkg:npm/@neverendingsupport/passport@0.2.2-passport-0.2.3",
"purl": "pkg:npm/@neverendingsupport/passport@0.2.2-passport-0.2.3",
"latest": true,
"version": "0.2.2-passport-0.2.3"
}
]
},
"oss": {
"compatibility": [
{
"lower": "0.2.0",
"upper": "0.2.2"
}
],
"forkPoint": "0.2.2"
},
"cves": [
"CVE-2022-22976"
],
"version": "0.2.2",
"products": [
"NES for PassportJS"
]
}
],
"component": "pkg:npm/passport"
}
]
}
Response Properties
| Property | Type | Description |
|---|---|---|
version | string | String representing the version of the response |
page | string | Current page of results |
totalPages | string | Total number of pages available for the results |
results | array | Array of results, each representing a component and its associated versions |
results[].component | string | Package URL (purl) of the OSS component |
results[].versions | array | List of version objects for the component |
versions[].version | string | Herodevs version for the entry |
versions[].products | array | Array of Herodevs products that contain this version |
versions[].cves | array | Array of CVEs that are associated with this version |
versions[].nes | NESObject | Info from Never-Ending Support (fork) |
versions[].oss | OSSObject | Info from the original open source (OSS) project |
NESObject
| Property | Type | Description |
|---|---|---|
purl | string | Package URL of the NES package |
latest | string | Latest NES version |
versions | array | Array of specific NES versions |
urls | NESUrls | Info about related URLS |
versions[].name | string | Fully qualified version name with purl |
versions[].purl | string | Package URL of the specific NES version |
versions[].latest | boolean | Whether this is the latest version |
versions[].version | string | Version string |
OSSObject
| Property | Type | Description |
|---|---|---|
compatibility | array | Compatible OSS version ranges, this is a range you can update to the NES version from with limited effort. |
compatibility[].lower | string | Lower bound of compatible OSS versions |
compatibility[].upper | string | Upper bound of compatible OSS versions |
forkPoint | string | OSS version where the fork occurred |
NESUrls
| Property | Type | Description |
|---|---|---|
main | string | Url pointing to HeroDevs marketing page associated with the package |