[LintDiff][False positive] ProvisioningStateMustBeReadOnly

[konrad-jamrozik]

The rule ProvisioningStateMustBeReadOnly has been disabled by this PR:

• Display Spectral rules used and validated file path; add support for disabled rules in unit tests; disable known broken rules; refactor azure-openapi-validator#506

Because @bdefoy was stating it is known to cause issues (May 4th, 3:51 PM PST, in the Teams chat)

We need to re-evaluate and re-enable this rule.

[rkmanda]

Task 23293566: [LintDiff][False positive] ProvisioningStateMustBeReadOnly #6191

[rkmanda]

After investigation this turned out not to be a false positive. It is accurately reporting that the provisioningState property is not marked as readOnly. The reason why the property is not being detected as readOnly is because the readOnly property is placed on the envelope property and not on the leaf definition.

Envelope - "provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"description": "Provisioning State of the resource",
"readOnly": true
}

Leaf def
"ProvisioningState": {
"type": "string",
"enum": [
"Succeeded",
"Failed",
"Canceled"
],
"x-ms-enum": {
"name": "ProvisioningState",
"modelAsString": true
}
},

The recommendation here is to ask the author to update the swagger and mention the readOnly property inline with the leaf definition

[rkmanda]

This will need a change in the Typespec generation of swagger. I am working with Mark Cowlishaw on this issue. Once typespec fixes this issue, we can re-enable the linter rule again for this important check

[konrad-jamrozik]

This will need a change in the Typespec generation of swagger. I am working with Mark Cowlishaw on this issue. Once typespec fixes this issue, we can re-enable the linter rule again for this important check

Referenced this comment from:

• https://github.com/Azure/azure-openapi-validator/pull/532/files#diff-4c1382203db84bcd9df61a5bbf90823d0e1f39a833e8eaa1a5be96ca4a4e9b61R766

[cataggar]

I think this can be closed. The solution was to add use-read-only-status-schema: true in options for @azure-tools/typespec-autorest in the tspconfig.yml. More details in #637.