Module Values.PutRestApiRequestSource

A PUT request to update an existing API, with external API definitions specified as the request body.

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

    The string identifier of the associated RestApi.

    *)
  2. mode : PutMode.t option;
    (*

    The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

    *)
  3. failOnWarnings : Boolean.t option;
    (*

    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

    *)
  4. parameters : MapOfStringToString.t option;
    (*

    Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

    *)
  5. body : Blob.t;
    (*

    The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

    *)
}
Sourceval context_ : string
Sourceval make : ?mode:??? -> ?failOnWarnings:??? -> ?parameters:??? -> restApiId:String_.t -> body:Blob.t -> unit -> t
Sourceval of_header_and_body : ((Base.String.t, String_.t) Awso.Import.List.Assoc.t * Blob.t) -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Blob of Blob.t | `Boolean of Boolean.t | `Enum of string | `Map of ([> `String of String_.t ] * [> `String of String_.t ]) list | `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