Disable false-positive flagging rules in PROD #643
Conversation
| @@ -90,7 +90,7 @@ export function getProperty(schema: any, propName: string): any { | |||
| } | |||
|
|
|||
| export function findBodyParam(params: any) { | |||
| const isBody = (elem: any) => elem.name === "body" && elem.in === "body" | |||
| const isBody = (elem: any) => elem.name === "body" | |||
There was a problem hiding this comment.
What is this change for? is it auto generated? #Resolved
There was a problem hiding this comment.
Nope, it isnt mandatory for the body param's nam eto be "body", it is wrong and fixing it in this PR
There was a problem hiding this comment.
Oh, in that case shouldn't your change be:
| const isBody = (elem: any) => elem.name === "body" | |
| const isBody = (elem: any) => elem.in === "body" |
since we don't care about the param name?
There was a problem hiding this comment.
yup, just fixed it!
thanks
There was a problem hiding this comment.
Any reason to change "body" to "testBody"? #Resolved
There was a problem hiding this comment.
just updating tests to check the fix I made
There was a problem hiding this comment.
Add another changelog file for the RequestBodyMustExistForPutPatch changes. You can run rush change again and there should be an option to add another change #Resolved
| @@ -90,7 +90,7 @@ export function getProperty(schema: any, propName: string): any { | |||
| } | |||
|
|
|||
| export function findBodyParam(params: any) { | |||
| const isBody = (elem: any) => elem.name === "body" && elem.in === "body" | |||
| const isBody = (elem: any) => elem.name === "body" | |||
There was a problem hiding this comment.
Are we sure we don't need "in": "body" for body parameters? It looks like in OpenAPI 2.0 in is required for all parameters, but in OpenAPI 3.0 body parameters use a different property name: requestBody. #Resolved
There was a problem hiding this comment.
My bad,
The intent was to remove the name===body check
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "@microsoft.azure/openapi-validator-rulesets", | |||
| "version": "1.3.1", | |||
| "version": "1.3.2", | |||
There was a problem hiding this comment.
When updating the version make sure to use rush version --bump so the changelog gets generated and the individual changelog files get deleted. See https://github.com/Azure/azure-openapi-validator/blob/main/CONTRIBUTING.md#create-a-release-pr #Resolved
There was a problem hiding this comment.
good point !
Ill do that, thanks
There was a problem hiding this comment.
When you do version bump, you need to discard other file changes.
There was a problem hiding this comment.
@tejaswiMinnu wdym by other file changes?
There was a problem hiding this comment.
Few files were deleted .... rkmanda-fixClientFlattenDocumentation_2023-12-09-02-48.json
There was a problem hiding this comment.
yeah, that is expected.
when we do the version bump, individual changeLog files get deleted and all those are consolidated and added to the main changelog.json
...on/changes/@microsoft.azure/openapi-validator-core/FixDirectCycleIssue_2023-10-10-01-12.json
Outdated
Show resolved
Hide resolved
...alidator-rulesets/akhilailla-Make_XmsIdentifierValidation_rule_warning_2023-12-04-20-10.json
Show resolved
Hide resolved
Folks have been complaining about rules being falsely flagged after the prod release.
This PR is to disable all those rules and also to fix RequestBodyMustExistForPutPatch(rules looks for the body param name to be "body" and it isn't mandatory for the body param's name to be "body", it is wrong and fixing it in this PR)