Module Values.GetPackageVersionReadmeResultSource

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. format : PackageFormat.t option;
    (*

    The format of the package with the requested readme file.

    *)
  2. 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 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.

    *)
  3. package : PackageName.t option;
    (*

    The name of the package that contains the returned readme file.

    *)
  4. version : PackageVersion.t option;
    (*

    The version of the package with the requested readme file.

    *)
  5. versionRevision : PackageVersionRevision.t option;
    (*

    The current revision associated with the package version.

    *)
  6. readme : String_.t option;
    (*

    The text of the returned readme file.

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ResourceNotFoundException of ResourceNotFoundException.t
  4. | `ThrottlingException of ThrottlingException.t
  5. | `ValidationException of ValidationException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?format:??? -> ?namespace:??? -> ?package:??? -> ?version:??? -> ?versionRevision:??? -> ?readme:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ResourceNotFoundException of ResourceNotFoundException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of PackageNamespace.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