diff --git a/docs/schemas/config_schema.json b/docs/schemas/config_schema.json index 01fc1111..edd80a98 100644 --- a/docs/schemas/config_schema.json +++ b/docs/schemas/config_schema.json @@ -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": [ @@ -120,6 +121,7 @@ "default": "default", "enum": [ "default", + "everforest", "dark", "light", "dracula", diff --git a/docs/schemas/flowfile_schema.json b/docs/schemas/flowfile_schema.json index 22d1eb56..2d40e2d7 100644 --- a/docs/schemas/flowfile_schema.json +++ b/docs/schemas/flowfile_schema.json @@ -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": { @@ -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": [ diff --git a/docs/schemas/template_schema.json b/docs/schemas/template_schema.json index 449561e8..22c8a942 100644 --- a/docs/schemas/template_schema.json +++ b/docs/schemas/template_schema.json @@ -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": [ diff --git a/docs/schemas/workspace_schema.json b/docs/schemas/workspace_schema.json index a11d6a94..1edf3d97 100644 --- a/docs/schemas/workspace_schema.json +++ b/docs/schemas/workspace_schema.json @@ -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": { diff --git a/tools/docsgen/json.go b/tools/docsgen/json.go index 50552853..22dee6e0 100644 --- a/tools/docsgen/json.go +++ b/tools/docsgen/json.go @@ -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) diff --git a/tools/docsgen/schema/schema.go b/tools/docsgen/schema/schema.go index 36cfbe55..5cb39dba 100644 --- a/tools/docsgen/schema/schema.go +++ b/tools/docsgen/schema/schema.go @@ -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"` diff --git a/types/config/config.gen.go b/types/config/config.gen.go index 23fdf328..1fe8bdde 100644 --- a/types/config/config.gen.go +++ b/types/config/config.gen.go @@ -133,6 +133,7 @@ type ConfigTheme string const ConfigThemeDark ConfigTheme = "dark" const ConfigThemeDefault ConfigTheme = "default" const ConfigThemeDracula ConfigTheme = "dracula" +const ConfigThemeEverforest ConfigTheme = "everforest" const ConfigThemeLight ConfigTheme = "light" const ConfigThemeTokyoNight ConfigTheme = "tokyo-night" diff --git a/types/config/schema.yaml b/types/config/schema.yaml index 77fa19d4..8b6928a7 100644 --- a/types/config/schema.yaml +++ b/types/config/schema.yaml @@ -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: