Dexi Developer Portal

App Developer Portal

Welcome to the App Developer portal for dexi.io.

Here you'll find resources for developing apps and integrations on dexi.io.

Get Started    

File Components

All file component types share the prefix file- and what they have in common is that they work with files.

The file component types are:

TypeDescriptionInterface
file-sourceReads a file from "somewhere"FileSourceAppComponent
file-storageStores a file "somewhere"FileStorageAppComponent
file-filterApplies filter to fileFileFilterAppComponent
file-parserParses file into structured dataFileParserAppComponent

All file component types share the same specification schema - which supports the following properties:

PropertyDescriptionRequired?
endpointThe primary endpoint of the component which performs the actual operation the component implements.

See Endpoints for the structure.
Yes
validateAn endpoint to allow your service to validate the component configuration.

See Endpoints for the structure.

See ComponentValidatesConfiguration for implementation details.
No
configurationStatic configuration for the component.

See Configuration Field Types for structure and options
No
dynamicConfigurationThis allows the configuration to be generated by your service instead of being defined directly in the YML.

See Endpoints for structure

See ComponentHasDynamicConfigurationSchema for implementation details.
No
outputsStatic configuration of the output schema for your component. This schema is expected to be for a single "result" row.

See Data Field Types for structure and options.
Either this or dynamicOutputs is required for file-parser
dynamicOutputsThis allows you to generate the outputs schema within your service.

See Endpoints for structure.

See ComponentHasDynamicDataSchema for implementation details.
Either this or outputs is required for file-parser

Updated about a year ago

File Components


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.