Skip to content

Commit

Permalink
[Blueprints] Swagger model update for documentation (#8373)
Browse files Browse the repository at this point in the history 
* Update swagger for missing properties

* Revert "Update swagger for missing properties"

This reverts commit dc74330.

* Update swagger parameter value modeling

* update swagger to support documentation tooling

* Minor updates
  • Loading branch information
@filizt
filizt authored Feb 14, 2020
1 parent 9ab9076 commit 11f8fd9
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 85 deletions.
33 changes: 12 additions & 21 deletions .../resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -364,12 +364,19 @@
"description": "ID of the published version of a blueprint definition."
},
"parameters": {
"$ref": "#/definitions/ParameterValueCollection",
"description": "Blueprint assignment parameter values."
"type": "object",
"description": "Blueprint assignment parameter values.",
"additionalProperties": {
"description": "Key/Value pair of parameter fulfillment.",
"$ref": "#/definitions/ParameterValue"
}
},
"resourceGroups": {
"$ref": "#/definitions/ResourceGroupValueCollection",
"description": "Names and locations of resource group placeholders."
"description": "Names and locations of resource group placeholders.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/ResourceGroupValue"
}
},
"status": {
"description": "Status of blueprint assignment. This field is readonly.",
Expand Down Expand Up @@ -412,15 +419,6 @@
"resourceGroups"
]
},
"ParameterValueCollection": {
"description": "A dictionary for parameters and their corresponding values.",
"type": "object",
"properties": {},
"additionalProperties": {
"description": "Key/Value pair of parameter fulfillment.",
"$ref": "#/definitions/ParameterValue"
}
},
"ParameterValue": {
"description": "Value for the specified parameter. Can be either 'value' or 'reference' but not both.",
"type": "object",
Expand All @@ -429,6 +427,7 @@
"description": "Parameter value as value type."
},
"reference": {
"type": "object",
"description": "Parameter value as reference type.",
"$ref": "#/definitions/SecretValueReference"
}
Expand Down Expand Up @@ -469,14 +468,6 @@
"id"
]
},
"ResourceGroupValueCollection": {
"description": "A dictionary which maps resource group placeholders to the resource groups which will be created.",
"type": "object",
"properties": {},
"additionalProperties": {
"$ref": "#/definitions/ResourceGroupValue"
}
},
"ResourceGroupValue": {
"description": "Represents an Azure resource group.",
"type": "object",
Expand Down
89 changes: 25 additions & 64 deletions .../resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -851,11 +851,19 @@
},
"parameters": {
"description": "Parameters required by this blueprint definition.",
"$ref": "#/definitions/ParameterDefinitionCollection"
"type": "object",
"additionalProperties": {
"description": "Named collection of parameter metadata.",
"$ref": "#/definitions/ParameterDefinition"
}
},
"resourceGroups": {
"description": "Resource group placeholders defined by this blueprint definition.",
"$ref": "#/definitions/ResourceGroupDefinitionCollection"
"type": "object",
"additionalProperties": {
"description": "Named collection for resourceGroupDefinition.",
"$ref": "#/definitions/ResourceGroupDefinition"
}
}
},
"allOf": [
Expand Down Expand Up @@ -931,8 +939,12 @@
"description": "If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed."
},
"parameters": {
"type": "object",
"description": "Resource Manager template blueprint artifact parameter values.",
"$ref": "#/definitions/ParameterValueCollection"
"additionalProperties": {
"description": "Key/Value pair of parameter fulfillment.",
"$ref": "#/definitions/ParameterValue"
}
}
},
"allOf": [
Expand Down Expand Up @@ -1026,8 +1038,12 @@
"description": "Azure resource ID of the policy definition."
},
"parameters": {
"type": "object",
"description": "Parameter values for the policy definition.",
"$ref": "#/definitions/ParameterValueCollection"
"additionalProperties": {
"description": "Key/Value pair of parameter fulfillment.",
"$ref": "#/definitions/ParameterValue"
}
},
"resourceGroup": {
"type": "string",
Expand Down Expand Up @@ -1067,15 +1083,6 @@
"properties"
]
},
"ParameterValueCollection": {
"description": "A dictionary for parameters and their corresponding values.",
"type": "object",
"properties": {},
"additionalProperties": {
"description": "Key/Value pair of parameter fulfillment.",
"$ref": "#/definitions/ParameterValue"
}
},
"ParameterValue": {
"description": "Value for the specified parameter. Can be either 'value' or 'reference' but not both.",
"type": "object",
Expand All @@ -1084,6 +1091,7 @@
"description": "Parameter value as value type."
},
"reference": {
"type": "object",
"description": "Parameter value as reference type.",
"$ref": "#/definitions/SecretValueReference"
}
Expand Down Expand Up @@ -1124,15 +1132,6 @@
"id"
]
},
"ParameterDefinitionCollection": {
"description": "A dictionary hold parameter name and its metadata.",
"type": "object",
"properties": {},
"additionalProperties": {
"description": "Named collection of parameter metadata.",
"$ref": "#/definitions/ParameterDefinition"
}
},
"ParameterDefinition": {
"description": "Represent a parameter with constrains and metadata.",
"type": "object",
Expand Down Expand Up @@ -1174,15 +1173,6 @@
"type"
]
},
"ResourceGroupDefinitionCollection": {
"description": "A dictionary which maps resource group placeholders to the resource groups which will be created.",
"type": "object",
"properties": {},
"additionalProperties": {
"description": "Named collection for resourceGroupDefinition.",
"$ref": "#/definitions/ResourceGroupDefinition"
}
},
"ResourceGroupDefinition": {
"description": "Represents an Azure resource group in a blueprint definition.",
"type": "object",
Expand Down Expand Up @@ -1213,18 +1203,13 @@
},
"tags": {
"description": "Tags to be assigned to this resource group.",
"$ref": "#/definitions/ResourceGroupTagCollection"
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"ResourceGroupTagCollection": {
"description": "A dictionary of resource group tag values.",
"type": "object",
"properties": {},
"additionalProperties": {
"type": "string"
}
},
"ParameterDefinitionMetadata": {
"type": "object",
"description": "User-friendly properties for this parameter.",
Expand All @@ -1246,30 +1231,6 @@
}
}
},
"ResourceGroupValueCollection": {
"description": "A dictionary which maps resource group placeholders to the resource groups which will be created.",
"type": "object",
"properties": {},
"additionalProperties": {
"$ref": "#/definitions/ResourceGroupValue"
}
},
"ResourceGroupValue": {
"description": "Represents an Azure resource group.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the resource group.",
"minLength": 1,
"maxLength": 90
},
"location": {
"type": "string",
"description": "Location of the resource group."
}
}
},
"AzureResourceBase": {
"description": "Common properties for all Azure resources.",
"type": "object",
Expand Down

0 comments on commit 11f8fd9

Please sign in to comment.