Skip to content

struct.md

Latest commit

 

History

History
87 lines (62 loc) · 2.19 KB

struct.md

File metadata and controls

87 lines (62 loc) · 2.19 KB
slug
/docs/cli/rules/common/struct

struct

Ensures that your API document conforms to structural requirements of OpenAPI specification, AsyncAPI specification, Arazzo specification, or Overlay specification.

OAS Compatibility
2.0 ✅
3.0 ✅
3.1 ✅
3.2 ✅
AsyncAPI Compatibility
2.6 ✅
3.0 ✅
Arazzo Compatibility
1.x ✅
Overlay Compatibility
1.x ✅

The default setting for this rule (in the spec, recommended, and minimal configuration) is error.

This is an essential rule that should not be turned off except in rare and special cases.

API design principles

It's important to conform to the specification so that tools work with your API document. Doing so makes writing and maintenance of API descriptions easier.

Configuration

Option Type Description
severity string Possible values: off, warn, error. Default error.

An example configuration:

rules:
  struct: error

Examples

Given this configuration:

rules:
  struct: error

Example of an incorrect struct:

openapi: 3.0.0
info:
  version: 1.0.0
paths: {}

Example of a correct struct:

openapi: 3.0.0
info:
  title: Ultra API
  version: 1.0.0
paths: {}

Related rules

Resources