Protocol Documentation

Table of Contents

proto/cdn.proto

Top

ResourceParams

the resource to store into the cdn

FieldTypeLabelDescription
scriptBuffer string

buffer of the script.

domain string

the domain of the page [example.com].

cdnSourceStripped string

the cdn url stripped to insert into s3.

ScriptStatus

status message [TODO]

Cdn

CDN that is backed by S3. Default port starts on [50054].

Method NameRequest TypeResponse TypeDescription
AddScript .ResourceParams .ScriptStatus

proto/crawler.proto

Top

ScanReply

basic reply message.

FieldTypeLabelDescription
message string

message of the scan success.

ScanRequest

Request params for crawling generically.

FieldTypeLabelDescription
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 NameRequest TypeResponse TypeDescription
Scan ScanRequest ScanReply

Crawl ScanRequest ScanReply

proto/health.proto

Top

HealthCheckReply

the health status

FieldTypeLabelDescription
healthy bool

bool to indicate health or online.

HealthCheckRequest

empty request

HealthCheck

check if a service is good and healthy

Method NameRequest TypeResponse TypeDescription
check HealthCheckRequest HealthCheckReply

determine if server is alive.

proto/mav.proto

Top

Img

the image returned as a readable text

FieldTypeLabelDescription
className string

the name of the image.

probability float

the accuracy of the image being true.

ParseParams

params to use on image parsing.

FieldTypeLabelDescription
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 NameRequest TypeResponse TypeDescription
ParseImg .ParseParams .Img

proto/pagemind.proto

Top

Empty

send nothing ( used for background task ).

Headers

crawl page headers to set per request.

FieldTypeLabelDescription
key string

key of the header.

value string

value of the key.

IssueMeta

meta details for the page to include extra supportive features.

FieldTypeLabelDescription
skipContentIncluded bool

add a skip content button onto the script if not found.

Issues

the generic issues structure

FieldTypeLabelDescription
documentTitle string

document page title.

pageUrl string

the page url for the issue report.

issues Problem repeated

all of the issues that occured on the page.

domain string

the domain of the page.

IssuesInfo

info to use to gather all stats for the issues on the page.

FieldTypeLabelDescription
possibleIssuesFixedByCdn int32

possible issues that may be fixed using the cdn.

totalIssues int32

all of the page issues.

issuesFixedByCdn int32

how many issues that are fixed using the cdn.

errorCount int32

errors on the page.

warningCount int32

warnings on the page.

noticeCount int32

notices on the page that mainly used for info purposes.

adaScore int32

rough accessibility score.

issueMeta IssueMeta

extra data on the issue.

Page

page model of all helpful insight

FieldTypeLabelDescription
domain string

the domain for the request [example.com].

url string

the url of the request with http or https

cdnConnected bool

is the cdn for accessibility fixes connected on the page.

pageLoadTime PageLoadTime

page load time.

insight google.protobuf.Struct

the json details from lighthouse

issuesInfo IssuesInfo

issues on the page.

lastScanDate string

the last date of the scan.

PageLoadTime

how fast the page loaded.

FieldTypeLabelDescription
duration int64

duration in ms.

durationFormated string

durations formatted to a readable message.

color string

color indicator for the message.

Problem

the issue that occured, either of type error, notice, warning in desc order.

FieldTypeLabelDescription
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

FieldTypeLabelDescription
userId uint32

user identifier.

url string

the page url to run tests on.

pageHeaders Headers repeated

heads to include when running.

pageInsights bool

Run lighthouse reports.

noStore bool

Do not store to AWS script changes.

scriptsEnabled bool

Add js fix script.

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.

pageSpeedApiKey string

Google PageSpeed API key for request.

Script

javascript that runs to attempt to fix the page.

FieldTypeLabelDescription
pageUrl string

the page url that ran the request.

domain string

the domain of the page.

script string

the fix script body contents without <script></script>.

cdnUrlMinified string

the cdn url for accessibility fixes custom to the page minified.

cdnUrl string

the cdn url for accessibility fixes custom to the page.

cdnConnected bool

determine if accessibility cdn is connected.

issueMeta IssueMeta

extra info to determine stats on the issues.

scriptMeta ScriptMeta

meta information to help track script stats.

ScriptMeta

script meta adjustments

FieldTypeLabelDescription
skipContentEnabled bool

is skip content enabled for the page

ScriptParams

upsert script params

FieldTypeLabelDescription
editScript bool

should this edit the script?

url string

page url for the request.

script Script

pass in script object.

newScript string

new script to replace content?

Web

fields that build that Website that is treated as a Page.

FieldTypeLabelDescription
webPage Page

the website information or stats.

issues Issues

all of the issues that relate to the page.

script Script

the page script body contents without <script> tags.

userId uint32

the user that made the request.

Pagemind

Accessibility and page metrics [50052].

Method NameRequest TypeResponse TypeDescription
Scan .ScanParams .Web

SetScript .ScriptParams .Script

proto/website.proto

Top

Empty

send nothing mainly for triggering events.

ScanParams

params to send when scanning pages.

FieldTypeLabelDescription
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.

WebsiteService

Central API that manages your website between starting single and multi page scans. Default port starts on [50051].

Method NameRequest TypeResponse TypeDescription
ScanStart ScanParams Empty

ScanEnd ScanParams Empty

Scan ScanParams Empty

ScanStream ScanParams Empty stream

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
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)