Organizing ARM linter rules (Azure#423)

rkmanda · web-flow · commit f211e0f2a82d · 2022-12-14T12:45:39.000+08:00
* Adding RPC guideline code

* organizing ARM RPC rules
diff --git a/docs/all-resources-must-have-delete.md b/docs/all-resources-must-have-delete.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-DELETE-02
+- RPC-Delete-V1-03
 
 ## Output Message
 
diff --git a/docs/all-resources-must-have-get-operation.md b/docs/all-resources-must-have-get-operation.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-GET-04
+- RPC-Get-V1-04
 
 ## Output Message
 
diff --git a/docs/api-version-parameter-required.md b/docs/api-version-parameter-required.md
@@ -10,11 +10,11 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-URI-9
+- RPC-Uri-V1-08
 
 ## Description
 
-This rule applies when the 'api-version' parameter is missing in any operations.
+Operation is missing the 'api-version' parameter.
 
 ## How to fix
 
diff --git a/docs/arm-resource-properties-bag.md b/docs/arm-resource-properties-bag.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-GET-04
+- RPC-Get-V1-07
 
 ## Output Message
 
diff --git a/docs/body-top-level-properties.md b/docs/body-top-level-properties.md
@@ -11,7 +11,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-PUT-6
+- RPC-Put-V1-06
 
 ## Output Message
 
diff --git a/docs/consistent-patch-properties.md b/docs/consistent-patch-properties.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-Patch-3
+- RPC-Patch-V1-03
 
 ## Output Message
 
diff --git a/docs/create-operation-async-response-validation.md b/docs/create-operation-async-response-validation.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-ASYNC-1
+- RPC-Async-V1-01
 
 ## Output Message
 
diff --git a/docs/delete-must-not-have-request-body.md b/docs/delete-must-not-have-request-body.md
@@ -8,6 +8,10 @@ SDK Error
 
 ARM and Data plane OpenAPI(swagger) specs
 
+## Related ARM Guideline Code
+
+- RPC-Delete-V1-02
+
 ## Output Message
 
 'Delete' operation '{0}' must not have a request body.
diff --git a/docs/delete-operation-async-response-validation.md b/docs/delete-operation-async-response-validation.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-ASYNC-9
+- RPC-Async-V1-09
 
 ## Output Message
 
diff --git a/docs/delete-operation-responses.md b/docs/delete-operation-responses.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-DELETE-01
+- RPC-Delete-V1-01
 
 ## Output Message
 
diff --git a/docs/delete-response-body-empty.md b/docs/delete-response-body-empty.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-Delete-04
+- RPC-Delete-V1-04
 
 ## Output Message
 
diff --git a/docs/get-operation200.md b/docs/get-operation200.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-GET-01
+- RPC-Get-V1-01
 
 ## Output Message
 
diff --git a/docs/location-must-have-xms-mutability.md b/docs/location-must-have-xms-mutability.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-PUT-14
+- RPC-Put-V1-14
 
 ## Output Message
 
diff --git a/docs/long-running-operations-options-validator.md b/docs/long-running-operations-options-validator.md
@@ -10,7 +10,7 @@ ARM and Data Plane OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-ASYNC-5
+- RPC-Async-V1-05
 
 ## Output Message
 
diff --git a/docs/long-running-operations-with-long-running-extension.md b/docs/long-running-operations-with-long-running-extension.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-ASYNC-5
+- RPC-Async-V1-05
 
 ## Output Message
 
diff --git a/docs/long-running-response-status-code-data-plane.md b/docs/long-running-response-status-code-data-plane.md
@@ -10,7 +10,7 @@ ARM and Data plane OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-ASYNC-1
+- RPC-Async-V1-01
 
 ## Output Message
 
diff --git a/docs/long-running-response-status-code.md b/docs/long-running-response-status-code.md
@@ -10,7 +10,7 @@ ARM and Data plane OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-ASYNC-1
+- RPC-Async-V1-01
 
 ## Output Message
 
diff --git a/docs/lro-location-header.md b/docs/lro-location-header.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-ASYNC-7
+- RPC-Async-V1-07
 
 ## Output Message
 
diff --git a/docs/lro-patch202.md b/docs/lro-patch202.md
@@ -10,8 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-Patch-6
-- RPC-V2-ASYNC-8
+- RPC-Patch-V1-06, RPC-Async-V1-08
 
 ## Output Message
 
diff --git a/docs/next-link-property-must-exist.md b/docs/next-link-property-must-exist.md
@@ -10,7 +10,7 @@ ARM and Data plane OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-GET-06
+- RPC-Get-V1-06
 
 ## Output Message
 
diff --git a/docs/patch-body-parameters-schema.md b/docs/patch-body-parameters-schema.md
@@ -10,7 +10,7 @@ ARM and Data plane OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-Patch-10
+- RPC-Patch-V1-10
 
 ## Output Message
 
diff --git a/docs/patch-identity-property.md b/docs/patch-identity-property.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-Patch-11
+- RPC-Patch-V1-11
 
 ## Output Message
 
diff --git a/docs/patch-sku-property.md b/docs/patch-sku-property.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-Patch-9
+- RPC-Patch-V1-09
 
 ## Output Message
 
diff --git a/docs/path-contains-resource-group.md b/docs/path-contains-resource-group.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-URI-2
+- RPC-Uri-V1-02
 
 ## Output Message
 
diff --git a/docs/path-contains-resource-type.md b/docs/path-contains-resource-type.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-URI-4
+- RPC-Uri-V1-04
 
 ## Output Message
 
diff --git a/docs/path-contains-subscription-id.md b/docs/path-contains-subscription-id.md
@@ -10,11 +10,11 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-URI-1
+- RPC-Uri-V1-01
 
 ## Output Message
 
-The path for the subscriptions scoped CRUD methods do not contain the subscriptionId parameter.
+The path for the resource group scoped CRUD methods do not contain the subscriptionId parameter.
 
 ## Description
 
diff --git a/docs/path-for-nested-resource.md b/docs/path-for-nested-resource.md
@@ -10,8 +10,8 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-URI-6
-- RPC-V2-PUT-2
+- RPC-Uri-V1-06
+- RPC-Put-V1-02
 
 ## Output Message
 
diff --git a/docs/path-for-put-operation.md b/docs/path-for-put-operation.md
@@ -10,8 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-URI-7
-- RPC-V2-PUT-1
+- RPC-Put-V1-01
 
 ## Output Message
 
diff --git a/docs/path-for-resource-action.md b/docs/path-for-resource-action.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-URI-7
+- RPC-Uri-V1-07
 
 ## Output Message
 
diff --git a/docs/path-resource-provider-match-namespace.md b/docs/path-resource-provider-match-namespace.md
@@ -10,15 +10,15 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-URI-3
+- RPC-Uri-V1-03
 
 ## Output Message
 
-The last resource provider '{0}' doesn't match the namespace.
+The resource provider namespace name '{0}' in the path doesn't match the namespace name to which the specification file belongs.
 
 ## Description
 
-Verifies whether the last resource provider matches namespace or not. E.g the path /providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Insights/extResource/{extType}' is allowed only if Microsoft.Insights matches the namespace (Microsoft.Insights).
+Verifies whether the resource provider namespace in the last segment of the path matches the namespace to which the specification file belongs. E.g the path /providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Insights/extResource/{extType}' is allowed only if the segment /Microsoft.Insights matches the namespace name to which the specification file belongs (Microsoft.Insights).
 
 ## Why the rule is important
 
diff --git a/docs/post-operation-async-response-validation.md b/docs/post-operation-async-response-validation.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-ASYNC-11
+- RPC-Async-V1-11
 
 ## Output Message
 
diff --git a/docs/provisioning-state-validation.md b/docs/provisioning-state-validation.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-ASYNC-03
+- RPC-Async-V1-03
 
 ## Output Message
 
diff --git a/docs/put-get-patch-response-schema.md b/docs/put-get-patch-response-schema.md
@@ -10,7 +10,7 @@ ARM and Data plane OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-PUT-12
+- RPC-Put-V1-12
 
 ## Output Message
 
diff --git a/docs/repeated-path-info.md b/docs/repeated-path-info.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-PUT-5
+- RPC-Put-V1-05
 
 ## Output Message
 
diff --git a/docs/required-properties-missing-in-resource-model.md b/docs/required-properties-missing-in-resource-model.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-GET-03
+- RPC-Get-V1-03, RPC-Put-V1-08
 
 ## Output Message
 
diff --git a/docs/resource-name-restriction.md b/docs/resource-name-restriction.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-URI-5
+- RPC-Uri-V1-05
 
 ## Output Message
 
diff --git a/docs/top-level-resources-list-by-resource-group.md b/docs/top-level-resources-list-by-resource-group.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-GET-05
+- RPC-Get-V1-05
 
 ## Output Message
 
diff --git a/docs/top-level-resources-list-by-subscription.md b/docs/top-level-resources-list-by-subscription.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-GET-05
+- RPC-Get-V1-05
 
 ## Output Message
 
diff --git a/docs/tracked-resource-beyond-thrid-level.md b/docs/tracked-resource-beyond-thrid-level.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-PUT-19
+- RPC-Put-V1-19
 
 ## Output Message
 
diff --git a/docs/tracked-resource-patch-operation.md b/docs/tracked-resource-patch-operation.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-Patch-3
+- RPC-Patch-V1-03
 
 ## Output Message
 
diff --git a/docs/tracked-resources-must-have-put.md b/docs/tracked-resources-must-have-put.md
@@ -10,7 +10,7 @@ ARM OpenAPI(swagger) specs
 
 ## Related ARM Guideline Code
 
-- RPC-V2-PUT-22
+- RPC-Put-V1-22
 
 ## Output Message
 
diff --git a/docs/un-supported-patch-properties.md b/docs/un-supported-patch-properties.md
diff --git a/docs/xms-long-running-operation-options.md b/docs/xms-long-running-operation-options.md
diff --git a/docs/xms-resource-in-put-response.md b/docs/xms-resource-in-put-response.md
diff --git a/packages/rulesets/src/native/legacyRules/AllResourcesMustHaveGetOperation.ts b/packages/rulesets/src/native/legacyRules/AllResourcesMustHaveGetOperation.ts
diff --git a/packages/rulesets/src/native/legacyRules/DeleteOperationAsyncResponseValidation.ts b/packages/rulesets/src/native/legacyRules/DeleteOperationAsyncResponseValidation.ts
diff --git a/packages/rulesets/src/native/legacyRules/DeleteOperationResponses.ts b/packages/rulesets/src/native/legacyRules/DeleteOperationResponses.ts
diff --git a/packages/rulesets/src/native/legacyRules/PostOperationAsyncResponseValidation.ts b/packages/rulesets/src/native/legacyRules/PostOperationAsyncResponseValidation.ts
diff --git a/packages/rulesets/src/native/legacyRules/TopLevelResourcesListByResourceGroup.ts b/packages/rulesets/src/native/legacyRules/TopLevelResourcesListByResourceGroup.ts
diff --git a/packages/rulesets/src/native/legacyRules/TopLevelResourcesListBySubscription.ts b/packages/rulesets/src/native/legacyRules/TopLevelResourcesListBySubscription.ts
diff --git a/packages/rulesets/src/native/rulesets/arm.ts b/packages/rulesets/src/native/rulesets/arm.ts
diff --git a/packages/rulesets/src/spectral/az-arm.ts b/packages/rulesets/src/spectral/az-arm.ts
diff --git a/packages/rulesets/src/spectral/az-common.ts b/packages/rulesets/src/spectral/az-common.ts
diff --git a/src/typescript/azure-openapi-validator/rules/AllResourcesMustHaveGetOperation.ts b/src/typescript/azure-openapi-validator/rules/AllResourcesMustHaveGetOperation.ts
diff --git a/src/typescript/azure-openapi-validator/rules/DeleteOperationResponses.ts b/src/typescript/azure-openapi-validator/rules/DeleteOperationResponses.ts
diff --git a/src/typescript/azure-openapi-validator/rules/TopLevelResourcesListByResourceGroup.ts b/src/typescript/azure-openapi-validator/rules/TopLevelResourcesListByResourceGroup.ts
