|
1 | 1 | { |
2 | | - "desc": "list the permissions for using each trigger type", |
| 2 | + "desc": "List the permissions for using each trigger type.", |
3 | 3 | "http_method": "POST", |
4 | 4 | "scope": { |
5 | 5 | "user": [ |
|
25 | 25 | "type": "array", |
26 | 26 | "minItems": 1, |
27 | 27 | "maxItems": 1000, |
28 | | - "desc": "The trigger types IDs for which to get the permissions", |
| 28 | + "desc": "The trigger type IDs for which to get the permissions.", |
29 | 29 | "example": "['FTT01', 'FTT02', 'FTT03']", |
30 | 30 | "items": { |
31 | 31 | "schema": "function_trigger_type_id" |
|
40 | 40 | "metadata" |
41 | 41 | ], |
42 | 42 | "properties": { |
| 43 | + "permissions": { |
| 44 | + "type": "object", |
| 45 | + "patternProperties": { |
| 46 | + "^Ftt[A-Z0-9]{4,}$": { |
| 47 | + "type": "object", |
| 48 | + "additionalProperties": false, |
| 49 | + "properties": { |
| 50 | + "permission": { |
| 51 | + "type": "string", |
| 52 | + "enum": [ |
| 53 | + "everyone", |
| 54 | + "named_entities", |
| 55 | + "no_one" |
| 56 | + ] |
| 57 | + }, |
| 58 | + "user_ids": { |
| 59 | + "type": "array", |
| 60 | + "desc": "List of user IDs to allow for `named_entities` visibility.", |
| 61 | + "example": "['U00000001', 'U00000002', 'U00000003']", |
| 62 | + "items": { |
| 63 | + "schema": "user_id" |
| 64 | + } |
| 65 | + }, |
| 66 | + "team_ids": { |
| 67 | + "type": "array", |
| 68 | + "desc": "List of team IDs to allow for `named_entities` visibility.", |
| 69 | + "example": "['T00000001', 'T00000002', 'T00000003']", |
| 70 | + "items": { |
| 71 | + "schema": "workspace_id" |
| 72 | + } |
| 73 | + }, |
| 74 | + "org_ids": { |
| 75 | + "type": "array", |
| 76 | + "desc": "List of org IDs to allow for `named_entities` visibility.", |
| 77 | + "example": "['E00000001', 'E00000002', 'E00000003']", |
| 78 | + "items": { |
| 79 | + "schema": "enterprise_id" |
| 80 | + } |
| 81 | + }, |
| 82 | + "permissions": { |
| 83 | + "type": "object", |
| 84 | + "desc": "Object of permissions for the trigger type keyed by permission type.", |
| 85 | + "patternProperties": { |
| 86 | + "trigger_type|private_channel_access|private_channel_message_access": { |
| 87 | + "type": "object", |
| 88 | + "required": [ |
| 89 | + "permission" |
| 90 | + ], |
| 91 | + "additionalProperties": false, |
| 92 | + "properties": { |
| 93 | + "permission": { |
| 94 | + "type": "string", |
| 95 | + "enum": [ |
| 96 | + "everyone", |
| 97 | + "named_entities", |
| 98 | + "no_one" |
| 99 | + ] |
| 100 | + }, |
| 101 | + "user_ids": { |
| 102 | + "type": "array", |
| 103 | + "desc": "List of user IDs to allow for named_entities visibility", |
| 104 | + "example": "['U00000001', 'U00000002', 'U00000003']", |
| 105 | + "items": { |
| 106 | + "schema": "user_id" |
| 107 | + } |
| 108 | + }, |
| 109 | + "team_ids": { |
| 110 | + "type": "array", |
| 111 | + "desc": "List of team IDs to allow for named_entities visibility", |
| 112 | + "example": "['T00000001', 'T00000002', 'T00000003']", |
| 113 | + "items": { |
| 114 | + "schema": "workspace_id" |
| 115 | + } |
| 116 | + }, |
| 117 | + "org_ids": { |
| 118 | + "type": "array", |
| 119 | + "desc": "List of org IDs to allow for named_entities visibility", |
| 120 | + "example": "['E00000001', 'E00000002', 'E00000003']", |
| 121 | + "items": { |
| 122 | + "schema": "enterprise_id" |
| 123 | + } |
| 124 | + } |
| 125 | + } |
| 126 | + } |
| 127 | + } |
| 128 | + } |
| 129 | + } |
| 130 | + } |
| 131 | + } |
| 132 | + }, |
43 | 133 | "metadata": { |
44 | 134 | "type": "object", |
45 | 135 | "patternProperties": { |
|
50 | 140 | "workflows_using", |
51 | 141 | "available_in_workflow_builder" |
52 | 142 | ], |
| 143 | + "additionalProperties": false, |
53 | 144 | "properties": { |
54 | 145 | "date_released": { |
55 | 146 | "type": "integer", |
56 | | - "desc": "the date this trigger type was released" |
| 147 | + "desc": "The date this trigger type was released." |
57 | 148 | }, |
58 | 149 | "workflows_using": { |
59 | 150 | "type": "integer", |
60 | | - "desc": "the number of workflows with a trigger of this type" |
| 151 | + "desc": "The number of workflows with a trigger of this type." |
61 | 152 | }, |
62 | 153 | "available_in_workflow_builder": { |
63 | 154 | "type": "boolean", |
64 | | - "desc": "Is the trigger available for use in workflow builder" |
| 155 | + "desc": "Whether the trigger available for use in Workflow Builder." |
65 | 156 | } |
66 | 157 | } |
67 | 158 | } |
|
0 commit comments