PackageSummary

Details about a package, including its format, namespace, and name.

AmazonArtifact RepositoryPackage ManagementDevOpsSoftware Supply ChainnpmMavenPyPINuGet

Properties

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

JSON Schema

codeartifact-package-summary-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-summary-schema.json",
  "title": "PackageSummary",
  "description": " Details about a package, including its format, namespace, and name. ",
  "type": "object",
  "properties": {
    "format": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageFormat"
        },
        {
          "description": " The format 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>"
        }
      ]
    },
    "package": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageName"
        },
        {
          "description": " The name of the package. "
        }
      ]
    },
    "originConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageOriginConfiguration"
        },
        {
          "description": "A <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginConfiguration.html\">PackageOriginConfiguration</a> object that contains a <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html\">PackageOriginRestrictions</a> object that contains information about the upstream and publish package origin restrictions."
        }
      ]
    }
  }
}