Skip to content

[new rule]: Validate content of x-ms-arm-id-details extension #755

@XiaofeiCao

Description

@XiaofeiCao

Lint rule description

We should validate that the content of x-ms-arm-id-details be of correct format.

Related swagger example

Service writes specs with wrong definition and linter didn't detect that: Azure/azure-rest-api-specs#32033 (comment)

"x-ms-arm-id-details": [ 
   { 
     "type": "Microsoft.KeyVault/vaults" 
   } 
 ] 

which should be

"x-ms-arm-id-details": { 
  "allowedResources": [
      { 
       "type": "Microsoft.KeyVault/vaults" 
     }
  ]
}

This difference is very hard to detect. Would be great to have a dedicated linter rule for this.

Category

SDK

Severity level

Error

Applies to

Management plane API spec

How to fix the violation

Comply to the x-ms-arm-id-details definition

What't the impact if breaking the rule

SDK generation would fail.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions