Skip to content

[MutabilityWithReadOnly] Add null check to given clause filter #821

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
mikeharder merged 8 commits into from
Feb 3, 2026
Merged

[MutabilityWithReadOnly] Add null check to given clause filter #821

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
32fa5d4
Initial plan
Copilot Feb 2, 2026
7e9bf24
Add null check to MutabilityWithReadOnly given clause and test
Copilot Feb 2, 2026
c585103
Bump version to 2.2.3 and update CHANGELOG
Copilot Feb 2, 2026
2611e13
Apply suggestion from @mikeharder
mikeharder Feb 2, 2026
ebc300f
Apply suggestion from @mikeharder
mikeharder Feb 2, 2026
784f044
Update CHANGELOG.md to remove version 2.2.3
mikeharder Feb 2, 2026
ed59965
empty
mikeharder Feb 2, 2026
62b153d
empty
mikeharder Feb 3, 2026
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
6 changes: 6 additions & 0 deletions packages/rulesets/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change Log - @microsoft.azure/openapi-validator-rulesets

## 2.2.3

### Patches

- [MutabilityWithReadOnly] Add null check to given clause filter to prevent null property objects from being processed

## 2.2.2

### Patches
Expand Down
2 changes: 1 addition & 1 deletion packages/rulesets/generated/spectral/az-arm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1065,7 +1065,7 @@ const ruleset$1 = {
severity: "error",
resolved: true,
formats: [oas2],
given: ["$[paths,'x-ms-paths']..*[?(@.readOnly !== undefined && @['x-ms-mutability'] !== undefined)]"],
given: ["$[paths,'x-ms-paths']..*[?(@ != null && @.readOnly !== undefined && @['x-ms-mutability'] !== undefined)]"],
then: {
function: mutabilityWithReadOnly,
},
Expand Down
2 changes: 1 addition & 1 deletion packages/rulesets/generated/spectral/az-common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -819,7 +819,7 @@ const ruleset = {
severity: "error",
resolved: true,
formats: [oas2],
given: ["$[paths,'x-ms-paths']..*[?(@.readOnly !== undefined && @['x-ms-mutability'] !== undefined)]"],
given: ["$[paths,'x-ms-paths']..*[?(@ != null && @.readOnly !== undefined && @['x-ms-mutability'] !== undefined)]"],
then: {
function: mutabilityWithReadOnly,
},
Expand Down
2 changes: 1 addition & 1 deletion packages/rulesets/generated/spectral/az-dataplane.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -849,7 +849,7 @@ const ruleset$1 = {
severity: "error",
resolved: true,
formats: [oas2],
given: ["$[paths,'x-ms-paths']..*[?(@.readOnly !== undefined && @['x-ms-mutability'] !== undefined)]"],
given: ["$[paths,'x-ms-paths']..*[?(@ != null && @.readOnly !== undefined && @['x-ms-mutability'] !== undefined)]"],
then: {
function: mutabilityWithReadOnly,
},
Expand Down
2 changes: 1 addition & 1 deletion packages/rulesets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@microsoft.azure/openapi-validator-rulesets",
"version": "2.2.2",
"version": "2.2.3",
Comment thread
mikeharder marked this conversation as resolved.
Outdated
"description": "Azure OpenAPI Validator",
"main": "dist/index.js",
"files": [
Expand Down
2 changes: 1 addition & 1 deletion packages/rulesets/src/spectral/az-common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ const ruleset: any = {
severity: "error",
resolved: true,
formats: [oas2],
given: ["$[paths,'x-ms-paths']..*[?(@.readOnly !== undefined && @['x-ms-mutability'] !== undefined)]"],
given: ["$[paths,'x-ms-paths']..*[?(@ != null && @.readOnly !== undefined && @['x-ms-mutability'] !== undefined)]"],
Comment thread
mikeharder marked this conversation as resolved.
then: {
function: mutabilityWithReadOnly,
},
Expand Down
16 changes: 16 additions & 0 deletions packages/rulesets/src/spectral/test/mutability-with-read-only.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,19 @@ test("MutabilityWithReadOnly: properties ignored by given clause", () => {
expect(results.length).toBe(0);
});
});

test("MutabilityWithReadOnly: null property values are filtered by given clause", () => {
const myOpenApiDocument = createOpenApiDoc({
nullProperty: null,
validProperty: {
type: "string",
readOnly: true,
"x-ms-mutability": ["read"],
},
});
return linter.run(myOpenApiDocument).then((results) => {
// Null property should be filtered out by the given clause (@ != null check)
// Only the valid property should pass through, and it's valid so 0 errors
expect(results.length).toBe(0);
});
});
Loading
⚡