Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

r1.1 #64

Merged
merged 3 commits into from
Aug 7, 2024
Merged

r1.1 #64

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions .spectral.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# CAMARA Project - linting ruleset - documentation avaialable here:
# https://github.com/camaraproject/Commonalities/blob/main/documentation/Linting-rules.md
# 31.01.2024 - initial version
# Changelog:
# - 31.01.2024: Initial version
# - 19.03.2024: Corrected camara-http-methods rule


extends: "spectral:oas"
functions:
Expand Down Expand Up @@ -108,7 +111,7 @@ rules:
then:
function: pattern
functionOptions:
match: "^(get|put|post|delete|patch|options)$"
match: "^(get|put|post|delete|patch|options|parameters)$"
recommended: true # Set to true/false to enable/disable this rule

camara-get-no-request-body:
Expand Down Expand Up @@ -156,7 +159,7 @@ rules:
field: description
function: truthy
recommended: true # Set to true/false to enable/disable this rule

camara-parameters-descriptions:
message: "Parameter description is missing or empty: {{error}}"
severity: warn
Expand All @@ -168,7 +171,7 @@ rules:
field: description
function: truthy
recommended: true # Set to true/false to enable/disable this rule

camara-response-descriptions:
message: "Parameter description is missing or empty: {{error}}"
severity: warn
Expand All @@ -193,7 +196,7 @@ rules:
field: description
function: truthy
recommended: true # Set to true/false to enable/disable this rule

camara-operation-summary:
message: "Operation Summary Warning: Each operation should include a short summary for better understanding."
severity: warn
Expand Down Expand Up @@ -255,4 +258,4 @@ rules:
function: pattern
functionOptions:
match: "^\/([a-z0-9]+(-[a-z0-9]+)*)?(\/[a-z0-9]+(-[a-z0-9]+)*|\/{.+})*$" # doesn't allow /asasd{asdas}sadas pattern or not closed braces
recommended: true # Set to true/false to enable/disable this rule
recommended: true # Set to true/false to enable/disable this rule
Loading