Skip to content

[AvoidAdditionalProperties] Set resolved:false to only report errors at the source#700

Merged
mikeharder merged 5 commits intoAzure:mainfrom
mikeharder:avoid-additional-properties-refs
Jun 3, 2024
Merged

[AvoidAdditionalProperties] Set resolved:false to only report errors at the source#700
mikeharder merged 5 commits intoAzure:mainfrom
mikeharder:avoid-additional-properties-refs

Conversation

@mikeharder
Copy link
Copy Markdown
Member

@mikeharder mikeharder commented Jun 1, 2024

Verified it fixes the full spec in a local end-to-end test:

$ npx autorest --v3 --spectral --azure-validator --semantic-validator=false --model-validator=false \
  --openapi-type=arm --openapi-subtype=arm --use=@microsoft.azure/openapi-validator@2.2.2 \
  --tag=package-preview-2024-04 specification/desktopvirtualization/resource-manager/readme.md \
 | grep -i avoidadditionalproperties

error   | AvoidAdditionalProperties | Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
error   | AvoidAdditionalProperties | Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
error   | AvoidAdditionalProperties | Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
error   | AvoidAdditionalProperties | Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
error   | AvoidAdditionalProperties | Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
error   | AvoidAdditionalProperties | Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
$ npx autorest --v3 --spectral --azure-validator --semantic-validator=false --model-validator=false \
  --openapi-type=arm --openapi-subtype=arm --use=./packages/azure-openapi-validator/autorest \
  --tag=package-preview-2024-04 ../specs/specification/desktopvirtualization/resource-manager/readme.md \
  | grep AvoidAdditionalProperties

error   | AvoidAdditionalProperties | Definitions must not have properties named additionalProperties except for user defined tags or predefined references.

@mikeharder mikeharder requested a review from markcowl June 1, 2024 05:46
@mikeharder mikeharder marked this pull request as ready for review June 1, 2024 06:01
@mikeharder mikeharder changed the title [AvoidAdditionalProperties] Add test for error via $ref [AvoidAdditionalProperties] Set resolved:false to only report errors at the source Jun 1, 2024
@mikeharder mikeharder self-assigned this Jun 1, 2024
disableForTypeSpecReason: "Covered by TSP's '@azure-tools/typespec-azure-resource-manager/no-record' rule.",
resolved: true,
// Only report errors at the source, not from inside $refs (the resolved document)
resolved: false,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI I believe the resolved is defined here:
https://docs.stoplight.io/docs/spectral/d3482ff0ccae9-rules#resolved

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. After reading that, I feel even more confident this rule should use resolved: false.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

[AvoidAdditionalProperties] Errors should only be reported once per source code location (ignore $refs)

2 participants