​
RestEndpointConfiguration

RestEndpointConfiguration(**data)
A base class for creating Pydantic models for REST endpoint configuration.

​
Inheritance

Inheritance Chain:
  • RestEndpointConfiguration
  • → ImmutableBaseModel
  • → BaseModel

​
Class Variables

​
api_root_path
str
Root path for the API endpoints.
​
ingest_path_prefix
str
Path prefix for data ingestion endpoints.
​
query_path_prefix
str
Path prefix for query endpoints.
​
model_config
ConfigDict
Pydantic model configuration settings.

​
Static Methods

​
add_slash_to_api_root_path()

add_slash_to_api_root_path(values: dict) -> dict
Utility method to ensure API root path has proper slash formatting.

​
RestQuery

RestQuery(rest_descriptor, query_descriptor)
Configuration class that combines REST descriptor with query descriptor for endpoint setup.

​
Parameters

​
rest_descriptor
RestDescriptor
required
The REST descriptor configuration for this query.
​
query_descriptor
QueryDescriptor
required
The query descriptor defining the query behavior.

​
Properties

​
path
str | None
The configured endpoint path for this query.
​
query_descriptor
QueryDescriptor
The query descriptor associated with this REST query.
​
rest_descriptor
RestDescriptor
The REST descriptor configuration for this query.