Module Values.GetPackageVersionReadmeRequestSource

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.

Sourcetype nonrec t = {
  1. domain : DomainName.t;
    (*

    The name of the domain that contains the repository that contains the package version with the requested readme file.

    *)
  2. domainOwner : AccountId.t option;
    (*

    The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

    *)
  3. repository : RepositoryName.t;
    (*

    The repository that contains the package with the requested readme file.

    *)
  4. format : PackageFormat.t;
    (*

    A format that specifies the type of the package version with the requested readme file.

    *)
  5. namespace : PackageNamespace.t option;
    (*

    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.

    *)
  6. package : PackageName.t;
    (*

    The name of the package version that contains the requested readme file.

    *)
  7. packageVersion : PackageVersion.t;
    (*

    A string that contains the package version (for example, 3.5.2).

    *)
}
Sourceval context_ : string
Sourceval make : ?domainOwner:??? -> ?namespace:??? -> domain:DomainName.t -> repository:RepositoryName.t -> format:PackageFormat.t -> package:PackageName.t -> packageVersion:PackageVersion.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of DomainName.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t