Amazon CodeArtifact · JSON Structure

Codeartifact Get Package Version Readme Result Structure

GetPackageVersionReadmeResult schema from Amazon CodeArtifact API

Type: object Properties: 5
AmazonArtifact RepositoryPackage ManagementDevOpsSoftware Supply ChainnpmMavenPyPINuGet

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

Properties

namespace package version versionRevision readme

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-get-package-version-readme-result-structure.json",
  "name": "GetPackageVersionReadmeResult",
  "description": "GetPackageVersionReadmeResult schema from Amazon CodeArtifact API",
  "type": "object",
  "properties": {
    "namespace": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageNamespace"
        },
        {
          "description": "<p>The namespace of the package version with the requested readme file. 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> </ul>"
        }
      ]
    },
    "package": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageName"
        },
        {
          "description": " The name of the package that contains the returned readme file. "
        }
      ]
    },
    "version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageVersion"
        },
        {
          "description": " The version of the package with the requested readme file. "
        }
      ]
    },
    "versionRevision": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageVersionRevision"
        },
        {
          "description": " The current revision associated with the package version. "
        }
      ]
    },
    "readme": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": " The text of the returned readme file. "
        }
      ]
    }
  }
}