Skip to content

Fix: Degrade severity level for IPA-125 rules #581

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 20, 2025
Merged

Fix: Degrade severity level for IPA-125 rules #581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
372d11c
Fix: Degrade severity level for IPA-125 rules
yelizhenden-mdb Mar 20, 2025
04418c1
ipa docs fix
yelizhenden-mdb Mar 20, 2025
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
4 changes: 2 additions & 2 deletions tools/spectral/ipa/rulesets/IPA-125.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ rules:
This is valid because there are exactly 2 mappings for 2 oneOf references, and all values match.

message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-125-oneOf-must-have-discriminator'
severity: error
severity: warn
given: '$.components.schemas[*]'
then:
function: 'IPA125OneOfMustHaveDiscriminator'
Expand Down Expand Up @@ -84,7 +84,7 @@ rules:
```

message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-125-oneOf-no-base-types'
severity: error
severity: warn
given: '$.components.schemas[*]'
then:
function: 'IPA125OneOfNoBaseTypes'
4 changes: 2 additions & 2 deletions tools/spectral/ipa/rulesets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@ Rules are based on [http://go/ipa/IPA-125](http://go/ipa/IPA-125).

#### xgen-IPA-125-oneOf-must-have-discriminator

![error](https://img.shields.io/badge/error-red)
![warn](https://img.shields.io/badge/warning-yellow)
Each oneOf property must include a discriminator property to define the exact type.

##### Implementation details
Expand Down Expand Up @@ -538,7 +538,7 @@ Rule checks for the following conditions:

#### xgen-IPA-125-oneOf-no-base-types

![error](https://img.shields.io/badge/error-red)
![warn](https://img.shields.io/badge/warning-yellow)
API producers should not use oneOf with base types like integer, string, boolean, or number.

##### Implementation details
Expand Down
Loading