Get a package.

Gets Package by its uuid. The API accepts a package UUID.

Path Parameters

packageUuid string required

Query Parameters

include string

options to get more data on the package by comma-separated list as string, for now the only option is errorCount, file, repository

Responses

• 200
• 422

---

get package by uuid

application/json

Schema

Example (from schema)

Example 1

---

Schema

errorCount double
fileMetadataId string
fileMetadataPath string
fixableErrorCount double
images string[]
isRoot boolean
licensesMetadata object[]
Array [
isOsi boolean required
isSpdx boolean required
license string required
]
packageId string required
packageLanguage string
packageLicenses string[] required
packageName string required
packageVersion string required
repository object
name string
owner string
sourcePackageIds object[] nullable
Array [
sourcePackageId string required
]

{
  "errorCount": 0,
  "fileMetadataId": "string",
  "fileMetadataPath": "string",
  "fixableErrorCount": 0,
  "images": [
    "string"
  ],
  "isRoot": true,
  "licensesMetadata": [
    {
      "isOsi": true,
      "isSpdx": true,
      "license": "string"
    }
  ],
  "packageId": "string",
  "packageLanguage": "string",
  "packageLicenses": [
    "string"
  ],
  "packageName": "string",
  "packageVersion": "string",
  "repository": {
    "name": "string",
    "owner": "string"
  },
  "sourcePackageIds": [
    {
      "sourcePackageId": "string"
    }
  ]
}

{
  "errorCount": 3,
  "fileMetadataId": "8d79e5a6-399b-42c3-8678-1fc165ca72c5",
  "packageId": "b3f4f652-b71a-4b8b-8b7f-jd2k359k5d36",
  "packageLicenses": [],
  "packageName": "express",
  "packageVersion": "4.17.1"
}

Request arguments validation error

Loading...