Azure / Azure/azure-sdk-tools

LintDiff: False positives for XmsClientName

Open
#7,886 0 comments 0 reactions 1 assignee Claimed by @konrad-jamrozik View on GitHub
Central-EngSys Spec PR Tools
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

While working on https://github.com/Azure/azure-rest-api-specs/pull/28023, I had to suppress 23 false positives for `XmsClientName`. Here is the first suppression:

``` yaml
- $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}"].put.parameters[4] # privateCloud
```

That is for this OpenAPI:
``` json
"patch": {
"operationId": "PrivateClouds_Update",
"tags": [
"PrivateClouds"
],
"description": "Update a PrivateCloud",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "privateCloudName",
"in": "path",
"description": "Name of the private cloud",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._]+$"
},
{
"name": "privateCloudUpdate",
"in": "body",
"description": "The private cloud properties to be updated.",
"required": true,
"schema": {
"$ref": "#/definitions/PrivateCloudUpdate"
}
}
],
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.