@jrpool/kilotest 31.0.0 → 31.1.0

package/openapi.yaml

@@ -4,9 +4,9 @@ info:
   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.
   version: 1.0.0
   contact:
+    name: Kilotest
     url: https://kilotest.com
     email: info@kilotest.com
-    repository: https://github.com/jrpool/kilotest
 
 servers:
   - url: https://kilotest.com
@@ -15,7 +15,7 @@ servers:
 paths:
   /api/testRecForm:
     post:
-      operationId: testRecForm
+      operationId: submitWebAccessibilityTestRequest
       summary: Receives a testing recommendation
       description: Receives a recommendation for Kilotest to test a particular web page.
       requestBody:
@@ -35,7 +35,7 @@ paths:
 
   /api/targets:
     get:
-      operationId: targets
+      operationId: summarizeAccessibilityOfAllTestedWebPages
       summary: Summarizes all available reports
       description: Returns summary data about every non-hidden report available from Kilotest, including the name and URL of the tested web page, when the testing was performed, how many issues were reported, and URLs for retrieving more detailed data from the report.
       responses:
@@ -48,7 +48,7 @@ paths:
 
   /api/reportIssues/{timeStamp}/{jobID}:
     get:
-      operationId: getReportIssues
+      operationId: listAccessibilityIssuesOnOneWebPage
       summary: Gets data on issues from a specific report
       description: Returns data about the issues reported in a specific Kilotest report, grouped by priority. The data on each issue include the tools that reported it, the number of HTML elements exhibiting it, and URLs for retrieving element-level detail. The timeStamp and jobID components identify the report and are available in the targets response.
       parameters:
@@ -59,14 +59,16 @@ paths:
           schema:
             type: string
             pattern: '^\d{6}T\d{4}$'
-            example: '260503T0432'
+            examples:
+              - 260503T0432
         - name: jobID
           in: path
           required: true
           description: Job identifier component of the report identifier (e.g., xx0).
           schema:
             type: string
-            example: 'xx0'
+            examples:
+              - xx0
       responses:
         '200':
           description: Data on issues from the specified report
@@ -79,7 +81,7 @@ paths:
 
   /api/reportIssue/{issueID}/{timeStamp}/{jobID}:
     get:
-      operationId: getReportIssue
+      operationId: listHTMLElementsHavingOneAccessibilityIssue
       summary: Gets details about a specific issue in a specific report (NOT YET IMPLEMENTED)
       description: Returns details about a single issue within a specific report, including which HTML elements exhibit the issue and, for each such element, URLs for retrieving tool-by-tool diagnoses of the issue on the element. NOT YET IMPLEMENTED.
       parameters:
@@ -89,7 +91,8 @@ paths:
           description: Issue identifier (e.g., imageNoText). Available under "issues reported" > priority level > "identifier" in the getReportIssues response.
           schema:
             type: string
-            example: 'imageNoText'
+            examples:
+              - imageNoText
         - name: timeStamp
           in: path
           required: true
@@ -121,7 +124,8 @@ components:
           description: Natural-language description of this response and of Kilotest. Provides context for an agent encountering Kilotest for the first time.
         tool name:
           type: string
-          example: Kilotest
+          examples:
+            - Kilotest
         request:
           type: object
           properties:
@@ -148,17 +152,19 @@ components:
                 'equivalent URL for humans':
                   type: string
             closest ancestor request:
-              type: [object, 'null']
-              properties:
-                description:
-                  type: string
-                URLs:
-                  type: object
+              oneOf:
+                - type: 'null'
+                - type: object
                   properties:
-                    'for you':
-                      type: string
-                    'for humans':
+                    description:
                       type: string
+                    URLs:
+                      type: object
+                      properties:
+                        'for you':
+                          type: string
+                        'for humans':
+                          type: string
         response metadata:
           type: object
           properties:
@@ -183,15 +189,7 @@ components:
           description: Reason for testing the page.
 
     TestRecFormResponse:
-      allOf:
-        - $ref: '#/components/schemas/CommonResponseFields'
-        - type: object
-          properties:
-            available reports:
-              type: array
-              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.
-              items:
-                $ref: '#/components/schemas/TargetsItem'
+      $ref: '#/components/schemas/CommonResponseFields'
 
     ToolInfo:
       type: object
@@ -200,15 +198,18 @@ components:
         identifier:
           type: string
           description: Short programmatic identifier for the tool.
-          example: alfa
+          examples:
+            - alfa
         name:
           type: string
           description: Display name of the tool.
-          example: Alfa
+          examples:
+            - Alfa
         sponsor:
           type: string
           description: Organization that created, initially sponsored, or now sponsors the tool.
-          example: Siteimprove
+          examples:
+            - Siteimprove
 
     ToolFailure:
       type: object
@@ -216,10 +217,12 @@ components:
       properties:
         name:
           type: string
-          example: WAVE
+          examples:
+            - WAVE
         reason for failure:
           type: string
-          example: Not enough credits.
+          examples:
+            - Not enough credits.
 
     ToolsSummary:
       type: object
@@ -245,13 +248,14 @@ components:
           format: uri
           description: URL for a human to view the next tier of detail.
 
-    targetsItem:
+    TargetsItem:
       type: object
       description: Summary data about a single available report.
       properties:
         identifier:
           type: string
-          example: 260504T1659-029
+          examples:
+            - 260504T1659-029
         creation date:
           type: string
           format: date-time
@@ -301,11 +305,13 @@ components:
       properties:
         identifier:
           type: string
-          example: imageNoText
+          examples:
+            - imageNoText
         summary:
           type: string
           description: Brief natural-language label for the issue.
-          example: image not named
+          examples:
+            - image not named
         related WCAG 2.2 standard:
           type: object
           description: The WCAG 2.2 success criterion or guideline most closely related to this issue.
@@ -318,7 +324,8 @@ components:
             'numeric identifier':
               type: string
               pattern: '^\d\.\d(\.\d+)?$'
-              example: '1.1.1'
+              examples:
+                - 1.1.1
         impact on a user:
           type: string
           description: How this issue is likely to affect users.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrpool/kilotest",
-  "version": "31.0.0",
+  "version": "31.1.0",
   "description": "An ensemble testing service with a focus on accessibility",
   "main": "index.js",
   "scripts": {