/
requested_action.schema.json
183 lines (183 loc) · 6.53 KB
/
requested_action.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "check_run$requested_action",
"type": "object",
"required": [
"action",
"check_run",
"requested_action",
"repository",
"sender"
],
"properties": {
"action": { "type": "string", "enum": ["requested_action"] },
"check_run": {
"type": "object",
"description": "The [check_run](https://docs.github.com/en/rest/reference/checks#get-a-check-run).",
"required": [
"id",
"head_sha",
"external_id",
"url",
"html_url",
"status",
"conclusion",
"started_at",
"completed_at",
"output",
"name",
"check_suite",
"app",
"pull_requests"
],
"properties": {
"id": { "type": "integer", "description": "The id of the check." },
"node_id": { "type": "string" },
"head_sha": {
"type": "string",
"description": "The SHA of the commit that is being checked."
},
"external_id": { "type": "string" },
"url": { "type": "string", "format": "uri" },
"html_url": { "type": "string", "format": "uri" },
"details_url": { "type": "string", "format": "uri" },
"status": {
"type": "string",
"enum": ["queued", "in_progress", "completed"],
"description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`."
},
"conclusion": {
"type": ["string", "null"],
"enum": [
"success",
"failure",
"neutral",
"cancelled",
"timed_out",
"action_required",
"stale",
"skipped",
null
],
"description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed."
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
},
"completed_at": {
"oneOf": [
{ "type": "string", "format": "date-time" },
{ "type": "null" }
],
"description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
},
"output": {
"type": "object",
"required": [
"summary",
"text",
"annotations_count",
"annotations_url"
],
"properties": {
"title": { "type": ["string", "null"] },
"summary": { "type": ["string", "null"] },
"text": { "type": ["string", "null"] },
"annotations_count": { "type": "integer" },
"annotations_url": { "type": "string", "format": "uri" }
},
"additionalProperties": false
},
"name": {
"type": "string",
"description": "The name of the check run."
},
"check_suite": {
"type": "object",
"required": [
"id",
"head_branch",
"head_sha",
"status",
"conclusion",
"url",
"before",
"after",
"pull_requests",
"app",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "integer",
"description": "The id of the check suite that this check run is part of."
},
"node_id": { "type": "string" },
"head_branch": { "type": ["string", "null"] },
"head_sha": {
"type": "string",
"description": "The SHA of the head commit that is being checked."
},
"status": {
"type": "string",
"enum": ["queued", "in_progress", "completed", "waiting"]
},
"conclusion": {
"type": ["string", "null"],
"enum": [
"success",
"failure",
"neutral",
"cancelled",
"timed_out",
"action_required",
"stale",
null
]
},
"url": { "type": "string", "format": "uri" },
"before": { "type": ["string", "null"] },
"after": { "type": ["string", "null"] },
"pull_requests": {
"type": "array",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`. \n \n**Note:**\n\n* The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.\n* When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.",
"items": { "$ref": "common/check-run-pull-request.schema.json" }
},
"deployment": { "$ref": "common/check-run-deployment.schema.json" },
"app": { "$ref": "common/app.schema.json" },
"created_at": { "type": "string", "format": "date-time" },
"updated_at": { "type": "string", "format": "date-time" }
},
"additionalProperties": false
},
"app": { "$ref": "common/app.schema.json" },
"pull_requests": {
"type": "array",
"items": { "$ref": "common/check-run-pull-request.schema.json" }
},
"deployment": { "$ref": "common/check-run-deployment.schema.json" }
},
"additionalProperties": false
},
"requested_action": {
"type": "object",
"description": "The action requested by the user.",
"properties": {
"identifier": {
"type": "string",
"description": "The integrator reference of the action requested by the user."
}
},
"additionalProperties": false
},
"repository": { "$ref": "common/repository.schema.json" },
"sender": { "$ref": "common/user.schema.json" },
"installation": { "$ref": "common/installation-lite.schema.json" },
"organization": { "$ref": "common/organization.schema.json" }
},
"additionalProperties": false,
"title": "check_run requested_action event"
}