Amazon CodeArtifact · JSON Structure

Codeartifact Package Summary Structure

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

Type: object Properties: 3
AmazonArtifact RepositoryPackage ManagementDevOpsSoftware Supply ChainnpmMavenPyPINuGet

PackageSummary is a JSON Structure definition published by Amazon CodeArtifact, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

namespace package originConfiguration

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codeartifact/refs/heads/main/json-structure/codeartifact-package-summary-structure.json",
  "name": "PackageSummary",
  "description": " Details about a package, including its format, namespace, and name. ",
  "type": "object",
  "properties": {
    "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."
        }
      ]
    }
  }
}