Documentation
¶
Index ¶
Constants ¶
View Source
const (
// DefaultPath is the canonical generated OpenAPI output location.
DefaultPath = "openapi/compozy.json"
)
View Source
const RequestUploadForm = "multipart/form-data"
RequestUploadForm documents a multipart upload carrying one required binary "file" field.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type OperationAuth ¶
type OperationAuth string
OperationAuth identifies the transport-owned trust boundary for an operation.
const ( OperationAuthDevice OperationAuth = "device" OperationAuthLocalSocket OperationAuth = "local_socket" OperationAuthPrivatePreAuth OperationAuth = "private_pre_auth" )
type OperationSpec ¶
type OperationSpec struct {
Stability string
Method string
Path string
OperationID string
Summary string
Tags []string
Transports []Transport
Auth map[Transport]OperationAuth
Parameters []ParameterSpec
RequestBody any
// RequestBodyOptional keeps a request body schema documented while allowing empty requests.
RequestBodyOptional bool
// RequestContentType overrides the request media type; an empty value uses application/json when RequestBody is set.
// RequestUploadForm is the only non-JSON value accepted today.
RequestContentType string
Responses []ResponseSpec
}
OperationSpec describes one canonical REST operation.
func Operations ¶
func Operations() []OperationSpec
Operations returns the complete transport-neutral operation registry.
type ParameterSpec ¶
type ParameterSpec struct {
Name string
In string
Description string
Required bool
Kind string
Format string
Enum []string
Pattern string
MaxLength *uint64
Maximum *float64
}
ParameterSpec describes one OpenAPI parameter.
Source Files
¶
- agent_catalog.go
- agent_definitions.go
- agent_hook_values.go
- agent_identity_contract.go
- agent_name_schema.go
- agent_notify_schema.go
- attention_notification_operations.go
- authored_context.go
- authored_context_heartbeat_operations.go
- authored_context_registry.go
- authored_context_session_operations.go
- authored_context_soul_operations.go
- automation_loop_values.go
- automation_suggestions.go
- automation_values.go
- clarify.go
- cmd_palette.go
- extension_authoring_schemas.go
- extension_input_schema.go
- goal_enums.go
- goals.go
- loop_catalog.go
- loop_read_operations.go
- loop_run_event_schemas.go
- loop_schemas.go
- loops.go
- loops_input_defaults.go
- loops_nodes.go
- loops_timetravel.go
- marketplace_operations.go
- marketplace_refresh_operation.go
- marketplace_source_operations.go
- memory_values.go
- model_catalog.go
- operation_builder.go
- operation_clone.go
- operation_registry.go
- operation_validation.go
- operations.go
- parameters.go
- paths.go
- providers.go
- registry_agent_runtime.go
- registry_agents.go
- registry_automation.go
- registry_automation_runs.go
- registry_automation_webhooks.go
- registry_extension_updates.go
- registry_extensions.go
- registry_filesystem.go
- registry_gateway.go
- registry_hooks.go
- registry_logs.go
- registry_memory.go
- registry_memory_lifecycle.go
- registry_observe_overview.go
- registry_onboarding.go
- registry_profiles.go
- registry_resources.go
- registry_roles.go
- registry_session_archive.go
- registry_session_attach.go
- registry_session_attachments.go
- registry_session_history.go
- registry_session_input_clear.go
- registry_session_runtime.go
- registry_sessions.go
- registry_settings.go
- registry_settings_attention.go
- registry_settings_cmd_palette.go
- registry_settings_features.go
- registry_settings_persona.go
- registry_settings_shell.go
- registry_settings_window_manager.go
- registry_skills.go
- registry_support.go
- registry_task_lifecycle.go
- registry_task_management.go
- registry_task_runs.go
- registry_task_state.go
- registry_tools.go
- registry_toolsets.go
- registry_vault.go
- registry_workspaces.go
- registry_worktrees.go
- render.go
- response_body.go
- runtime_status.go
- schema_customizers.go
- schema_enum_registry.go
- schema_reflection.go
- scope_values.go
- session_admission.go
- session_attach_schema.go
- session_catalog.go
- session_navigation.go
- session_transcript.go
- session_values.go
- settings_marketplace_operations.go
- settings_mcp_auth.go
- settings_mcp_collection.go
- settings_mcp_schema.go
- settings_shell_values.go
- settings_update_schema.go
- settings_values.go
- settings_window_manager_values.go
- skill_schema_enums.go
- spec.go
- spec_logs.go
- spec_memory_decisions.go
- spec_memory_list.go
- task_schema.go
- task_values.go
- terminal.go
- terminal_operation_helpers.go
- terminal_operations_artifact.go
- terminal_operations_catalog.go
- terminal_operations_command.go
- tool_approval_grants.go
- tool_artifacts.go
- tool_extension_values.go
- tool_schema_enums.go
- windowmanager.go
- windowmanager_command_schema.go
- windowmanager_schemas.go
Click to show internal directories.
Click to hide internal directories.