Talos API configurations

While configuring Talos, the apis folder contains an SQL file and a manifest file. The SQL file defines the queries, while the manifest file specifies the URL path, description, source, and allowed user groups.

Sample manifest files:

example.sql:

SELECT * FROM myschema.mytable LIMIT 10;

example.yaml:

urlPath: /table # output path
description: product list # description
source: ${{snowflakedepot}} # source name
allow:  # allowed user groups
  - intern  
  - datadev

urlPath

Description: The API endpoint path is specified in the manifest file under the url field. This path determines where the API can be accessed.

Data Type	Requirement	Default Value	Possible Values
string	mandatory	none	Any valid URL path format

Example Usage:

urlPath: /table

description

Description: Brief description about the data which can be accessed by the API.

Data Type	Requirement	Default Value	Possible Values
string	mandatory	none	Any descriptive text

Example Usage:

description: product list

source

Description: The source name from which data is sourced.

Data Type	Requirement	Default Value	Possible Values
string	mandatory	none	Any valid source reference

Example Usage:

source: ${{snowflakedepot}}

allow

Description: List of allowed user groups.

Data Type	Requirement	Default Value	Possible Values
list of strings	optional	none	List of valid user groups

Example Usage:

allow:
  - intern
  - datadev