CISCO API Ruleset

general > operation-description

Guidance / Message

Operation '{{apiContract.method}}' should have a description.

Examples

valid

#%RAML 1.0
title: Example
events/:
  get:
    description: OK
    responses:
      200:
        application/json:
          type: string
          example: Hello!

invalid

#%RAML 1.0
title: Example
events/:
  get: # no description
    responses:
      200:
        body:
          application/json:
            type: string
            example: Hello!

Applies to Operation

Constraint

Type: Declarative Validation