From a73710297583bbb8e2011bf556d71825d6784cdd Mon Sep 17 00:00:00 2001 From: VijayKesharwani <122533719+VijayKesharwani@users.noreply.github.com> Date: Mon, 20 Nov 2023 18:54:45 +0530 Subject: [PATCH] Update .spectral-oas.yml --- .spectral-oas.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/.spectral-oas.yml b/.spectral-oas.yml index ab628fae02..dbfb1d7f6d 100644 --- a/.spectral-oas.yml +++ b/.spectral-oas.yml @@ -84,3 +84,26 @@ rules: function: pattern functionOptions: notMatch: \b(id|Id|ID|iD)\b + camara-parameters-descriptions: + description: This spectral rules check for the description of each parameter + message: Parameter must have description "{{error}}" + severity: hint + given: + - "$.components.*.*" + - "$.components.*.*.properties.*" + then: + field: description + function: truthy + camara-operation-summary: + message: Summary must be defined on each operation, describing with a short summary what the operation does. + severity: warn + given: + - "$.paths.*.post" + - "$.paths.*.get" + - "$.paths.*.delete" + - "$.paths.*.put" + - "$.paths.*.gatch" + - "$.paths.*.options" + then: + field: summary + function: truthy