OpenAPI Best Practices

general > info-description

Guidance / Message

Provide a description for the API.

Examples

valid

#%RAML 1.0
  title: Ruleset API
  description: "some description"

invalid

#%RAML 1.0
title: Ruleset API

Applies to WebAPI

Constraint

Type: Declarative Validation