Skip to navigation

Lint a procedure

View as Markdown

Compiles a procedure with its tools and gives the diagnostics. Saves nothing and costs nothing. A procedure with errors also answers 200, with ok: false. Needs the scope machines.

Authentication

AuthorizationBearer

An API key (crk_), an exchanged token (crt_) or a JWT of a trusted issuer. The credential needs the scope of the capability. Read the description of each route.

Request

This endpoint expects an object.
proceduremap from strings to anyRequired

Only with include=procedure.

toolslist of objects or objectRequired

The tools of the procedure: a list, or an object with tools.

strictbooleanOptional
True to treat each warning as an error.
include_irbooleanOptional
True to get the compiled program when the lint is ok.

Response headers

x-request-idstringOptional

The id of the request: req_ and a ULID. Every answer has it.

server-timingstringOptional
The time of the admission.
x-ratelimit-limit-requestsstringOptional
The size of the request bucket, per minute.
x-ratelimit-remaining-requestsstringOptional
The requests that remain.
x-ratelimit-reset-requestsstringOptional
The time until the request bucket is full.
x-ratelimit-limit-unitsstringOptional
The size of the units bucket, per minute. Absent when no limit applies.
x-ratelimit-remaining-unitsstringOptional
The units that remain.
x-ratelimit-reset-unitsstringOptional
The time until the units bucket is full.

Response

The lint.
object"machine_lint"
okboolean
True when the compiler gave no error.
ir_hashstring or null
diagnosticslist of objects
summaryobject or null
Null only when the procedure cannot be read.
irany

Only with include_ir: true and ok. Else null.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error