Automatically converts OpenAPI v3.0.3 schemas into Flatfile Blueprints to streamline Space setup using existing API data structures
setupFactory
object passed to the configureSpaceWithOpenAPI
function.
Array<PartialWorkbookConfig>
- An array of workbook configurations to create from OpenAPI schemas
string
- The URL pointing to the raw OpenAPI schema JSON fileArray<PartialSheetConfig>
- An array of sheet configurations, mapping models from the schema to Flatfile Sheets
string
- The name of the model in the OpenAPI components.schemas
section to use for this sheetstring
- A custom display name for the Sheet. Defaults to the model
namestring
- A custom slug for the Sheet. Defaults to the model
nameFlatfile.Action[]
- An array of actions to add to the sheetstring
- A custom name for the Workbook. Defaults to the info.title
property from the OpenAPI schemaFlatfile.Action[]
- An array of actions to add to the workbookobject
- A partial Flatfile.spaces.SpaceConfig
object to apply custom configurations to the Spaceboolean
- A flag for enabling debug modeFlatfileEvent
- The event that triggered the configurationstring[]
- An array of IDs for the newly created workbooksTickFunction
- A function to report progress on the configuration jobSchema not found for table name [sheet slug]
. This indicates that the model
name provided in your configuration does not match any model name found in the components.schemas
section of your OpenAPI file. Ensure the model
name is spelled correctly and exists in the schema.
Common error scenarios:
source
URL cannot be reached or returns a non-200 status code, an error like Error fetching or processing schema: API returned status 404: Not Found
will be thrownsheets
configuration is not found in the schema, an error is logged to the console and that sheet is skippedworkbooks
arrayinfo.title
field from the OpenAPI schemamodel
namestring
, number
, integer
, boolean
) mapped to corresponding Flatfile field typesrequired
in the schema will have a required
constraint in Flatfile@flatfile/plugin-space-configure
to apply the generated configurationarray
types are mapped to Flatfile’s string-list
type by default$ref
) are resolved only within the same document (e.g., #/components/schemas/ModelName
)