dependency

APIs.ioEngineeringPlatform

Properties

Name Type Description
package_url string Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.
metadata object
relationship string A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.
scope string A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.
dependencies array Array of package-url (PURLs) of direct child dependencies.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-dependency-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/dependency",
  "title": "dependency",
  "type": "object",
  "properties": {
    "package_url": {
      "type": "string",
      "description": "Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.",
      "example": "pkg:/npm/%40actions/[email protected]",
      "pattern": "^pkg"
    },
    "metadata": {
      "$ref": "#/components/schemas/metadata"
    },
    "relationship": {
      "type": "string",
      "description": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.",
      "example": "direct",
      "enum": [
        "direct",
        "indirect"
      ]
    },
    "scope": {
      "type": "string",
      "description": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.",
      "example": "runtime",
      "enum": [
        "runtime",
        "development"
      ]
    },
    "dependencies": {
      "type": "array",
      "description": "Array of package-url (PURLs) of direct child dependencies.",
      "example": "@actions/http-client",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}