Convert OpenAPI specs to Tracecat Action Templates.
--config
parameter:
endpoints
section to control which API endpoints are processed:
include.like
: Glob patterns to include paths (e.g., /users/*
)include.exact
: Exact paths to include (e.g., /users/profile
)exclude.like
: Glob patterns to exclude paths (e.g., /internal/*
)exclude.exact
: Exact paths to exclude (e.g., /users/admin
)definition_overrides
section allows you to customize the generated action definitions. The supported fields are:
display_group
: Sets the display group for the action (e.g., “PetStore”)namespace
: Sets the namespace for the action (e.g., “the.pet.store”)author
: Sets the author of the action (e.g., “OpenAPI Generator”)doc_url_prefix
: Sets a prefix for documentation URLs (e.g., “https://petstore.swagger.io/docs”)name
: Overrides the action name (e.g., “delete_pet”)title
: Overrides the action title (e.g., “Deletes a pet”)description
: Overrides the action description (e.g., “HTTP DELETE request to /pet/”)doc_url
: Overrides the documentation URL (e.g., “https://petstore.swagger.io/v2”)deprecated
: Sets a deprecation message or flag (e.g., “This action is deprecated.”)auth
section configures authentication for the generated actions:
secrets
: Defines required secrets with name and keysinjection
: Specifies how to inject authentication into requests via headers or query parametersexpects
: Defines expected input fields for authenticationuse_namespace_directories
option controls how the generated files are organized:
true
(default): Creates subdirectories based on the action namespace (e.g., api/pets/action.yml
)false
: Places all actions directly in the output directory