Currently it looks like:
"config": { "OATHAuthWindowRadius": { "value": 4 }, "OATHAuthDatabase": { "value": false, "description": "Deprecated, configure the virtual-oathauth virtual domain instead." }, "OATHAuthAccountPrefix": { "value": false }, "OATHExclusiveRights": { "value": [] }, "OATHRequiredForGroups": { "value": [] }, "OATHAuthMultipleDevicesMigrationStage": { "value": 768 } },
Would be nice if we had these config variables documented inline.
| Subject | Repo | Branch | Lines +/- | |
|---|---|---|---|---|
| extension.json: Add config descriptions | mediawiki/extensions/OATHAuth | master | +9 -5 |
@Ayush_Anand3310: See the task title and https://www.mediawiki.org/wiki/New_Developers#Use_Phabricator_tasks_effectively :)
I apologize for not being attentive enough to the details in the issue and for asking a question that was not needed. I will carry out the required changes to the said file.
@Reedy I am thinking of using a key "description" whose value will hold the required documentation for different variables. What do you suggest?
"config": {
"OATHAuthWindowRadius": {
"value": 4,
"description":"Number of token windows on either side of current time to be considered valid for authentication.",
"descriptionmsg":"oathauth-config-oathauthwindowradius",
"public":true
},
"OATHAuthDatabase": {
"value": false,
"description":"database domain to be used for authentication in a multi-database environment",
"descriptionmsg":"oathauth-config-oathauthdatabase",
"public":true
},
"OATHAuthAccountPrefix": {
"value": false,
"description":"Prefix for OATH user account",
"descriptionmsg":"oathauth-config-oathauthaccountprefix",
"public":true
},
"OATHExclusiveRights": {
"value": [],
"description":"List of permissions that are revoked from users who do not use two-factor authentication",
"descriptionmsg":"oathauth-config-oathauthexclusiverights",
"public":true
},
"OATHRequiredForGroups": {
"value": [],
"description":"List of user groups that must use two-factor authentication.",
"descriptionmsg":"oathauth-config-oathrequiredforgroups",
"public":true
}
}Will this be alright?
Change 990337 had a related patch set uploaded (by Reedy; author: Reedy):
[mediawiki/extensions/OATHAuth@master] extension.json: Add config descriptions
Change 990337 merged by jenkins-bot:
[mediawiki/extensions/OATHAuth@master] extension.json: Add config descriptions