generate_endpoint_group
Generate clearskies EndpointGroup configurations for your API by specifying URL prefix, endpoint list, and authentication.
Instructions
Generate a clearskies EndpointGroup configuration.
Args:
url: The URL prefix for all endpoints in the group.
endpoints: List of endpoint configurations. Each dict has:
- type (str): Endpoint type (e.g. "RestfulApi", "Callable", "List")
- model_name (str): Model class name (for model-based endpoints)
- url (str): URL path for this endpoint
- readable_column_names (list[str], optional): Readable columns
- writeable_column_names (list[str], optional): Writeable columns
- sortable_column_names (list[str], optional): Sortable columns
- searchable_column_names (list[str], optional): Searchable columns
- default_sort_column_name (str, optional): Default sort column
- request_methods (list[str], optional): Allowed HTTP methods (for Callable)
- extra_options (dict, optional): Additional endpoint options
authentication: Authentication configuration for all endpoints in the group
(e.g. 'clearskies.authentication.SecretBearer(environment_key="MY_SECRET")').
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| endpoints | No | ||
| authentication | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |