gRPC Protocol Documentation

Table of Contents

proto/cdn.proto

Top

ResourceParams

the resource to store into the cdn

FieldTypeLabelDescription
scriptBufferstring

buffer of the script.

domainstring

the domain of the page [example.com].

cdnSourceStrippedstring

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
AddScriptResourceParamsScriptStatus

proto/crawler.proto

Top

ScanReply

basic reply message.

FieldTypeLabelDescription
messagestring

message of the scan success.

ScanRequest

Request params for crawling generically.

FieldTypeLabelDescription
urlstring

the base request to start crawling/indexing pages.

iduint32

the user id or identifier to track crawl subs.

norobotsbool

ignore respect robots txt file rules.

agentstring

User agent to use when crawling.

subdomainsbool

allow subdomain crawling.

tldbool

allow tld crawling all . ext.

Crawler

The web indexer to find links async. Default port starts on [50055].

Method NameRequest TypeResponse TypeDescription
ScanScanRequestScanReply

CrawlScanRequestScanReply

proto/health.proto

Top

HealthCheckReply

the health status

FieldTypeLabelDescription
healthybool

bool to indicate health or online.

HealthCheckRequest

empty request

HealthCheck

check if a service is good and healthy

Method NameRequest TypeResponse TypeDescription
checkHealthCheckRequestHealthCheckReply

determine if server is alive.

proto/mav.proto

Top

Img

the image returned as a readable text

FieldTypeLabelDescription
classNamestring

the name of the image.

probabilityfloat

the accuracy of the image being true.

ParseParams

params to use on image parsing.

FieldTypeLabelDescription
imgstring

base64 string of the image.

widthint64

image approx width.

heightint64

image approx height.

urlstring

url of the image.

cvbool

perform with Computer Vision API.

Mav

Image finding service to determine descriptions. Default port starts on [50053].

Method NameRequest TypeResponse TypeDescription
ParseImgParseParamsImg

proto/pagemind.proto

Top

Headers

crawl page headers to set per request.

FieldTypeLabelDescription
keystring

key of the header.

valuestring

value of the key.

IssueMeta

meta details for the page to include extra supportive features.

FieldTypeLabelDescription
skipContentIncludedbool

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

Issues

the generic issues structure

FieldTypeLabelDescription
documentTitlestring

document page title.

pageUrlstring

the page url for the issue report.

issuesProblemrepeated

all of the issues that occurred on the page.

domainstring

the domain of the page.

IssuesInfo

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

FieldTypeLabelDescription
possibleIssuesFixedByCdnint32

possible issues that may be fixed using the cdn.

totalIssuesint32

all of the page issues.

issuesFixedByCdnint32

how many issues that are fixed using the cdn.

errorCountint32

errors on the page.

warningCountint32

warnings on the page.

noticeCountint32

notices on the page that mainly used for info purposes.

adaScoreint32

rough accessibility score.

issueMetaIssueMeta

extra data on the issue.

Page

page model of all helpful insight

FieldTypeLabelDescription
domainstring

the domain for the request [example.com].

urlstring

the url of the request with http or https

cdnConnectedbool

is the cdn for accessibility fixes connected on the page.

pageLoadTimePageLoadTime

page load time.

insightgoogle.protobuf.Struct

the json details from lighthouse

issuesInfoIssuesInfo

issues on the page.

lastScanDatestring

the last date of the scan.

PageLoadTime

how fast the page loaded.

FieldTypeLabelDescription
durationint32

duration in ms.

durationFormatedstring

durations formatted to a readable message.

colorstring

color indicator for the message.

Problem

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

FieldTypeLabelDescription
codestring

wcag error code.

typestring

warning, error, or notice.

typeCodeint32

error code.

messagestring

the issue with possible recommendations.

contextstring

the element of the issue.

selectorstring

the html selector.

runnerstring

the runner type for the scan.

recurrenceint32

how many times the issue appeared.

ScanParams

the params to configure testing and output

FieldTypeLabelDescription
userIduint32

user identifier.

urlstring

the page url to run tests on.

pageHeadersHeadersrepeated

heads to include when running.

pageInsightsbool

Run lighthouse reports.

noStorebool

Do not store to AWS script changes.

scriptsEnabledbool

Add js fix script.

mobilebool

Run as mobile view port.

actionsstringrepeated

List of actions to run on page.

uastring

User agent to use for request.

standardstring

The WCAG standard to use WCAG2A, WCAG2AA, or WCAG2AAA.

hideElementsstring

CSS selector to hide elements from testing, selectors can be comma separated.

cvbool

can perform with Computer Vision.

pageSpeedApiKeystring

Google PageSpeed API key for request.

Script

javascript that runs to attempt to fix the page.

FieldTypeLabelDescription
pageUrlstring

the page url that ran the request.

domainstring

the domain of the page.

scriptstring

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

cdnUrlMinifiedstring

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

cdnUrlstring

the cdn url for accessibility fixes custom to the page.

cdnConnectedbool

determine if accessibility cdn is connected.

issueMetaIssueMeta

extra info to determine stats on the issues.

scriptMetaScriptMeta

meta information to help track script stats.

ScriptMeta

script meta adjustments

FieldTypeLabelDescription
skipContentEnabledbool

is skip content enabled for the page

ScriptParams

upsert script params

FieldTypeLabelDescription
editScriptbool

should this edit the script?

urlstring

page url for the request.

scriptScript

pass in script object.

newScriptstring

new script to replace content?

Web

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

FieldTypeLabelDescription
webPagePage

the website information or stats.

issuesIssues

all of the issues that relate to the page.

scriptScript

the page script body contents without <script> tags.

userIduint32

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
pagesstringrepeated

list of pages returned.

domainstring

the url base of the crawl.

user_iduint32

user id performing scan.

fullbool

full crawl awaiting all links.

ScanStreamResponse

send streamed response

FieldTypeLabelDescription
messagestring

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 NameRequest TypeResponse TypeDescription
ScanStartScanParamsEmpty

ScanEndScanParamsEmpty

ScanScanParamsEmpty

ScanStreamScanParamsScanStreamResponse stream

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)

Pick the best Wave alternative

Start a free 7 day trial for A11yWatch now