Convert document to HTML

Document type ReSpec Bikeshed Spec Bikeshed Issues List

Output type HTML Messages

Options

Die on

Date (YYYY-MM-DD)

Prepare for TR

Spec Issues list URL (with optional query parameters)

Or, upload a .bs .html or .tar .bsi or .txt file

HTTP API Help

This API may be accessed via GET or POST, with the following parameters:

url

URL to process; required if file is not set

file

File upload to process (POST only); required if url is not set, and takes precedence if both are set.

Formats supported:

For ReSpec: HTML file, or tar archive with its entry point at index.html
For Bikeshed specs: Bikeshed file (typically ending in .bs), or tar archive with its entry point at index.bs
For Bikeshed issue lists: text file (typically ending in .bsi or .txt)

type

Type of processing to perform: respec, bikeshed-spec, or bikeshed-issues-list

die-on

Which levels of events cause processing to fail; values are generator-specific.

Values for ReSpec:

nothing (default)
error
everything

Values for Bikeshed:

nothing
fatal (default)
link-error
warning
lint
message
everything

output

Determines what to send in the response body:

html (default upon success): The processed document as HTML
messages: Errors, warnings, and (in Bikeshed's case) informational messages as JSON

If any message is observed at or exceeding the level specified by die-on, spec-generator will send a 422 response and operate in messages output mode regardless of this parameter.

Note that the structure of messages entries differs between ReSpec and Bikeshed.

md-<key>

Overrides respecConfig or Bikeshed metadata (e.g. md-date=YYYY-MM-DD as exposed in the form above).

With the exception of md-date, keys are generator-specific, but use the same md- prefix for consistency.

Note that in the case of ReSpec requests using url, it is also possible to specify overrides via query parameters within the url parameter. The md-<key> pattern is carried over from Bikeshed to make overrides possible for ReSpec upload requests.