Module Values.DocumentationPartSource

A documentation part for a targeted API entity.

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

    The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

    *)
  2. location : DocumentationPartLocation.t option;
    (*

    The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

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

    A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

    *)
}
Sourcetype nonrec error = [
  1. | `BadRequestException of BadRequestException.t
  2. | `ConflictException of ConflictException.t
  3. | `LimitExceededException of LimitExceededException.t
  4. | `NotFoundException of NotFoundException.t
  5. | `TooManyRequestsException of TooManyRequestsException.t
  6. | `UnauthorizedException of UnauthorizedException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?id:??? -> ?location:??? -> ?properties:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `BadRequestException of BadRequestException.t | `ConflictException of ConflictException.t | `LimitExceededException of LimitExceededException.t | `NotFoundException of NotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `BadRequestException of BadRequestException.t | `ConflictException of ConflictException.t | `LimitExceededException of LimitExceededException.t | `NotFoundException of NotFoundException.t | `TooManyRequestsException of TooManyRequestsException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of String_.t | `Structure of (string * [> `Enum of string | `String of String_.t ]) list ]) 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