Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix ARMViolations for Microsoft.Resources #3912

Merged
merged 3 commits into from
Sep 25, 2018
Merged

Fix ARMViolations for Microsoft.Resources #3912

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2677dee
Fix ARMViolations for Microsoft.Resources
Sep 14, 2018
a6b4f32
Merge branch 'master' of https://github.com/Azure/azure-rest-api-spec…
Sep 24, 2018
d1873c4
Fix ARM Violations in Microsoft.Resources
Sep 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions ...ation/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,31 @@
}
},
"paths": {
"/providers/Microsoft.Resources/operations": {
"get": {
"tags": [
"Operations"
],
"operationId": "ListOperations",
"description": "Lists all of the available Microsoft.Resources REST API operations.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/locations": {
"get": {
"tags": [
Expand Down Expand Up @@ -312,6 +337,49 @@
"nextLink"
],
"description": "Tenant Ids information."
},
"Operation": {
"description": "Microsoft.Resources operation",
"type": "object",
"properties": {
"name": {
"description": "Operation name: {provider}/{resource}/{operation}",
"type": "string"
},
"display": {
"description": "The object that represents the operation.",
"properties": {
"provider": {
"description": "Service provider: Microsoft.Resources",
"type": "string"
},
"resource": {
"description": "Resource on which the operation is performed: Profile, endpoint, etc.",
"type": "string"
},
"operation": {
"description": "Operation type: Read, write, delete, etc.",
"type": "string"
}
}
}
}
},
"OperationListResult": {
"description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Operation"
},
"description": "List of Microsoft.Resources operations."
},
"nextLink": {
"type": "string",
"description": "URL to get the next set of operation list results if there are any."
}
}
}
},
"parameters": {
Expand Down
73 changes: 73 additions & 0 deletions specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/links.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,31 @@
}
},
"paths": {
"/providers/Microsoft.Resources/operations": {
"get": {
"tags": [
"Operations"
],
"operationId": "ListOperations",
"description": "Lists all of the available Microsoft.Resources REST API operations.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/{linkId}": {
"delete": {
"tags": [
Expand Down Expand Up @@ -263,6 +288,11 @@
"type": "string",
"description": "The name of the resource link."
},
"type": {
"readOnly": true,
"type": "object",
"description": "The resource link object."
},
"properties": {
"$ref": "#/definitions/ResourceLinkProperties",
"description": "Properties for resource link."
Expand Down Expand Up @@ -291,6 +321,49 @@
"targetId"
],
"description": "The resource link properties."
},
"Operation": {
"description": "Microsoft.Resources operation",
"type": "object",
"properties": {
"name": {
"description": "Operation name: {provider}/{resource}/{operation}",
"type": "string"
},
"display": {
"description": "The object that represents the operation.",
"properties": {
"provider": {
"description": "Service provider: Microsoft.Resources",
"type": "string"
},
"resource": {
"description": "Resource on which the operation is performed: Profile, endpoint, etc.",
"type": "string"
},
"operation": {
"description": "Operation type: Read, write, delete, etc.",
"type": "string"
}
}
}
}
},
"OperationListResult": {
"description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Operation"
},
"description": "List of Microsoft.Resources operations."
},
"nextLink": {
"type": "string",
"description": "URL to get the next set of operation list results if there are any."
}
}
}
},
"parameters": {
Expand Down
88 changes: 83 additions & 5 deletions ...ification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,31 @@
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this file, when we use autorest to check ARM violations, we always have ARMViolations for "TagDetails". The error is that we must have name and type properties for it, and "TagDetails" has extra properties ['tagName', 'count', 'values']. I checked resources.json for 2018-02-01, the definition for "TagDetails" is the same, but there is no such errors in autorest. Do you know how I can address it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @zjpjack
Please add a suppression rule for the TagDetails object in the Readme. You can tag example on the compute file, this should look like this:

directive:
  - where:
      - $.definitions.TagDetails
    suppress:
      - NameOfYourErrorInCamelCase

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will let @ravbhatnagar knows this suppression, he or I will send another PR for these suppression rules.

},
"paths": {
"/providers/Microsoft.Resources/operations": {
"get": {
"tags": [
"Operations"
],
"operationId": "ListOperations",
"description": "Lists all of the available Microsoft.Resources REST API operations.",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. The request has succeeded.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}": {
"delete": {
"tags": [
Expand Down Expand Up @@ -2785,9 +2810,15 @@
"description": "The ID of the deployment."
},
"name": {
"readOnly": true,
"type": "string",
"description": "The name of the deployment."
},
"type": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just checked the CLI recording that is supposed to return this object:
https://github.com/Azure/azure-cli/blob/dev/src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/tests/latest/recordings/test_subscription_level_deployment.yaml#L66-L68

There is no "type" in the JSON. Could you give me more context why you think it's necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to Autorest, if there is no "type", then we get the following error
ERROR (RequiredPropertiesMissingInResourceModel/R2020/ARMViolation): Model definition 'DeploymentExtended' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Any suggestion for this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The most important is that the Swagger represent the absolute truth about the server. This is indeed an ARM violation, the linter is right that this call does not respect ARM.
Correct to handle this is to send an email to @ravbhatnagar to describe the issue and ask for a ARM suppression rule. So at least the non-conformance is known and documented. Adding type here just shut off the alarm and doesn't solve anything.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will let @ravbhatnagar knows this suppression, he or I will send another PR for these suppression rules.

"readOnly": true,
"type":"object",
"description": "The deployment extension object."
},
"location": {
"type": "string",
"description": "the location of the deployment."
Expand All @@ -2797,9 +2828,6 @@
"description": "Deployment properties."
}
},
"required": [
"name"
],
"x-ms-azure-resource": true,
"description": "Deployment information."
},
Expand Down Expand Up @@ -3000,9 +3028,15 @@
"description": "The ID of the resource group."
},
"name": {
"readOnly": true,
"type": "string",
"description": "The name of the resource group."
},
"type": {
"readOnly": true,
"type": "object",
"description": "The resource group object."
},
"properties": {
"$ref": "#/definitions/ResourceGroupProperties"
},
Expand Down Expand Up @@ -3167,6 +3201,7 @@
"description": "The list of tag values."
}
},
"x-ms-azure-resource": true,
"description": "Tag details."
},
"TagsListResult": {
Expand Down Expand Up @@ -3310,7 +3345,7 @@
},
"operation": {
"type": "string",
"description": "Operation."
"description": "Resource provider operation."
},
"description": {
"type": "string",
Expand Down Expand Up @@ -3349,7 +3384,7 @@
}
},
"x-ms-azure-resource": true,
"description": "Resource."
"description": "Specified resource."
},
"SubResource": {
"properties": {
Expand All @@ -3373,6 +3408,49 @@
}
},
"description": "Resource group export result."
},
"Operation": {
"description": "Microsoft.Resources operation",
"type": "object",
"properties": {
"name": {
"description": "Operation name: {provider}/{resource}/{operation}",
"type": "string"
},
"display": {
"description": "The object that represents the operation.",
"properties": {
"provider": {
"description": "Service provider: Microsoft.Resources",
"type": "string"
},
"resource": {
"description": "Resource on which the operation is performed: Profile, endpoint, etc.",
"type": "string"
},
"operation": {
"description": "Operation type: Read, write, delete, etc.",
"type": "string"
}
}
}
}
},
"OperationListResult": {
"description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Operation"
},
"description": "List of Microsoft.Resources operations."
},
"nextLink": {
"type": "string",
"description": "URL to get the next set of operation list results if there are any."
}
}
}
},
"parameters": {
Expand Down