gRPC Protocol Documentation
Table of Contents
proto/crawler.proto
TopScanReply
basic reply message.
| Field | Type | Label | Description |
| message | string | message of the scan success. |
ScanRequest
Request params for crawling generically.
| Field | Type | Label | Description |
| url | string | the base request to start crawling/indexing pages. | |
| id | uint32 | the user id or identifier to track crawl subs. | |
| norobots | bool | ignore respect robots txt file rules. | |
| agent | string | User agent to use when crawling. | |
| subdomains | bool | allow subdomain crawling. | |
| tld | bool | allow tld crawling all . ext. |
Crawler
The web indexer to find links async. Default port starts on [50055].
| Method Name | Request Type | Response Type | Description |
| Scan | ScanRequest | ScanReply | |
| Crawl | ScanRequest | ScanReply |
proto/health.proto
TopHealthCheckReply
the health status
| Field | Type | Label | Description |
| healthy | bool | bool to indicate health or online. |
HealthCheckRequest
empty request
HealthCheck
check if a service is good and healthy
| Method Name | Request Type | Response Type | Description |
| check | HealthCheckRequest | HealthCheckReply | determine if server is alive. |
proto/mav.proto
TopImg
the image returned as a readable text
| Field | Type | Label | Description |
| className | string | the name of the image. | |
| probability | float | the accuracy of the image being true. |
ParseParams
params to use on image parsing.
| Field | Type | Label | Description |
| img | string | base64 string of the image. | |
| width | int64 | image approx width. | |
| height | int64 | image approx height. | |
| url | string | url of the image. | |
| cv | bool | perform with Computer Vision API. |
Mav
Image finding service to determine descriptions. Default port starts on [50053].
| Method Name | Request Type | Response Type | Description |
| ParseImg | ParseParams | Img |
proto/pagemind.proto
TopHeaders
crawl page headers to set per request.
| Field | Type | Label | Description |
| key | string | key of the header. | |
| value | string | value of the key. |
IssueMeta
meta details for the page to include extra supportive features.
| Field | Type | Label | Description |
| skipContentIncluded | bool | add a skip content button onto the script if not found. |
Issues
the generic issues structure
| Field | Type | Label | Description |
| documentTitle | string | document page title. | |
| pageUrl | string | the page url for the issue report. | |
| issues | Problem | repeated | all of the issues that occurred on the page. |
| domain | string | the domain of the page. |
IssuesInfo
info to use to gather all stats for the issues on the page.
| Field | Type | Label | Description |
| totalIssues | int32 | all of the page issues. | |
| errorCount | int32 | errors on the page. | |
| warningCount | int32 | warnings on the page. | |
| noticeCount | int32 | notices on the page that mainly used for info purposes. | |
| accessScore | int32 | rough accessibility score. | |
| issueMeta | IssueMeta | extra data on the issue. |
Page
page model of all helpful insight
| Field | Type | Label | Description |
| domain | string | the domain for the request [example.com]. | |
| url | string | the url of the request with http or https | |
| pageLoadTime | PageLoadTime | page load time. | |
| issuesInfo | IssuesInfo | issues on the page. | |
| lastScanDate | string | the last date of the scan. |
PageLoadTime
how fast the page loaded.
| Field | Type | Label | Description |
| duration | int32 | duration in ms. | |
| color | string | color indicator for the message. |
Problem
the issue that occurred, either of type error, notice, warning in desc order.
| Field | Type | Label | Description |
| code | string | wcag error code. | |
| type | string | warning, error, or notice. | |
| typeCode | int32 | error code. | |
| message | string | the issue with possible recommendations. | |
| context | string | the element of the issue. | |
| selector | string | the html selector. | |
| runner | string | the runner type for the scan. | |
| recurrence | int32 | how many times the issue appeared. |
ScanParams
the params to configure testing and output
| Field | Type | Label | Description |
| userId | uint32 | user identifier. | |
| url | string | the page url to run tests on. | |
| pageHeaders | Headers | repeated | heads to include when running. |
| noStore | bool | Do not store to AWS script changes. | |
| mobile | bool | Run as mobile view port. | |
| actions | string | repeated | List of actions to run on page. |
| ua | string | User agent to use for request. | |
| standard | string | The WCAG standard to use WCAG2A, WCAG2AA, or WCAG2AAA. | |
| hideElements | string | CSS selector to hide elements from testing, selectors can be comma separated. | |
| cv | bool | can perform with Computer Vision. |
Web
fields that build that Website that is treated as a Page.
| Field | Type | Label | Description |
| webPage | Page | the website information or stats. | |
| issues | Issues | all of the issues that relate to the page. | |
| userId | uint32 | the user that made the request. |
Pagemind
Accessibility and page metrics [50052].
| Method Name | Request Type | Response Type | Description |
| Scan | .ScanParams | .Web |
proto/website.proto
TopEmpty
send nothing mainly for triggering events.
ScanParams
params to send when scanning pages.
| Field | Type | Label | Description |
| pages | string | repeated | list of pages returned. |
| domain | string | the url base of the crawl. | |
| user_id | uint32 | user id performing scan. | |
| full | bool | full crawl awaiting all links. |
ScanStreamResponse
send streamed response
| Field | Type | Label | Description |
| message | string | message of the scan success or if should terminate. |
WebsiteService
Central API that manages your website between starting single and multi page scans. Default port starts on [50051].
| Method Name | Request Type | Response Type | Description |
| ScanStart | ScanParams | Empty | |
| ScanEnd | ScanParams | Empty | |
| Scan | ScanParams | Empty | |
| ScanStream | ScanParams | ScanStreamResponse stream |
Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
Restez inclusif en toute confiance
Commencez dès maintenant avec A11yWatch pour des outils d'accessibilité web automatisés abordables et rapides.