Skip to content

RestConfiguration

Source code in docs_src/capo_glue/types/rest_configuration.py
class RestConfiguration(TypedDict, closed=True):
    global_source_configuration: NotRequired[
        "capo_glue.types.source_configuration.SourceConfiguration"
    ]
    """<p>Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.</p>"""
    validation_endpoint_configuration: NotRequired[
        "capo_glue.types.source_configuration.SourceConfiguration"
    ]
    """<p>Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.</p>"""
    entity_configurations: NotRequired[
        "capo_glue.types.entity_configuration_map.EntityConfigurationMap"
    ]
    """<p>A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.</p>"""

entity_configurations instance-attribute

entity_configurations: NotRequired[EntityConfigurationMap]

A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.

global_source_configuration instance-attribute

global_source_configuration: NotRequired[SourceConfiguration]

Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.

validation_endpoint_configuration instance-attribute

validation_endpoint_configuration: NotRequired[SourceConfiguration]

Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.