Module Values_1.SourceConfigurationSource

Configuration that defines how to make requests to endpoints, including request methods, paths, parameters, and response handling.

Sourcetype nonrec t = {
  1. requestMethod : HTTPMethod.t option;
    (*

    The HTTP method to use for requests to this endpoint, such as GET, POST.

    *)
  2. requestPath : PathString.t option;
    (*

    The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.

    *)
  3. requestParameters : ConnectorPropertyList.t option;
    (*

    Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.

    *)
  4. responseConfiguration : ResponseConfiguration.t option;
    (*

    Configuration that defines how to parse and extract data from API responses, including success and error handling.

    *)
  5. paginationConfiguration : PaginationConfiguration.t option;
    (*

    Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.

    *)
}
Sourceval make : ?requestMethod:??? -> ?requestPath:??? -> ?requestParameters:??? -> ?responseConfiguration:??? -> ?paginationConfiguration:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Boolean of bool | `Enum of string | `List of [> `String of string ] list | `String of string ]) list ] list | `String of PathString.t | `Structure of (string * [> `String of JsonPathString.t | `Structure of (string * [> `Structure of (string * [> `Enum of string | `String of Values_0.ConnectorPropertyKey.t | `Structure of (string * [> `String of JsonPathString.t ]) list ]) list ]) list ]) 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