Automates the creation of a Flatfile Blueprint (Workbook and Sheets) from one or more YAML schema definitions, streamlining the setup of a Flatfile Space by converting existing data models into a Flatfile-compatible format.
Parameter | Type | Required | Description |
---|---|---|---|
sourceUrl | string | Yes | The URL where the YAML schema file is hosted |
name | string | No | A custom name for the generated Sheet. If not provided, the title from the YAML schema is used |
Additional properties | - | No | Other Flatfile.SheetConfig properties (e.g., actions ) can be included to customize the Sheet |
Parameter | Type | Default | Description |
---|---|---|---|
workbookConfig | PartialWorkbookConfig | - | Configuration for the generated Workbook (name, actions, etc.) |
debug | boolean | false | When set to true , prints the generated Blueprint configuration object to the console |
Parameter | Type | Description |
---|---|---|
name | string | Custom name for the Workbook. Defaults to “YAML Schema Workbook” if not provided |
actions | array | Custom actions for the Workbook |
Additional properties | - | Other properties from Flatfile.CreateWorkbookConfig |
debug: true
option. When enabled, the complete generated Blueprint object is printed to the console where the listener is running. This allows you to inspect the exact Workbook, Sheet, and Field configuration that the plugin produced.
sourceUrl
(e.g., due to a network error, 404 Not Found, or invalid URL), it will throw an error with a message like:
Error: Error fetching external reference: API returned status 404: Not Found
YAML Parsing Errors: Errors during YAML parsing will bubble up and cause the configuration to fail. Ensure your YAML schema files are valid and properly formatted.
space:configure
eventsourceUrl
@flatfile/plugin-convert-json-schema
, so supported YAML schema features are limited to what the underlying JSON Schema converter supportsname
is provided for a Sheet, the title
from the YAML schema is usedname
is provided for the Workbook, it defaults to “YAML Schema Workbook”debug
option defaults to false