Module Values.ImportRestApiRequestSource

A POST request to import an API to API Gateway using an input of an API definition file.

Sourcetype nonrec t = {
  1. failOnWarnings : Boolean.t option;
    (*

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

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

    A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values. To exclude DocumentationParts from the import, set parameters as ignore=documentation. To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE. To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

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

    The POST 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 : ?failOnWarnings:??? -> ?parameters:??? -> 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 | `Map of ([> `String of String_.t ] * [> `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