/AWS1/CL_ART=>GETPACKAGEVERSIONREADME()¶
About GetPackageVersionReadme¶
Gets the readme file or descriptive text for a package version.
The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DOMAIN TYPE /AWS1/ARTDOMAINNAME /AWS1/ARTDOMAINNAME¶
The name of the domain that contains the repository that contains the package version with the requested readme file.
IV_REPOSITORY TYPE /AWS1/ARTREPOSITORYNAME /AWS1/ARTREPOSITORYNAME¶
The repository that contains the package with the requested readme file.
IV_FORMAT TYPE /AWS1/ARTPACKAGEFORMAT /AWS1/ARTPACKAGEFORMAT¶
A format that specifies the type of the package version with the requested readme file.
IV_PACKAGE TYPE /AWS1/ARTPACKAGENAME /AWS1/ARTPACKAGENAME¶
The name of the package version that contains the requested readme file.
IV_PACKAGEVERSION TYPE /AWS1/ARTPACKAGEVERSION /AWS1/ARTPACKAGEVERSION¶
A string that contains the package version (for example,
3.5.2).
Optional arguments:¶
IV_DOMAINOWNER TYPE /AWS1/ARTACCOUNTID /AWS1/ARTACCOUNTID¶
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
IV_NAMESPACE TYPE /AWS1/ARTPACKAGENAMESPACE /AWS1/ARTPACKAGENAMESPACE¶
The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:
The namespace is required when requesting the readme from package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its
groupId.The namespace of an npm or Swift package version is its
scope.The namespace of a generic package is its
namespace.Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.