feat: make configuration page as optional

[hetangmodi-crest]

Issue number:
ADDON-76819

PR Type

What kind of change does this PR introduce?

• Feature
• Bug Fix
• Refactoring (no functional or API changes)
• Documentation Update
• Maintenance (dependency updates, CI, etc.)

Summary

Set configuration as an optional key in globalConfig.json.

Changes

Made configuration page optional in schema.json, So that users can have an add-on UI without Configuration page.
Also added a smoke testcase which captures this behaviour.

User experience

Now, user can build their add-on without specifying configuration in their globalConfig.json. Users now can have a UI without Configuration page for their add-on.

Checklist

If an item doesn't apply to your changes, leave it unchecked.

• I have performed a self-review of this change according to the development guidelines
• Tests have been added/modified to cover the changes (testing doc)
• Changes are documented
• PR title and description follows the contributing principles

[soleksy-splunk]

seems good just one minor thing that configuration page is technically handled, so there isn't any entry point but if you directly type url it displays empty page. We can handle it in separate PR

[vtsvetkov-splunk]

what's weird we keep generated file in git

[hetangmodi-crest]

Yes, I agree. It is present in other expected add-ons as well. I think we can clean up all the files altogether in a separate PR.

[hetangmodi-crest]

@soleksy-splunk

seems good just one minor thing that configuration page is technically handled, so there isn't any entry point but if you directly type url it displays empty page. We can handle it in separate PR

I had checked it in my VM, when we add configuration in the URL, Splunk web presents Page Not Found error.

[soleksy-splunk]

@soleksy-splunk

seems good just one minor thing that configuration page is technically handled, so there isn't any entry point but if you directly type url it displays empty page. We can handle it in separate PR

I had checked it in my VM, when we add configuration in the URL, Splunk web presents Page Not Found error.

Ok, then it has to be caching on my side, i will double check but thats a minor problem as there shouldn't be any access point to this page anyway.

[vtsvetkov-splunk]

🚀

[artemrys]

If configuration, inputs and dashboard pages are optional - should we make pages optional as well?

So that we can support globalConfig file like this?

{
    "meta": {
        "name": "<name>",
        "version": "<version>",
        "displayName": "<display name>",
        "schemaVersion": "0.0.9"
    }
}

EDIT: if we decide so - it deserves a separate small PR.

[hetangmodi-crest]

If configuration, inputs and dashboard pages are optional - should we make pages optional as well?

So that we can support globalConfig file like this?

{
    "meta": {
        "name": "<name>",
        "version": "<version>",
        "displayName": "<display name>",
        "schemaVersion": "0.0.9"
    }
}

EDIT: if we decide so - it deserves a separate small PR.

Yes, we will be covering that in .conf only TA PR.

[kkedziak-splunk]

not (include_configuration) and default_view == "configuration"

This is a strange condition. It would be good to change _validate_meta_default_view method in global_config_validator.py to not allow this value when there is no configuration page and change this condition.

[sgoral-splunk]

I agree with Kamil. _validate_meta_default_view already checks, for input and dashboard, if default view is present in the global config and raises an error if not, so in my opinion it would be the best to expand it to configuration as well.

[hetangmodi-crest]

Have updated the logic and added validation in _validate_meta_default_view function

[sgoral-splunk]

I agree with Kamil. _validate_meta_default_view already checks, for input and dashboard, if default view is present in the global config and raises an error if not, so in my opinion it would be the best to expand it to configuration as well.