Skip to content

Add documentation for expandable resource-list properties #8420

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

Merged
ArcturusZhang merged 3 commits into from
Feb 20, 2020
Merged

Add documentation for expandable resource-list properties #8420

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
84692e3
Add documentation for expandable resource-list properties
anthony-c-martin Feb 18, 2020
a2aacb4
Add suppression for GenericResourceExpanded
anthony-c-martin Feb 18, 2020
12131d6
Revert ResourceListResult naming change
anthony-c-martin Feb 19, 2020
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
49 changes: 45 additions & 4 deletions ...ification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/resources.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,13 @@
"type": "string",
"description": "The filter to apply on the operation."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
},
{
"name": "$top",
"in": "query",
Expand All @@ -538,7 +545,7 @@
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ResourceListResult"
"$ref": "#/definitions/ResourceExpandedListResult"
Comment thread
anthony-c-martin marked this conversation as resolved.
Outdated
}
}
},
Expand Down Expand Up @@ -844,6 +851,13 @@
"type": "string",
"description": "The filter to apply on the operation."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
},
{
"name": "$top",
"in": "query",
Expand All @@ -863,7 +877,7 @@
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ResourceListResult"
"$ref": "#/definitions/ResourceExpandedListResult"
Comment thread
anthony-c-martin marked this conversation as resolved.
Outdated
}
}
},
Expand Down Expand Up @@ -2594,6 +2608,33 @@
],
"description": "Resource information."
},
"GenericResourceExpanded": {
"properties": {
"createdTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "The created time of the resource. This is only present if requested via the $expand query parameter."
},
"changedTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "The changed time of the resource. This is only present if requested via the $expand query parameter."
},
"provisioningState": {
"readOnly": true,
"type": "string",
"description": "The provisioning state of the resource. This is only present if requested via the $expand query parameter."
}
},
"allOf": [
{
"$ref": "#/definitions/GenericResource"
}
],
"description": "Resource information."
},
"Plan": {
"properties": {
"name": {
Expand All @@ -2615,12 +2656,12 @@
},
"description": "Plan for the resource."
},
"ResourceListResult": {
"ResourceExpandedListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/GenericResource"
"$ref": "#/definitions/GenericResourceExpanded"
},
"description": "Gets or sets the list of resource groups."
},
Expand Down
39 changes: 33 additions & 6 deletions ...ification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The $expand query parameter"
"description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
},
{
"name": "$top",
Expand All @@ -601,7 +601,7 @@
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ResourceListResult"
"$ref": "#/definitions/ResourceExpandedListResult"
}
}
},
Expand Down Expand Up @@ -956,7 +956,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The $expand query parameter."
"description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
},
{
"name": "$top",
Expand All @@ -977,7 +977,7 @@
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ResourceListResult"
"$ref": "#/definitions/ResourceExpandedListResult"
}
}
},
Expand Down Expand Up @@ -2149,6 +2149,33 @@
],
"description": "Resource information."
},
"GenericResourceExpanded": {
"properties": {
"createdTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "The created time of the resource. This is only present if requested via the $expand query parameter."
},
"changedTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "The changed time of the resource. This is only present if requested via the $expand query parameter."
},
"provisioningState": {
"readOnly": true,
"type": "string",
"description": "The provisioning state of the resource. This is only present if requested via the $expand query parameter."
}
},
"allOf": [
{
"$ref": "#/definitions/GenericResource"
}
],
"description": "Resource information."
},
"Plan": {
"properties": {
"name": {
Expand Down Expand Up @@ -2226,12 +2253,12 @@
},
"description": "Identity for the resource."
},
"ResourceListResult": {
"ResourceExpandedListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/GenericResource"
"$ref": "#/definitions/GenericResourceExpanded"
},
"description": "The list of resources."
},
Expand Down
39 changes: 33 additions & 6 deletions ...ification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The $expand query parameter"
"description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
},
{
"name": "$top",
Expand All @@ -601,7 +601,7 @@
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ResourceListResult"
"$ref": "#/definitions/ResourceExpandedListResult"
}
}
},
Expand Down Expand Up @@ -956,7 +956,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The $expand query parameter."
"description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
},
{
"name": "$top",
Expand All @@ -977,7 +977,7 @@
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/ResourceListResult"
"$ref": "#/definitions/ResourceExpandedListResult"
}
}
},
Expand Down Expand Up @@ -2157,6 +2157,33 @@
],
"description": "Resource information."
},
"GenericResourceExpanded": {
"properties": {
"createdTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "The created time of the resource. This is only present if requested via the $expand query parameter."
},
"changedTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "The changed time of the resource. This is only present if requested via the $expand query parameter."
},
"provisioningState": {
"readOnly": true,
"type": "string",
"description": "The provisioning state of the resource. This is only present if requested via the $expand query parameter."
}
},
"allOf": [
{
"$ref": "#/definitions/GenericResource"
}
],
"description": "Resource information."
},
"Plan": {
"properties": {
"name": {
Expand Down Expand Up @@ -2234,12 +2261,12 @@
},
"description": "Identity for the resource."
},
"ResourceListResult": {
"ResourceExpandedListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/GenericResource"
"$ref": "#/definitions/GenericResourceExpanded"
},
"description": "The list of resources."
},
Expand Down
39 changes: 33 additions & 6 deletions ...ification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -605,7 +605,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The $expand query parameter"
"description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
},
{
"name": "$top",
Expand All @@ -626,7 +626,7 @@
"200": {
"description": "OK - Returns an array of resources",
"schema": {
"$ref": "#/definitions/ResourceListResult"
"$ref": "#/definitions/ResourceExpandedListResult"
}
}
},
Expand Down Expand Up @@ -984,7 +984,7 @@
"in": "query",
"required": false,
"type": "string",
"description": "The $expand query parameter."
"description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`."
},
{
"name": "$top",
Expand All @@ -1005,7 +1005,7 @@
"200": {
"description": "OK - Returns an array of resources.",
"schema": {
"$ref": "#/definitions/ResourceListResult"
"$ref": "#/definitions/ResourceExpandedListResult"
}
}
},
Expand Down Expand Up @@ -2407,6 +2407,33 @@
],
"description": "Resource information."
},
"GenericResourceExpanded": {
"properties": {
"createdTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "The created time of the resource. This is only present if requested via the $expand query parameter."
},
"changedTime": {
"readOnly": true,
"type": "string",
"format": "date-time",
"description": "The changed time of the resource. This is only present if requested via the $expand query parameter."
},
"provisioningState": {
"readOnly": true,
"type": "string",
"description": "The provisioning state of the resource. This is only present if requested via the $expand query parameter."
}
},
"allOf": [
{
"$ref": "#/definitions/GenericResource"
}
],
"description": "Resource information."
},
"Plan": {
"properties": {
"name": {
Expand Down Expand Up @@ -2484,12 +2511,12 @@
},
"description": "Identity for the resource."
},
"ResourceListResult": {
"ResourceExpandedListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/GenericResource"
"$ref": "#/definitions/GenericResourceExpanded"
},
"description": "An array of resources."
},
Expand Down
Loading