This REST styleguide is established by the REST design working group, which includes various participating Belgian government institutions.

The styleguide, built from these sources, is publicly available on https://www.gcloud.belgium.be/rest/.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in the REST styleguide are to be interpreted as described in RFC 2119. They are used in the rules defined throughout the REST styleguide wherever possible.

Examples must follow the following format:

.example title
====
<example, may use nested code blocks>
====

Rules must follow the following format:

[.rule, caption="Rule {counter:rule-number}: "]
.rule title
====
<the rule, using RFC 2119 key words>
====

The styleguide is built with Apache Maven.

With Maven installed, run mvn site in the root directory of the project. The styleguide will be built in the target/site/doc/ directory.