Skip to content

Declare interval, disabled, and run_only_one in inputs.conf.spec#80

Merged
oschwald merged 1 commit into
mainfrom
wstorey/set-spec
Jun 23, 2026
Merged

Declare interval, disabled, and run_only_one in inputs.conf.spec#80
oschwald merged 1 commit into
mainfrom
wstorey/set-spec

Conversation

@horgh

@horgh horgh commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Add the interval, disabled, and run_only_one settings to the geoipupdate_input modular input spec so the input's supported parameters are documented. The dummy param1 is retained so the modular input type stays registered (Splunk silently ignores schemes with no custom parameter).

Summary by CodeRabbit

Documentation

  • Documented the interval, disabled, and run_only_one configuration parameters for the GeoIP update input, clarifying the supported settings and available configuration options.

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Three previously undocumented parameters—interval (integer), disabled (boolean), and run_only_one (boolean)—are added to the geoipupdate_input://default stanza in inputs.conf.spec. A corresponding 1.1.1 entry is added to CHANGELOG.md.

Changes

Spec and Changelog Update

Layer / File(s) Summary
inputs.conf.spec declarations and changelog entry
geoip/package/README/inputs.conf.spec, CHANGELOG.md
Adds interval, disabled, and run_only_one parameter definitions to the geoipupdate_input://default stanza, and records the addition under a new 1.1.1 section in the changelog.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 Hop hop, the spec is now complete,
Three fields were hiding, now they meet!
interval, disabled, run_only_one too,
All tucked in the README, shiny and new.
The changelog sings version one-one-one,
A tiny doc fix — perfectly done! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and specifically describes the main change: declaring three parameters (interval, disabled, run_only_one) in the inputs.conf.spec file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch wstorey/set-spec

Comment @coderabbitai help to get the list of available commands.

Add the interval, disabled, and run_only_one settings to the
geoipupdate_input modular input spec so the input's supported parameters
are documented. The dummy param1 is retained so the modular input type
stays registered (Splunk silently ignores schemes with no custom
parameter).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@horgh horgh force-pushed the wstorey/set-spec branch from 7176979 to 030d6e6 Compare June 22, 2026 22:47

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds the 'interval', 'disabled', and 'run_only_one' settings to 'inputs.conf.spec' and documents this change in the changelog. However, redefining these system-defined parameters in a custom spec file violates Splunk AppInspect guidelines and will cause validation failures. It is recommended to remove these declarations and update the changelog accordingly.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +3 to +5
interval = <integer>
disabled = <boolean>
run_only_one = <boolean>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

Redefining system-defined parameters like interval, disabled, and run_only_one in a custom inputs.conf.spec file is a violation of Splunk AppInspect guidelines. These parameters are already defined globally by Splunk's system-level configuration specs. Including them here will cause Splunk AppInspect to fail validation with errors regarding overriding system-defined properties.\n\nIt is recommended to remove these declarations from the spec file. If you need to document them, it is best to do so in the app's README or documentation rather than the .spec file.

Comment thread CHANGELOG.md
Comment on lines +3 to +8
## 1.1.1

* Declare the `interval`, `disabled`, and `run_only_one` settings in the
`geoipupdate_input` modular input's `inputs.conf.spec` so the input's
supported parameters are documented in the spec file.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

If the changes to inputs.conf.spec are reverted to avoid AppInspect failures, this changelog entry should also be removed or updated accordingly.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CHANGELOG.md`:
- Around line 3-8: The version 1.1.1 entry in the CHANGELOG.md file is missing a
release date or unreleased status indicator, while other versions like 1.1.0 and
1.0.0 include dates for consistency. Update the version 1.1.1 header to either
include a release date in the same format as other versions (e.g., "## 1.1.1 -
YYYY-MM-DD") if this version has been released, or add an unreleased indicator
(e.g., "## 1.1.1 (Unreleased)") if this is a planned release.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 197e3e7d-10f1-48dd-944d-141de112373e

📥 Commits

Reviewing files that changed from the base of the PR and between 40ce059 and 030d6e6.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • geoip/package/README/inputs.conf.spec

Comment thread CHANGELOG.md
Comment on lines +3 to +8
## 1.1.1

* Declare the `interval`, `disabled`, and `run_only_one` settings in the
`geoipupdate_input` modular input's `inputs.conf.spec` so the input's
supported parameters are documented in the spec file.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Add release date or mark version 1.1.1 as unreleased.

Version 1.1.1 lacks a release date, while versions 1.1.0 and 1.0.0 both include dates. For consistency, either add a date (if released) or add an "Unreleased" label (if this is a planned release).

📝 Suggested fixes

Option 1: If released, add date

-## 1.1.1
+## 1.1.1 (2026-06-YY)

Option 2: If unreleased, clarify status

-## 1.1.1
+## Unreleased (1.1.1)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## 1.1.1
* Declare the `interval`, `disabled`, and `run_only_one` settings in the
`geoipupdate_input` modular input's `inputs.conf.spec` so the input's
supported parameters are documented in the spec file.
## 1.1.1 (2026-06-YY)
* Declare the `interval`, `disabled`, and `run_only_one` settings in the
`geoipupdate_input` modular input's `inputs.conf.spec` so the input's
supported parameters are documented in the spec file.
Suggested change
## 1.1.1
* Declare the `interval`, `disabled`, and `run_only_one` settings in the
`geoipupdate_input` modular input's `inputs.conf.spec` so the input's
supported parameters are documented in the spec file.
## Unreleased (1.1.1)
* Declare the `interval`, `disabled`, and `run_only_one` settings in the
`geoipupdate_input` modular input's `inputs.conf.spec` so the input's
supported parameters are documented in the spec file.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CHANGELOG.md` around lines 3 - 8, The version 1.1.1 entry in the CHANGELOG.md
file is missing a release date or unreleased status indicator, while other
versions like 1.1.0 and 1.0.0 include dates for consistency. Update the version
1.1.1 header to either include a release date in the same format as other
versions (e.g., "## 1.1.1 - YYYY-MM-DD") if this version has been released, or
add an unreleased indicator (e.g., "## 1.1.1 (Unreleased)") if this is a planned
release.

@oschwald oschwald merged commit d3a55b3 into main Jun 23, 2026
10 checks passed
@oschwald oschwald deleted the wstorey/set-spec branch June 23, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants