Anypoint Best Practices

general > operations-must-have-descriptions

Guidance / Message

Provide descriptions for the operations.

Examples

valid

/events:
  get:
    displayName: get
    description: Gets a stream of results
    responses:
      200:
        description: Ok!
        body:
          application/json:
            type: string

invalid

/events:
  get:
    displayName: get # missing description
    responses:
      200:
        body:
          application/json:
            type: string

Applies to Operation

Constraint

Type: Declarative Validation