Anypoint Best Practices

general > responses-must-have-descriptions

Guidance / Message

Response '{{core.name}}' should have a description.

Examples

valid

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

invalid

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

Applies to Response

Constraint

Type: Declarative Validation