PackageVersionDescription

{
  "$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-version-description-schema.json",
  "title": "PackageVersionDescription",
  "description": " Details about a package version. ",
  "type": "object",
  "properties": {
    "format": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageFormat"
        },
        {
          "description": " The format of the package version. "
        }
      ]
    },
    "namespace": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageNamespace"
        },
        {
          "description": "<p>The namespace of the package version. The package version component that specifies its namespace depends on its type. For example:</p> <ul> <li> <p> The namespace of a Maven package version is its <code>groupId</code>. </p> </li> <li> <p> The namespace of an npm package version is its <code>scope</code>. </p> </li> <li> <p> Python and NuGet package versions do not contain a corresponding component, package versions 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>"
        }
      ]
    },
    "packageName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageName"
        },
        {
          "description": " The name of the requested package. "
        }
      ]
    },
    "displayName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String255"
        },
        {
          "description": " The name of the package that is displayed. The <code>displayName</code> varies depending on the package version's format. For example, if an npm package is named <code>ui</code>, is in the namespace <code>vue</code>, and has the format <code>npm</code>, then the <code>displayName</code> is <code>@vue/ui</code>. "
        }
      ]
    },
    "version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageVersion"
        },
        {
          "description": " The version of the package. "
        }
      ]
    },
    "summary": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format. "
        }
      ]
    },
    "homePage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " The homepage associated with the package. "
        }
      ]
    },
    "sourceCodeRepository": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " The repository for the source code in the package version, or the source code used to build it. "
        }
      ]
    },
    "publishedTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": " A timestamp that contains the date and time the package version was published. "
        }
      ]
    },
    "licenses": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LicenseInfoList"
        },
        {
          "description": " Information about licenses associated with the package version. "
        }
      ]
    },
    "revision": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageVersionRevision"
        },
        {
          "description": " The revision of the package version. "
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageVersionStatus"
        },
        {
          "description": " A string that contains the status of the package version. "
        }
      ]
    },
    "origin": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageVersionOrigin"
        },
        {
          "description": "A <a href=\"https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html\">PackageVersionOrigin</a> object that contains information about how the package version was added to the repository."
        }
      ]
    }
  }
}