Invalid key in stanza : restmap.conf`

[darrenfuller]

Issue Short Description

Two invalid key in stanza errors on restmap.conf that contradict the documentation

Environment Information

VSCode Version:

• Version: 1.101.1 (user setup)
• Commit: 18e3a1ec544e6907be1e944a94c496e302073435
• Date: 2025-06-18T13:35:12.605Z
• Electron: 35.5.1
• ElectronBuildId: 11727614
• Chromium: 134.0.6998.205
• Node.js: 22.15.1
• V8: 13.4.114.21-electron.0
• OS: Windows_NT x64 10.0.26100

Splunk Extension Version:

• Identifier: splunk.splunk
• Version: 0.3.4
• Last Updated: 2025-06-10, 11:22:49

Issue Details

Seeing these two invalid key in stanza errors that are incorrect based on the documentation here: https://docs.splunk.com/Documentation/Splunk/9.4.2/Admin/restmapconf

1. handlertype = python in [admin_external:<identifier] stanzas

    Invalid key in stanza [admin_external:ta-invalid_key_in_stanza1] in restmap.conf, line 6: handlertype = python.
   

2. handlerpersistentmode = true|false in [script:] stanzas

    Invalid key in stanza [script:ta-invalid_key_in_stanza2] in restmap.conf, line 12: handlerpersistentmode = true.
   

Steps to reproduce

1. Have vscode with Splunk Extension installed

2. Create an app with the following files:

# default/app.conf
[install]
state = enabled

[package]
check_for_updates = false

[ui]
is_visible = false
is_manageable = false

# default/restmap.conf

[admin_external:ta-invalid_key_in_stanza1]
python.version = python3
handlerfile = ta_invalid_key_in_stanza1.py
handleractions = edit, list, remove, create
handlerpersistentmode = true
handlertype = python


[script:ta-invalid_key_in_stanza2]
handler = ta_invalid_key_in_stanza2
python.version = python3
handlerpersistentmode = true
scripttype = python

# metadata/local.meta
[]
access = read : [ * ], write : [ admin ]
export = system

Expected Outcome :

no syntax errors identified

Actual Outcome :

Line 6 and line 12 of restmap.conf showing invalid key in stanza errors

[darrenfuller]

These look to be issues with the .spec files for restmap.conf

If i update the restmap.conf.spec file to have these changes:

---

Change 1: Admin External

This is an issue in spec_files/9.0, spec_files/9.1 spec_files/9.2

from: (Note that handlertype definition is spaced to be part of the previous point and not on its own line)

[admin_external:<uniqueName>]
* 'admin_external'
* Register Python handlers for the Extensible Administration Interface (EAI).
* The handler is exposed via its "uniqueName".
* NOTE: Splunkd does not honor capability checks under this stanza.
  Define capability checks on endpoints under [admin:*] stanzas instead.
  handlertype = <string>
* The script type.
* Currently the only valid value is "python".

to : (added a line space and

[admin_external:<uniqueName>]
* 'admin_external'
* Register Python handlers for the Extensible Administration Interface (EAI).
* The handler is exposed via its "uniqueName".
* NOTE: Splunkd does not honor capability checks under this stanza.
  Define capability checks on endpoints under [admin:*] stanzas instead.

handlertype = <string>
* The script type.
* Currently the only valid value is "python".

---

Change 2: Script

adding the missing definition for handlerpersistentmode = into the script: section

handlerpersistentmode = <boolean>
* Set to "true" to run the script in persistent mode and
  keep the process running between requests.
* Only has effect if the 'scripttype' setting is set to "persist".
* Default: false