DeepDocs: Docs updates triggered by 7239e31 in main

[deepdocsai-dev]

Docs Scan Report

• Docs Scan was initialized in keep@main
• 36 docs were found to be outdated

Docs	Reason
extraction-create.mdx	• Line 53 Documented CLI usage flag for 'regex' parameter is incorrect ('--attribute'); CLI help section shows '--regex'. • Line 60 Documented CLI usage placeholder for 'condition' parameter is incorrect (''); does not match CLI help section.
secret-store.mdx	• Line 10 Documentation incorrectly states 'four primary secret manager types' but the enum lists six: FILE, AWS, GCP, K8S, VAULT, DB [Ref: class SecretManagerFactory in secretmanagerfactory.py] • Line 16 Factory supported types miss AWS and DB which have dedicated classes and are in the enum [Ref: class SecretManagerFactory in secretmanagerfactory.py, class AwsSecretManager in awssecretmanager.py, class DbSecretManager in dbsecretmanager.py] • Line 60 Environment variable for tags is SECRET_MANAGER_TAGS in code, not AWS_SECRET_MANAGER_TAGS [Ref: method AwsSecretManager.__init__ in awssecretmanager.py] • Line 97 Kubernetes namespace defaults to 'default' in code, not '.metadata.namespace' [Ref: method KubernetesSecretManager.__init__ in kubernetessecretmanager.py]
provider.mdx	• Line 67 The KEEP_PROVIDERS environment variable example uses inconsistent configuration values for the ClickHouse provider compared to the preceding JSON example (port 4321 vs 1234, password '1234' vs 'keep', database 'keepdb' vs 'keep-db')
http-provider.mdx	• Line 11 Constructor requires context_manager as first parameter, but documentation only mentions provider_id and ProviderConfig [Ref: method HttpProvider.__init__ in http_provider.py]
opensearchserverless-provider.mdx	• Line 114 Documentation incorrectly lists the parameter for document ID as 'id', but the code signature uses 'doc_id' [Ref: method OpensearchserverlessProvider._notify in opensearchserverless_provider.py]
cli-api.mdx	• Lines 38:40 CLI help options list is incomplete; code signature for api() includes 'host: str' and 'port: int' parameters corresponding to --host and --port options [Ref: function api in cli.py]
okta.md	• Lines 7:12 Documentation lists 'User and group management through Okta' as a supported feature, but all provided IdentityManager methods (create_role, delete_role, get_roles, get_users, delete_user, update_user, get_groups) explicitly disable management by logging 'management functions are disabled' and returning empty lists, None, or not_implemented responses. [Ref: method OktaIdentityManager.delete_role in okta_identitymanager.py, method OktaIdentityManager.create_role in okta_identitymanager.py, method OktaIdentityManager.get_roles in okta_identitymanager.py, method OktaIdentityManager.get_users in okta_identitymanager.py, method OktaIdentityManager.delete_user in okta_identitymanager.py, method OktaIdentityManager.update_user in okta_identitymanager.py, method OktaIdentityManager.get_groups in okta_identitymanager.py] • Lines 159:165 Test example references non-existent 'test_okta_create_user' and assumes active user management with Okta API mocking, but no create_user method exists in focus and all management methods are disabled without API calls. [Ref: method OktaIdentityManager.get_users in okta_identitymanager.py, class OktaIdentityManager in okta_identitymanager.py]
cli-provider.mdx	• Line 2 CLI commands are invoked using 'keep' prefix, not 'cli' [Ref: function provider in cli.py] • Line 9 CLI commands are invoked using 'keep' prefix, not 'cli' [Ref: function provider in cli.py] • Line 25 CLI commands are invoked using 'keep' prefix, not 'cli' [Ref: function provider in cli.py] • Lines 32:36 Lists 'delete' subcommand which has no corresponding implementation in the code [Ref: function connect in cli.py, function list_providers in cli.py]
cli-alert.mdx	• Line 2 CLI commands are invoked using 'keep' prefix, not 'cli' [Ref: function alert in cli.py] • Line 9 CLI commands are invoked using 'keep' prefix, not 'cli' [Ref: function alert in cli.py] • Line 25 CLI commands are invoked using 'keep' prefix, not 'cli' [Ref: function alert in cli.py] • Lines 33:36 Lists 'get' subcommand which has no corresponding implementation in the code [Ref: function enrich in cli.py, function list_alerts in cli.py]
extractions-list.mdx	• Line 13 Incorrectly describes listing mappings; code function lists extractions [Ref: function list_extraction in cli.py] • Line 27 CLI commands are invoked using 'keep' prefix, not 'cli.py' [Ref: function list_extraction in cli.py]
extraction-delete.mdx	• Line 16 extraction_id parameter is int type in code, not STRING [Ref: function delete_extraction in cli.py] • Line 34 CLI commands are invoked using 'keep' prefix, not 'cli.py' [Ref: function delete_extraction in cli.py]
cli.mdx	• Line 2 CLI root command is invoked as 'keep', not 'cli' [Ref: function cli in cli.py] • Line 9 CLI root command is invoked as 'keep', not 'cli' [Ref: function cli in cli.py] • Line 52 CLI root command is invoked as 'keep', not 'cli' [Ref: function cli in cli.py]
provider-connect.mdx	• Lines 22:23 Incorrect --help description references installation instead of connection; typo 'shuold' instead of 'should' [Ref: function connect in cli.py]
mappings-list.mdx	• Line 10 Usage omits 'list' subcommand, contradicting the CLI Help section and function name list_mappings [Ref: function list_mappings in cli.py]
cli-workflow.mdx	• Line 2 Command prefix incorrectly listed as 'cli workflow' instead of 'keep workflow' consistent with other CLI docs and project naming [Ref: function workflow in cli.py] • Line 9 Command prefix incorrectly listed as 'cli workflow' instead of 'keep workflow' consistent with other CLI docs and project naming [Ref: function workflow in cli.py] • Line 26 Command prefix incorrectly listed as 'cli workflow' instead of 'keep workflow' consistent with other CLI docs and project naming [Ref: function workflow in cli.py]
workflow-apply.mdx	• Lines 39:41 CLI Help options section incomplete; missing --full-sync and --lookup-by-name parameters present in apply function signature [Ref: function apply in cli.py]
provider-list.mdx	• Line 20 Description incorrectly uses singular 'provider' but the command lists multiple available providers [Ref: function list_providers in cli.py]
mappings-delete.mdx	• Lines 15:20 Type documented as STRING but CLI help and code use INTEGER (int); missing (REQUIRED) indicator inconsistent with other docs [Ref: function delete_mapping in cli.py]
workflow-runs.mdx	• Lines 9:11 CLI command prefix documented as 'cli' but should be 'keep' to match sidebar_title and other command documentation [Ref: function workflow_executions in cli.py]
overview.mdx	• Line 29 KEEP_PROVIDERS contains provider configurations only, not deduplication rules (which come from KEEP_DEDUPLICATION_RULES) [Ref: method Parser._parse_providers_from_env in parser.py, function get_deduplication_rules_to_provision in deduplication_rules_provisioning.py]
deduplication.mdx	• Line 25 Not every provider has a pre-built partial deduplication rule; only those that define default_fingerprint_fields [Ref: method ProvidersFactory.get_default_deduplication_rules in providers_factory.py] • Lines 79:82 Invalid JSON syntax in code example; object keys must be double-quoted strings
anthropic-provider.mdx	• Line 13 Documentation incorrectly names the provider as 'Claude Provider' while the code class is 'AnthropicProvider' and other sections consistently use 'Anthropic Provider' [Ref: method AnthropicProvider._query in anthropic_provider.py]
console-provider.mdx	• Lines 38:40 Example code omits required first positional argument 'context_manager' for ProvidersFactory.get_provider and incorrectly sets provider_id='mock' for a console provider example [Ref: method ProvidersFactory.get_provider in providers_factory.py, class ConsoleProvider in console_provider.py]
ilert-provider.mdx	• Line 4 Internal inconsistency: line 4 refers to 'resolve alerts' while line 10 refers to 'resolve incidents'; standardized to 'incidents' to match the rest of the document and code behavior • Line 24 Incorrect ilert API endpoint URL; the official ilert events API endpoint is /api/v1/events/{ALERT-SOURCE-API-KEY} without the non-existent /keep/ path segment [Ref: method IlertProvider.__post_ilert_event in ilert_provider.py]
mock-provider.mdx	• Line 4 Description incorrectly copied from template provider documentation; Mock provider echoes back inputs as per code docstrings. [Ref: method MockProvider._query python::::keep/providers/mock_provider/mock_provider.py::method::MockProvider._notify in mock_provider.py]
netdata-provider.mdx	• Line 20 Documentation claims Netdata does not support webhooks in on-premises installations, but code implements a specific webhook challenge verification for Netdata. [Ref: function webhook_challenge in alerts.py]
snowflake-provider.mdx	• Line 4 Frontmatter description incorrectly describes the provider as a generic template; it is specifically the Snowflake provider for SQL queries [Ref: class SnowflakeProvider in snowflake_provider.py]
s3-provider.mdx	• Line 12 Code specifies support for 'yaml, json, xml and csv files' only; 'yml' is not listed. [Ref: method S3Provider._query in s3_provider.py] • Line 19 AWS IAM policy version must be '2012-10-17'; '2025-01-15' is invalid. [Ref: method S3Provider._query in s3_provider.py]
wazuh-provider.mdx	• Lines 26:39 Download instructions reference non-existent 'custom-keep' file (source tree lists only 'custom-keep.py'); adjust to single file and specific chown/chmod targets [Ref: class WazuhProvider in wazuh_provider.py] • Lines 41:45 Hardcoded cloud-specific URLs and links ('api.keephq.dev', 'platform.keephq.dev') invalid for self-hosted Keep instances [Ref: class WazuhProvider in wazuh_provider.py]
auth0-snippet-autogenerated.mdx	• Lines 22:23 The query method signature includes 'log_type' (required) and 'from' (optional), but does not include 'previous_users'; documented parameter does not exist in code [Ref: method Auth0Provider._query in auth0_provider.py]
newrelic-snippet-autogenerated.mdx	• Lines 31:32 The _query method uses the 'nrql' parameter, not 'query'. The example incorrectly lists a non-existent 'query' parameter and mislabels the purpose in the comment. [Ref: method NewrelicProvider._query in newrelic_provider.py]
mock-snippet-autogenerated.mdx	• Line 17 The documentation incorrectly states that the mock provider step returns all parameters passed to it, but the code returns only the value of 'command_output' from kwargs if present. [Ref: method MockProvider._query in mock_provider.py]
posthog-snippet-autogenerated.mdx	• Line 48 Documented default limit for get_session_recording_domains is 100 but code signature shows 500; description incorrectly says 'recordings' instead of 'domains' [Ref: method PosthogProvider.get_session_recording_domains in posthog_provider.py]
resend-snippet-autogenerated.mdx	• Lines 31:33 Incorrect workflow example linked for resend provider; bash_example.yml is for bash provider, not resend [Ref: class ResendProvider in resend_provider.py]
site24x7-snippet-autogenerated.mdx	• Line 9 Inconsistent lists of valid TLD values: authentication description includes '.au' while valid_tld scope includes '.com.au'. Corrected authentication description to match the scope list and standard Zoho TLDs. [Ref: method Site24X7Provider.__get_headers in site24x7_provider.py]
sendgrid-snippet-autogenerated.mdx	• Line 23 Example action name incorrectly describes the SendGrid usage as 'Query sendgrid'; the provider's _notify method is for sending emails, not querying data [Ref: method SendgridProvider._notify in sendgrid_provider.py]

Credits
Used: 1
Remaining: 99/100