Skip to content

/AWS1/IF_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

METHODS /AWS1/IF_ART~GETPACKAGEVERSIONREADME
  IMPORTING
    !IV_DOMAIN TYPE /AWS1/ARTDOMAINNAME OPTIONAL
    !IV_DOMAINOWNER TYPE /AWS1/ARTACCOUNTID OPTIONAL
    !IV_REPOSITORY TYPE /AWS1/ARTREPOSITORYNAME OPTIONAL
    !IV_FORMAT TYPE /AWS1/ARTPACKAGEFORMAT OPTIONAL
    !IV_NAMESPACE TYPE /AWS1/ARTPACKAGENAMESPACE OPTIONAL
    !IV_PACKAGE TYPE /AWS1/ARTPACKAGENAME OPTIONAL
    !IV_PACKAGEVERSION TYPE /AWS1/ARTPACKAGEVERSION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_artgetpackagevrsrea01
  RAISING
    /AWS1/CX_ARTACCESSDENIEDEX
    /AWS1/CX_ARTINTERNALSERVEREX
    /AWS1/CX_ARTRESOURCENOTFOUNDEX
    /AWS1/CX_ARTTHROTTLINGEX
    /AWS1/CX_ARTVALIDATIONEX
    /AWS1/CX_ARTCLIENTEXC
    /AWS1/CX_ARTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

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, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

RETURNING

oo_output TYPE REF TO /aws1/cl_artgetpackagevrsrea01 /AWS1/CL_ARTGETPACKAGEVRSREA01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getpackageversionreadme(
  iv_domain = |string|
  iv_domainowner = |string|
  iv_format = |string|
  iv_namespace = |string|
  iv_package = |string|
  iv_packageversion = |string|
  iv_repository = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_packageformat = lo_result->get_format( ).
  lv_packagenamespace = lo_result->get_namespace( ).
  lv_packagename = lo_result->get_package( ).
  lv_packageversion = lo_result->get_version( ).
  lv_packageversionrevision = lo_result->get_versionrevision( ).
  lv_string = lo_result->get_readme( ).
ENDIF.