Anypoint Best Practices

general > query-params-must-have-descriptions

Guidance / Message

Query parameter: '{{core.name}}' must have a description.

Examples

valid

/events:
  get:
    queryParameters:
      organization:
        displayName: Organization
        type: string
        description: Organization to use, if none is sent the organization for the user is used.

invalid

/events:
  get:
    queryParameters:
      organization:
        displayName: Organization
        type: string # Missing description

Applies to Parameter

Constraint

Type: Declarative Validation