PackageDescription

Details about a package.

AmazonArtifact RepositoryPackage ManagementDevOpsSoftware Supply ChainnpmMavenPyPINuGet

Properties

Name Type Description
format object
namespace object
name object
originConfiguration object
View JSON Schema on GitHub

JSON Schema

codeartifact-package-description-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeartifact/refs/heads/main/json-schema/codeartifact-package-description-schema.json",
  "title": "PackageDescription",
  "description": "Details about a package.",
  "type": "object",
  "properties": {
    "format": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageFormat"
        },
        {
          "description": "A format that specifies the type of the package."
        }
      ]
    },
    "namespace": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageNamespace"
        },
        {
          "description": "<p>The namespace of the package. The package component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm package is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. </p> </li> <li> <p> The namespace of a generic package is its <code>namespace</code>. </p> </li> </ul>"
        }
      ]
    },
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageName"
        },
        {
          "description": "The name of the package."
        }
      ]
    },
    "originConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageOriginConfiguration"
        },
        {
          "description": "The package origin configuration for the package."
        }
      ]
    }
  }
}