/
IATA Open Air API Linter Ruleset

IATA Open Air API Linter Ruleset

Owned by Jean-Christophe Cornu
Last updated: 11 Apr 2025 by Vanni Sanvincenti

What is a Linter?

Lint, or a linter, is a static code analysis tool used to flag programming errors, bugs, stylistic errors and suspicious constructs. -- Wikipedia Lint (software)

Benefits of a linter:

  • Discover errors and warning to address in compliance with the standard

  • Improve quality of design

  • Keep consistent design style

How a Linter works?

image-20250403-084839.png

Open Air API linter ruleset

The Open Air REST API linter ruleset is developed by the IATA Open API working group, to facilitate developers' adoption of the industry best practices and achieve the IATA Open Air API certification.

The ruleset can be used to validate any OpenAPI 3.0 document in compliance with the requirements in Chapter 2.3 “API Specification” of the IATA Open Air API Standards and Best Practices, with the purpose to achieve the level 1 Open Air certification. It does not validate the API schema definition in the specification in compliance with the standard data model from the JSON library.

The ruleset is developed based on the Spectral open-source linter framework. Please check the Spectral github for usage and support documentation.

Linter Ruleset release

The linter ruleset is also defined as the Stoplight global style guide (https://open-air.stoplight.io/docs/iata-style-guide ), which is readily discovered and used by developers in their Stoplight API projects.