UNPKG

@redocly/openapi-core

Version:

See https://github.com/Redocly/redocly-cli

23 lines (21 loc) 789 B
import { Oas3Rule, Oas2Rule } from '../../visitors'; import { Oas2Parameter } from '../../typings/swagger'; import { Oas3Parameter } from '../../typings/openapi'; import { UserContext } from '../../walk'; export const ParameterDescription: Oas3Rule | Oas2Rule = () => { return { Parameter(parameter: Oas2Parameter | Oas3Parameter, { report, location }: UserContext) { if (parameter.description === undefined) { report({ message: 'Parameter object description must be present.', location: { reportOnKey: true }, }); } else if (!parameter.description) { report({ message: 'Parameter object description must be non-empty string.', location: location.child(['description']), }); } }, }; };