Adding new rule XmsParameterLocation: Check Global parameters for this extension #149
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # XmsParameterLocation | ||
| ## Description | ||
| An Open API Document has a section for parameters. Any parameter that is defined in this (global) parameters section will be treated as client parameters(by autorest). So, the service teams must be absolutely sure that this is the expectation (i.e. defining them as client properties) before defining the parameters in this section. | ||
|
|
||
| 90% scenario is that subscriptionId and api-version are parameters that should be defined in the global parameters section. | ||
|
|
||
| However, one can define a parameter that is being referenced in multiple operations (example: resourceGroupName) in the global parameters section and apply the extension "x-ms-parameter-location": "method". This will then not be a client property. | ||
|
|
||
| So, when you define a parameter in the global parameters section, apply the extension "x-ms-parameter-location": "method" so this will not be treated as a client property. But, if you actually want the parameter to be client properties then apply the extension "x-ms-parameter-location": "client". | ||
|
|
||
| ## How to fix | ||
| Apply "x-ms-parameter-location": "method"/"x-ms-parameter-location": "client" on the global parameters (based on your requirements) | ||
|
|
||
| ## Reference | ||
| Refer [Link](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-parameter-location) for further details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "Microsoft Azure Redis Cache Management API", | ||
| "description": "Some cool documentation.", | ||
| "version": "2014-04-01-preview" | ||
| }, | ||
| "host": "management.azure.com", | ||
| "schemes": [ | ||
| "https" | ||
| ], | ||
| "basePath": "/", | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}": { | ||
| "delete": { | ||
| "tags": [ | ||
| "Redis" | ||
| ], | ||
| "operationId": "Redis_Delete", | ||
| "description": "Deletes a Redis cache.", | ||
| "x-ms-long-running-operation": true, | ||
| "parameters": [ | ||
| { | ||
| "name": "resourceGroupName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the resource group." | ||
| }, | ||
| { | ||
| "name": "name", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the Redis cache." | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/SubscriptionIdParamterer" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "" | ||
| }, | ||
| "204": { | ||
| "description": "" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "Sku": { | ||
| "description": "The SKU (pricing tier) of the CDN profile.", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "$ref": "#/definitions/SkuName", | ||
| "description": "The name." | ||
| } | ||
| } | ||
| }, | ||
| "SkuName": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "NotSpecified", | ||
| "Free", | ||
| "Shared", | ||
| "Basic", | ||
| "Standard", | ||
| "Premium" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "SkuName", | ||
| "modelAsString": false | ||
| }, | ||
| "description": "The sku name." | ||
| }, | ||
| "Resource": { | ||
| "description": "The Resource model definition.", | ||
| "properties": { | ||
| "id": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "x-ms-client-name": "id2", | ||
| "description": "Resource Id" | ||
| }, | ||
| "name": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "description": "Resource name" | ||
| }, | ||
| "type": { | ||
| "readOnly": true, | ||
| "type": "string", | ||
| "description": "Resource type" | ||
| }, | ||
| "location": { | ||
| "type": "string", | ||
| "description": "Resource location" | ||
| }, | ||
| "tags": { | ||
| "type": "object", | ||
| "additionalProperties": { | ||
| "type": "string" | ||
| }, | ||
| "description": "Resource tags" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "location" | ||
| ], | ||
| "x-ms-azure-resource": true | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "SubscriptionIdParamterer": { | ||
| "name": "subscriptionId", | ||
| "in": "path", | ||
| "description": "Subscription ID.", | ||
| "required": true, | ||
| "type": "string" | ||
| }, | ||
| "ApiVersionParameter": { | ||
| "name": "apiVersion", | ||
| "in": "path", | ||
| "description": "API ID.", | ||
| "required": true, | ||
| "type": "string" | ||
| }, | ||
| "CatalogNameParameter": { | ||
| "name": "catalogName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "The name of the data catlog in the specified subscription and resource group." | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a good idea to add a positive test case as well.