...
| Code Block |
|---|
{
"errors" : [ {
"message" : "Error message",
"parameters" : [ {
"key" : "key-1",
"value" : "value-1"
}, ... ]
} ]
} |
Two parameters need An error needs to be added to the parameters errors field with parameter array containing:
- key: "overridableoverridableBlocks", value: boolean
UI needs to know whether it's even possible to complete the action by overriding the blocks (there may be other reasons that make it impossible). This value should only be true in case when the only reason for the action to fail is one or more overridable blocks. If there's a block that can't be overridden because the user doesn't have sufficient permissions or can't be overridden at all - the value should be false.key: "blocks", value: array of strings
A list of blocks that need to be overridden. This parameter may be omitted if overridable=false - the comma-separated string
A list of blocks that need to be overridden in order to complete this action. If this is the only error returned by the server and there are no other parameters, the client will know that it is possible to complete this action by overriding existing blocks. Existence of other kinds of errors tells the client that it doesn't make sense to override these blocks. - key: "missingOverridePermissions", value: comma-separated string (optional)
If there are overridableBlocks, server may also include a list of missing override permissions. The user won't be able to complete the action by overriding blocks anywaythis action, but he or she may want to request permission escalation (
) based on this information.Jira Legacy server System Jira serverId 01505d01-b853-3c2e-90f1-ee9b165564fc key UXPROD-2645
Expect a list of blocks that user wants to override
...
| Code Block |
|---|
"overrideBlocks": {
"description": "Blocks that need to be overridden",
"type": "array",
"items":{
"type": "string",
"enum": [
"patron-limitblock",
"item-limit-block",
"item-not-loanable-block"
]
}
} |
List of the appropriate blocks may be dependent on the endpoint.
...