Required Examples
provide-examples-on-parameters
general > provide-examples-on-parameters
Guidance / Message
Always include examples in parameters and headers.
Examples
valid
#%RAML 1.0
title: example api
version: 1.0.0
/events:
get:
queryParameters:
organization:
type: string
example: Hello!
responses:
200:
description: Ok!
invalid
#%RAML 1.0
title: example api
version: 1.0.0
/events:
get:
queryParameters:
organization:
type: string
responses:
200:
description: Ok!
Applies to Parameter