Tip

Click here to go directly to the current RST API specification.

This repository contains the specification for the Registry System Testing (RST) API. The specification conforms to the Version 3.0.3 of the OpenAPI specification.

Repository Contents

• rst-api-spec.yaml.in is what you need to edit if you want to make changes to the API specification.

Building the specification

The simplest way to build the specification is to run docker compose run spec (you obviously need Docker). The first run will take a while as it needs to build the image, but it will be quite fast after that.

You can also validate the spec (once built) using docker compose run lint.

Releasing a new version

1. Make the changes you want to make.
2. Once committed, tag the commit. The tag MUST take the form vYYYY.DD where YYYY is the current year and DD is a two-digit serial number that resets to 01 at the start of each year. Then push the tag to GitHub using git push --tags.
3. Create a new release using the tag.

Since the API spec includes data elements from the RST test specs, each time there is a release of the test specs, a new version of the API spec must be released, in order to incorporate any changes to those data elements.

See Also

• RST Test Specifications (GitHub repository)
• IDN test labels for RST v2.0

Copyright Statement

This repository is (c) 2025 Internet Corporation for Assigned Names and Numbers (ICANN). All rights reserved.