Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/schemas/config_schema.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://flowexec.io/schemas/config_schema.json",
"title": "Config",
"description": "User Configuration for the Flow CLI.\nIncludes configurations for workspaces, templates, I/O, and other settings for the CLI.\n\nIt is read from the user's flow config directory:\n- **MacOS**: `$HOME/Library/Application Support/flow`\n- **Linux**: `$HOME/.config/flow`\n- **Windows**: `%APPDATA%\\flow`\n\nAlternatively, a custom path can be set using the `FLOW_CONFIG_PATH` environment variable.\n",
"type": "object",
"required": [
Expand Down Expand Up @@ -120,6 +121,7 @@
"default": "default",
"enum": [
"default",
"everforest",
"dark",
"light",
"dracula",
Expand Down
2 changes: 2 additions & 0 deletions docs/schemas/flowfile_schema.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://flowexec.io/schemas/flowfile_schema.json",
"title": "FlowFile",
"description": "Configuration for a group of Flow CLI executables. The file must have the extension `.flow` in order to be discovered \nby the CLI. It's configuration is used to define a group of executables with shared metadata (namespace, tags, etc).\nA workspace can have multiple flow files located anywhere in the workspace directory\n",
"type": "object",
"definitions": {
Expand Down Expand Up @@ -30,6 +31,7 @@
]
},
"Executable": {
"title": "Executable",
"description": "The executable schema defines the structure of an executable in the Flow CLI.\nExecutables are the building blocks of workflows and are used to define the actions that can be performed in a workspace.\n",
"type": "object",
"required": [
Expand Down
1 change: 1 addition & 0 deletions docs/schemas/template_schema.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://flowexec.io/schemas/template_schema.json",
"title": "Template",
"description": "Configuration for a flowfile template; templates can be used to generate flow files.",
"type": "object",
"required": [
Expand Down
1 change: 1 addition & 0 deletions docs/schemas/workspace_schema.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://flowexec.io/schemas/workspace_schema.json",
"title": "Workspace",
"description": "Configuration for a workspace in the Flow CLI.\nThis configuration is used to define the settings for a workspace.\nEvery workspace has a workspace config file named `flow.yaml` in the root of the workspace directory.\n",
"type": "object",
"definitions": {
Expand Down
1 change: 1 addition & 0 deletions tools/docsgen/json.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ func generateJSONSchemas() {
schema.MergeSchemas(s, value, fn, sm)
}

s.Title = fn.Title()
schemaJSON, err := json.MarshalIndent(s, "", " ")
if err != nil {
panic(err)
Expand Down
1 change: 1 addition & 0 deletions tools/docsgen/schema/schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ type JSONSchema struct {
Schema string `json:"$schema,omitempty" yaml:"$schema,omitempty"`
Ref Ref `json:"$ref,omitempty" yaml:"$ref,omitempty"`
ID string `json:"$id,omitempty" yaml:"$id,omitempty"`
Title string `json:"title,omitempty" yaml:"title,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Type string `json:"type,omitempty" yaml:"type,omitempty"`
Required []string `json:"required,omitempty" yaml:"required,omitempty"`
Expand Down
1 change: 1 addition & 0 deletions types/config/config.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion types/config/schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ properties:
$ref: '#/definitions/Interactive'
theme:
type: string
enum: [default, dark, light, dracula, tokyo-night]
enum: [default, everforest, dark, light, dracula, tokyo-night]
description: The theme of the interactive UI.
default: default
colorOverride:
Expand Down