Skip to content

OpenAPI 3 specification for the Registry System Testing (RST) API

License

Notifications You must be signed in to change notification settings

icann/rst-api-spec

Repository files navigation

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.

Branches

All development is done on the dev branch. The main branch is updated every Wednesday from the dev branch.

See Also

Copyright Statement

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