Skip to content

CLOUDP-304433: Initial Rollout for IPA validations #479

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 6, 2025
Merged

CLOUDP-304433: Initial Rollout for IPA validations #479

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
15ebace
CLOUDP-304433: Initial Rollout for IPA validations
yelizhenden-mdb Mar 5, 2025
07847c1
docs fix
yelizhenden-mdb Mar 5, 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
2 changes: 1 addition & 1 deletion tools/spectral/ipa/rulesets/IPA-005.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ rules:
xgen-IPA-005-exception-extension-format:
description: 'IPA exception extensions must follow the correct format. http://go/ipa/5'
message: '{{error}} http://go/ipa/5'
severity: warn
severity: error
given: '$..x-xgen-IPA-exception'
then:
function: 'exceptionExtensionFormat'
2 changes: 1 addition & 1 deletion tools/spectral/ipa/rulesets/IPA-102.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ rules:
xgen-IPA-102-path-alternate-resource-name-path-param:
description: 'Paths should alternate between resource names and path params. http://go/ipa/102'
message: '{{error}} http://go/ipa/102'
severity: warn
severity: error
given: '$.paths'
then:
field: '@key'
Expand Down
4 changes: 2 additions & 2 deletions tools/spectral/ipa/rulesets/IPA-109.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ rules:
xgen-IPA-109-custom-method-must-be-GET-or-POST:
description: 'The HTTP method for custom methods must be GET or POST. http://go/ipa/109'
message: '{{error}} http://go/ipa/109'
severity: warn
severity: error
given: '$.paths[*]'
then:
function: 'eachCustomMethodMustBeGetOrPost'

xgen-IPA-109-custom-method-must-use-camel-case:
description: 'The custom method must use camelCase format. http://go/ipa/109'
message: '{{error}} http://go/ipa/109'
severity: warn
severity: error
given: '$.paths[*]'
then:
function: 'eachCustomMethodMustUseCamelCase'
2 changes: 1 addition & 1 deletion tools/spectral/ipa/rulesets/IPA-123.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ rules:
xgen-IPA-123-enum-values-must-be-upper-snake-case:
description: 'Enum values must be UPPER_SNAKE_CASE. http://go/ipa/123'
message: '{{error}} http://go/ipa/123'
severity: warn
severity: error
given: '$..enum'
then:
function: 'eachEnumValueMustBeUpperSnakeCase'
10 changes: 5 additions & 5 deletions tools/spectral/ipa/rulesets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ For rule definitions, see [IPA-005.yaml](https://github.com/mongodb/openapi/blob

| Rule Name | Description | Severity |
| --------------------------------------- | ------------------------------------------------------------------------ | -------- |
| xgen-IPA-005-exception-extension-format | IPA exception extensions must follow the correct format. http://go/ipa/5 | warn |
| xgen-IPA-005-exception-extension-format | IPA exception extensions must follow the correct format. http://go/ipa/5 | error |

### IPA-102

For rule definitions, see [IPA-102.yaml](https://github.com/mongodb/openapi/blob/main/tools/spectral/ipa/rulesets/IPA-102.yaml).

| Rule Name | Description | Severity |
| ---------------------------------------------------- | -------------------------------------------------------------------------------- | -------- |
| xgen-IPA-102-path-alternate-resource-name-path-param | Paths should alternate between resource names and path params. http://go/ipa/102 | warn |
| xgen-IPA-102-path-alternate-resource-name-path-param | Paths should alternate between resource names and path params. http://go/ipa/102 | error |

### IPA-104

Expand All @@ -48,8 +48,8 @@ For rule definitions, see [IPA-109.yaml](https://github.com/mongodb/openapi/blob

| Rule Name | Description | Severity |
| ---------------------------------------------- | ------------------------------------------------------------------------- | -------- |
| xgen-IPA-109-custom-method-must-be-GET-or-POST | The HTTP method for custom methods must be GET or POST. http://go/ipa/109 | warn |
| xgen-IPA-109-custom-method-must-use-camel-case | The custom method must use camelCase format. http://go/ipa/109 | warn |
| xgen-IPA-109-custom-method-must-be-GET-or-POST | The HTTP method for custom methods must be GET or POST. http://go/ipa/109 | error |
| xgen-IPA-109-custom-method-must-use-camel-case | The custom method must use camelCase format. http://go/ipa/109 | error |

### IPA-113

Expand All @@ -65,6 +65,6 @@ For rule definitions, see [IPA-123.yaml](https://github.com/mongodb/openapi/blob

| Rule Name | Description | Severity |
| ------------------------------------------------- | ------------------------------------------------------- | -------- |
| xgen-IPA-123-enum-values-must-be-upper-snake-case | Enum values must be UPPER_SNAKE_CASE. http://go/ipa/123 | warn |
| xgen-IPA-123-enum-values-must-be-upper-snake-case | Enum values must be UPPER_SNAKE_CASE. http://go/ipa/123 | error |


Loading