Skip to content

Commit

Permalink
Update .spectral-oas.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
VijayKesharwani authored Oct 27, 2023
1 parent 4986f6d commit ab2b830
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions .spectral-oas.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
functions:
- check-spelling-code
- check-telco-specific-terms
functionsDir: "./lint_function"
rules:
check-spelling-code:
message: "{{error}}"
severity: warn
given:
- "$.info.title"
- "$.info.summary"
- "$.info.description"
- "$.paths.*.*.parameters[?(@.in==='query' || @.in==='path' || @.in==='cookie')].description"
- "$..properties.*.description"
then:
function: check-spelling-code
check-telco-specific-terms:
message: "{{error}}"
severity: hint
description: |
This rule checks for telco-specific terminology in your API definitions and suggests more inclusive terms.
given:
- "$.info.title"
- "$.info.summary"
- "$.info.description.*"
- "$.paths.*.*.description"
- "$.components.*.description"
given: "$..*.*"
then:
function: check-telco-specific-terms

0 comments on commit ab2b830

Please sign in to comment.