Skip to content

tools.ozone.setting.upsertOption

Lexicon Version: 1

Type: procedure

Create or update setting option

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
keystringFormat: nsid
scopestringKnown Values: instance, personal
valueunknown
descriptionstringMax Length: 2000
managerRolestringKnown Values: tools.ozone.team.defs#roleModerator, tools.ozone.team.defs#roleTriage, tools.ozone.team.defs#roleVerifier, tools.ozone.team.defs#roleAdmin
Output:
  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
optiontools.ozone.setting.defs#option

{
"lexicon": 1,
"id": "tools.ozone.setting.upsertOption",
"defs": {
"main": {
"type": "procedure",
"description": "Create or update setting option",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"key",
"scope",
"value"
],
"properties": {
"key": {
"type": "string",
"format": "nsid"
},
"scope": {
"type": "string",
"knownValues": [
"instance",
"personal"
]
},
"value": {
"type": "unknown"
},
"description": {
"type": "string",
"maxLength": 2000
},
"managerRole": {
"type": "string",
"knownValues": [
"tools.ozone.team.defs#roleModerator",
"tools.ozone.team.defs#roleTriage",
"tools.ozone.team.defs#roleVerifier",
"tools.ozone.team.defs#roleAdmin"
]
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"option"
],
"properties": {
"option": {
"type": "ref",
"ref": "tools.ozone.setting.defs#option"
}
}
}
}
}
}
}