generate_endpoint
Generate a clearskies endpoint configuration by specifying endpoint type and model name, with options for URL, columns, authentication, and extra settings.
Instructions
Generate a clearskies endpoint configuration.
Args:
endpoint_type: Type of endpoint (e.g. "RestfulApi", "List", "Create", "Get", "Update", "Delete", "Callable").
model_name: The model class name to use with this endpoint.
url: The URL path for the endpoint (optional).
readable_column_names: List of column names that are returned in the response.
writeable_column_names: List of column names the client can set.
sortable_column_names: List of column names the client can sort by.
searchable_column_names: List of column names the client can search by.
default_sort_column_name: The default column to sort by.
authentication: Authentication configuration (e.g. 'clearskies.authentication.SecretBearer(environment_key="MY_SECRET")').
extra_options: Additional keyword arguments for the endpoint constructor.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| model_name | Yes | ||
| endpoint_type | Yes | ||
| extra_options | No | ||
| authentication | No | ||
| readable_column_names | No | ||
| sortable_column_names | No | ||
| writeable_column_names | No | ||
| searchable_column_names | No | ||
| default_sort_column_name | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |