@jrpool/kilotest 31.0.0 → 31.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/openapi.yaml +40 -33
- package/package.json +1 -1
package/openapi.yaml
CHANGED
|
@@ -4,9 +4,9 @@ info:
|
|
|
4
4
|
description: Kilotest tests web pages for accessibility, usability, and standard conformity using an ensemble of ten independent tools that employ rule-based and machine-learning-based methods. This API enables AI agents to recommend web pages for testing, discover available test reports, and retrieve data from reports. For background on Kilotest and the advantages of ensemble testing, visit https://kilotest.com.
|
|
5
5
|
version: 1.0.0
|
|
6
6
|
contact:
|
|
7
|
+
name: Kilotest
|
|
7
8
|
url: https://kilotest.com
|
|
8
9
|
email: info@kilotest.com
|
|
9
|
-
repository: https://github.com/jrpool/kilotest
|
|
10
10
|
|
|
11
11
|
servers:
|
|
12
12
|
- url: https://kilotest.com
|
|
@@ -59,14 +59,16 @@ paths:
|
|
|
59
59
|
schema:
|
|
60
60
|
type: string
|
|
61
61
|
pattern: '^\d{6}T\d{4}$'
|
|
62
|
-
|
|
62
|
+
examples:
|
|
63
|
+
- 260503T0432
|
|
63
64
|
- name: jobID
|
|
64
65
|
in: path
|
|
65
66
|
required: true
|
|
66
67
|
description: Job identifier component of the report identifier (e.g., xx0).
|
|
67
68
|
schema:
|
|
68
69
|
type: string
|
|
69
|
-
|
|
70
|
+
examples:
|
|
71
|
+
- xx0
|
|
70
72
|
responses:
|
|
71
73
|
'200':
|
|
72
74
|
description: Data on issues from the specified report
|
|
@@ -89,7 +91,8 @@ paths:
|
|
|
89
91
|
description: Issue identifier (e.g., imageNoText). Available under "issues reported" > priority level > "identifier" in the getReportIssues response.
|
|
90
92
|
schema:
|
|
91
93
|
type: string
|
|
92
|
-
|
|
94
|
+
examples:
|
|
95
|
+
- imageNoText
|
|
93
96
|
- name: timeStamp
|
|
94
97
|
in: path
|
|
95
98
|
required: true
|
|
@@ -121,7 +124,8 @@ components:
|
|
|
121
124
|
description: Natural-language description of this response and of Kilotest. Provides context for an agent encountering Kilotest for the first time.
|
|
122
125
|
tool name:
|
|
123
126
|
type: string
|
|
124
|
-
|
|
127
|
+
examples:
|
|
128
|
+
- Kilotest
|
|
125
129
|
request:
|
|
126
130
|
type: object
|
|
127
131
|
properties:
|
|
@@ -148,17 +152,19 @@ components:
|
|
|
148
152
|
'equivalent URL for humans':
|
|
149
153
|
type: string
|
|
150
154
|
closest ancestor request:
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
type: string
|
|
155
|
-
URLs:
|
|
156
|
-
type: object
|
|
155
|
+
oneOf:
|
|
156
|
+
- type: 'null'
|
|
157
|
+
- type: object
|
|
157
158
|
properties:
|
|
158
|
-
|
|
159
|
-
type: string
|
|
160
|
-
'for humans':
|
|
159
|
+
description:
|
|
161
160
|
type: string
|
|
161
|
+
URLs:
|
|
162
|
+
type: object
|
|
163
|
+
properties:
|
|
164
|
+
'for you':
|
|
165
|
+
type: string
|
|
166
|
+
'for humans':
|
|
167
|
+
type: string
|
|
162
168
|
response metadata:
|
|
163
169
|
type: object
|
|
164
170
|
properties:
|
|
@@ -183,15 +189,7 @@ components:
|
|
|
183
189
|
description: Reason for testing the page.
|
|
184
190
|
|
|
185
191
|
TestRecFormResponse:
|
|
186
|
-
|
|
187
|
-
- $ref: '#/components/schemas/CommonResponseFields'
|
|
188
|
-
- type: object
|
|
189
|
-
properties:
|
|
190
|
-
available reports:
|
|
191
|
-
type: array
|
|
192
|
-
description: One entry per available Kilotest report, in alphabetical order by page description and, in case of multiple reports per page, in order of creation date and time. Reports are matched by page description, not page URL, so, if only the URL of a page has changed between reports, the reports are treated as reports about the same page.
|
|
193
|
-
items:
|
|
194
|
-
$ref: '#/components/schemas/TargetsItem'
|
|
192
|
+
$ref: '#/components/schemas/CommonResponseFields'
|
|
195
193
|
|
|
196
194
|
ToolInfo:
|
|
197
195
|
type: object
|
|
@@ -200,15 +198,18 @@ components:
|
|
|
200
198
|
identifier:
|
|
201
199
|
type: string
|
|
202
200
|
description: Short programmatic identifier for the tool.
|
|
203
|
-
|
|
201
|
+
examples:
|
|
202
|
+
- alfa
|
|
204
203
|
name:
|
|
205
204
|
type: string
|
|
206
205
|
description: Display name of the tool.
|
|
207
|
-
|
|
206
|
+
examples:
|
|
207
|
+
- Alfa
|
|
208
208
|
sponsor:
|
|
209
209
|
type: string
|
|
210
210
|
description: Organization that created, initially sponsored, or now sponsors the tool.
|
|
211
|
-
|
|
211
|
+
examples:
|
|
212
|
+
- Siteimprove
|
|
212
213
|
|
|
213
214
|
ToolFailure:
|
|
214
215
|
type: object
|
|
@@ -216,10 +217,12 @@ components:
|
|
|
216
217
|
properties:
|
|
217
218
|
name:
|
|
218
219
|
type: string
|
|
219
|
-
|
|
220
|
+
examples:
|
|
221
|
+
- WAVE
|
|
220
222
|
reason for failure:
|
|
221
223
|
type: string
|
|
222
|
-
|
|
224
|
+
examples:
|
|
225
|
+
- Not enough credits.
|
|
223
226
|
|
|
224
227
|
ToolsSummary:
|
|
225
228
|
type: object
|
|
@@ -245,13 +248,14 @@ components:
|
|
|
245
248
|
format: uri
|
|
246
249
|
description: URL for a human to view the next tier of detail.
|
|
247
250
|
|
|
248
|
-
|
|
251
|
+
TargetsItem:
|
|
249
252
|
type: object
|
|
250
253
|
description: Summary data about a single available report.
|
|
251
254
|
properties:
|
|
252
255
|
identifier:
|
|
253
256
|
type: string
|
|
254
|
-
|
|
257
|
+
examples:
|
|
258
|
+
- 260504T1659-029
|
|
255
259
|
creation date:
|
|
256
260
|
type: string
|
|
257
261
|
format: date-time
|
|
@@ -301,11 +305,13 @@ components:
|
|
|
301
305
|
properties:
|
|
302
306
|
identifier:
|
|
303
307
|
type: string
|
|
304
|
-
|
|
308
|
+
examples:
|
|
309
|
+
- imageNoText
|
|
305
310
|
summary:
|
|
306
311
|
type: string
|
|
307
312
|
description: Brief natural-language label for the issue.
|
|
308
|
-
|
|
313
|
+
examples:
|
|
314
|
+
- image not named
|
|
309
315
|
related WCAG 2.2 standard:
|
|
310
316
|
type: object
|
|
311
317
|
description: The WCAG 2.2 success criterion or guideline most closely related to this issue.
|
|
@@ -318,7 +324,8 @@ components:
|
|
|
318
324
|
'numeric identifier':
|
|
319
325
|
type: string
|
|
320
326
|
pattern: '^\d\.\d(\.\d+)?$'
|
|
321
|
-
|
|
327
|
+
examples:
|
|
328
|
+
- 1.1.1
|
|
322
329
|
impact on a user:
|
|
323
330
|
type: string
|
|
324
331
|
description: How this issue is likely to affect users.
|