BUG: globalConfig does not allow "placeholder" property for Basic/OAuth fields

[iqno]

Description

When adding OAuth functionality via. globalConfig, the "placeholder" property of basic/oauth fields is now allowed.

Currently the documentation states:

Fields allowed in basic and oauth fields as of now:

oauth_field: This should be kept as it is and without any change.
label: This can be changed if the user wants to change the label of the field in UI.
field: For now this user must keep it as it is for mandatory fields as mentioned above.
help : This can be changed if user wants to change the help text displayed below field.
encrypted : This should be true if user wants that particular field encrypted else no need to have this parameter.

placeholder: The placeholder for the field.

required: To specify whether the field is required or not. The default value is true.

However, when building an app with the ucc-gen build --ta-version=1.0.0 command, I am met with the following error message:

 ~/appname/ $ ucc-gen build --ta-version=1.0.0

INFO: ucc-gen version 5.28.4 is used
INFO: Python binary name to use: python3
INFO: Output folder is /Users/username/appname/output
INFO: Add-on will be built with version '1.0.0'
INFO: Cleaned out directory /Users/username/appname/output
INFO: Using globalConfig file located @ /Users/username/appname/globalConfig.json
ERROR: globalConfig file is not valid. Error: Additional properties are not allowed ('placeholder' was unexpected)

What ucc-gen version are you using?

5.28.4

Additional System Info

Python==3.11.2, OS=Mac OS Ventura

[tbalar-splunk]

Thank you for reporting this issue. We will prioritise this task and update the codebase.

[tbalar-splunk]

Started working on this issue - https://splunk.atlassian.net/browse/ADDON-64957

[tbalar-splunk]

We have determined that the issue lies not within the code itself but rather in the incorrect documentation for the usage of placeholders in the OAuth feature of ucc-gen. We are currently in the process of revising the ucc documentation to rectify this.

Below is a snippet demonstrating how to utilize placeholder in the global config file:

{
    "oauth_field": "username",
    "label": "Label",
    "encrypted": false,
    "help": "help text",
    "field": "field_name",
    "options": {
        "placeholder": "Required"
    }
}

[tbalar-splunk]

Also, The Placeholder attribute is deprecated and will be removed in the next major version. Instead, we recommend to use "help" attribute.

#831