Skip to main content

extract-rest-schema

Synopsis

starlake extract-rest-schema [options]

Description

Extract schemas from REST API endpoints by fetching sample responses and inferring the data structure. Generates Starlake YAML configuration files (domain + table definitions) that can be used for subsequent data extraction and ingestion.

Examples

starlake.sh extract-rest-schema --config my-rest-api starlake.sh extract-rest-schema --config my-rest-api --outputDir /tmp/schemas

Parameters

ParameterCardinalityDescription
--config <value>RequiredREST API extraction config file (in metadata/extract/)
--outputDir <value>OptionalWhere to output YAML files
--connectionRef <value>OptionalConnection reference name
--reportFormat <value>OptionalReport format: console, json, html