Module Values.GetDocumentationPartsRequestSource

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Sourcetype nonrec t = {
  1. restApiId : String_.t;
    (*

    The string identifier of the associated RestApi.

    *)
  2. type_ : DocumentationPartType.t option;
    (*

    The type of API entities of the to-be-retrieved documentation parts.

    *)
  3. nameQuery : String_.t option;
    (*

    The name of API entities of the to-be-retrieved documentation parts.

    *)
  4. path : String_.t option;
    (*

    The path of API entities of the to-be-retrieved documentation parts.

    *)
  5. position : String_.t option;
    (*

    The current pagination position in the paged result set.

    *)
  6. limit : NullableInteger.t option;
    (*

    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

    *)
  7. locationStatus : LocationStatusType.t option;
    (*

    The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

    *)
}
Sourceval context_ : string
Sourceval make : ?type_:??? -> ?nameQuery:??? -> ?path:??? -> ?position:??? -> ?limit:??? -> ?locationStatus:??? -> restApiId:String_.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Integer of NullableInteger.t | `String of String_.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