Skip to content

[KeyVault] Updating resource-manager swagger to include missing defintions #2210

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
salameer merged 13 commits into from
Jan 5, 2018
Merged

[KeyVault] Updating resource-manager swagger to include missing defintions #2210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0bcffea
updating keyvault RM swagger to include missing definitions and examples
Jan 3, 2018
bece2a3
fixing updated paths in readme.md
Jan 3, 2018
56bc236
moving attributes definition into secrets.json
Jan 3, 2018
462e482
referencing Resource definition from keyvault.json in secrets.json
Jan 3, 2018
e5f5687
updates addressing PR feedback
Jan 4, 2018
03e395d
fixing linting issues introduced with updates
Jan 4, 2018
b2ff292
moving listOperations method to providers.json as it's not a vault op…
Jan 4, 2018
c799ef9
adding providers.json to readme.md
Jan 4, 2018
22a028c
fixing syntax error in keyvault.json
Jan 4, 2018
be28391
fixing typos in property descriptions
Jan 4, 2018
3c6661a
fixing parameter name in example checkVaultNameAvailability.json
Jan 4, 2018
7e2d938
updating descriptions and examples based on PR feedback
Jan 5, 2018
152da1e
adding 201 response to updateSecret.json example
Jan 5, 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
17 changes: 17 additions & 0 deletions ...rce-manager/Microsoft.KeyVault/stable/2016-10-01/examples/checkVaultNameAvailability.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"parameters":{
"subscriptionId":"00000000-0000-0000-0000-000000000000",
"api-version":"2016-10-01",
"vaultName":{
"name":"sample-vault",
"type":"Microsoft.KeyVault/vaults"
}
},
"responses":{
"200":{
"body":{
"nameAvailable":true
}
}
}
}
50 changes: 50 additions & 0 deletions ...keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/examples/createSecret.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"parameters":{
"resourceGroupName":"sample-group",
"vaultName":"sample-vault",
"secretName":"secret-name",
"subscriptionId":"00000000-0000-0000-0000-000000000000",
"api-version":"2016-10-01",
"parameters":{
"properties":{
"value": "secret-value"
}
}
},
"responses": {
"200": {
Copy link
Copy Markdown
Contributor

@jianghaolu jianghaolu Jan 3, 2018

Choose a reason for hiding this comment

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

Please add 201 response example.

Copy link
Copy Markdown
Author

@schaabs schaabs Jan 4, 2018

Choose a reason for hiding this comment

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

Added

Copy link
Copy Markdown
Contributor

@jianghaolu jianghaolu Jan 5, 2018

Choose a reason for hiding this comment

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

You might have missed this one

"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name",
"name": "secret-name",
"type": "Microsoft.KeyVault/vaults/secrets",
"location": "westus",
"properties": {
"attributes": {
Copy link
Copy Markdown
Contributor

@jianghaolu jianghaolu Jan 3, 2018

Choose a reason for hiding this comment

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

Missing required property "value".

Copy link
Copy Markdown
Author

@schaabs schaabs Jan 4, 2018

Choose a reason for hiding this comment

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

value is not actually required in this model. I've update the model to reflect that.

"enabled": true,
"created": 1514938738,
"updated": 1514938738
},
"secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name",
"secretUriWithVersion": "https:/sample-vault.vault.azure.net/secrets/secret-name/baf6de32c4774c7c81345f6476cf90a4"
}
}
},
"201": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name",
"name": "secret-name",
"type": "Microsoft.KeyVault/vaults/secrets",
"location": "westus",
"properties": {
"attributes": {
"enabled": true,
"created": 1514938738,
"updated": 1514938738
},
"secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name",
"secretUriWithVersion": "https:/sample-vault.vault.azure.net/secrets/secret-name/baf6de32c4774c7c81345f6476cf90a4"
}
}
}
}
}
204 changes: 204 additions & 0 deletions .../keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/examples/createVault.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
{
"parameters":{
"resourceGroupName":"sample-resource-group",
"vaultName":"sample-vault",
"subscriptionId":"00000000-0000-0000-0000-000000000000",
"api-version":"2016-10-01",
"parameters":{
"location": "westus",
"properties":{
"tenantId": "00000000-0000-0000-0000-000000000000",
"sku": {"family": "A", "name": "standard"},
"accessPolicies":[{
"tenantId": "00000000-0000-0000-0000-000000000000",
"objectId": "00000000-0000-0000-0000-000000000000",
"permissions": {
"keys": [
"encrypt",
"decrypt",
"wrapKey",
"unwrapKey",
"sign",
"verify",
"get",
"list",
"create",
"update",
"import",
"delete",
"backup",
"restore",
"recover",
"purge"
],
"secrets":[
"get",
"list",
"set",
"delete",
"backup",
"restore",
"recover",
"purge"
],
"certificates":[
"get",
"list",
"delete",
"create",
"import",
"update",
"managecontacts",
"getissuers",
"listissuers",
"setissuers",
"deleteissuers",
"manageissuers",
"recover",
"purge"
]
}
}],
"enabledForDeployment": true,
"enabledForDiskEncryption": true,
"enabledForTemplateDeployment": true
}
}
},
"responses":{
"200":{
Copy link
Copy Markdown
Contributor

@jianghaolu jianghaolu Jan 3, 2018

Choose a reason for hiding this comment

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

Vaults_CreateOrUpdate can return 201 too, please provide example response.

Copy link
Copy Markdown
Author

@schaabs schaabs Jan 4, 2018

Choose a reason for hiding this comment

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

Added

"body":{
"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
"name":"sample-vault",
"type":"Microsoft.KeyVault/vaults",
"location":"westus",
"tags":{},
"properties":{
"sku":{"family":"A","name":"standard"},
"tenantId":"00000000-0000-0000-0000-000000000000",
"accessPolicies":[{
"tenantId": "00000000-0000-0000-0000-000000000000",
"objectId": "00000000-0000-0000-0000-000000000000",
"permissions": {
"keys": [
"encrypt",
"decrypt",
"wrapKey",
"unwrapKey",
"sign",
"verify",
"get",
"list",
"create",
"update",
"import",
"delete",
"backup",
"restore",
"recover",
"purge"
],
"secrets":[
"get",
"list",
"set",
"delete",
"backup",
"restore",
"recover",
"purge"
],
"certificates":[
"get",
"list",
"delete",
"create",
"import",
"update",
"managecontacts",
"getissuers",
"listissuers",
"setissuers",
"deleteissuers",
"manageissuers",
"recover",
"purge"
]
}
}],
"enabledForDeployment":true,
"enabledForDiskEncryption":true,
"enabledForTemplateDeployment":true,
"vaultUri":"https://sample-vault.vault.azure.net"
}
}
},
"201":{
"body":{
"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
"name":"sample-vault",
"type":"Microsoft.KeyVault/vaults",
"location":"westus",
"tags":{},
"properties":{
"sku":{"family":"A","name":"standard"},
"tenantId":"00000000-0000-0000-0000-000000000000",
"accessPolicies":[{
"tenantId": "00000000-0000-0000-0000-000000000000",
"objectId": "00000000-0000-0000-0000-000000000000",
"permissions": {
"keys": [
"encrypt",
"decrypt",
"wrapKey",
"unwrapKey",
"sign",
"verify",
"get",
"list",
"create",
"update",
"import",
"delete",
"backup",
"restore",
"recover",
"purge"
],
"secrets":[
"get",
"list",
"set",
"delete",
"backup",
"restore",
"recover",
"purge"
],
"certificates":[
"get",
"list",
"delete",
"create",
"import",
"update",
"managecontacts",
"getissuers",
"listissuers",
"setissuers",
"deleteissuers",
"manageissuers",
"recover",
"purge"
]
}
}],
"enabledForDeployment":true,
"enabledForDiskEncryption":true,
"enabledForTemplateDeployment":true,
"vaultUri":"https://sample-vault.vault.azure.net"
}
}
}
}
}
14 changes: 14 additions & 0 deletions .../keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/examples/deleteVault.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"parameters":{
"resourceGroupName":"sample-resource-group",
"vaultName":"sample-vault",
"subscriptionId":"00000000-0000-0000-0000-000000000000",
"api-version":"2016-10-01"
},
"responses":{
"200":{
"headers":{},
"body":""
}
}
}
25 changes: 25 additions & 0 deletions ...vault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/examples/getDeletedVault.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"parameters":{
"vaultName":"sample-vault",
"location":"westus",
"subscriptionId":"00000000-0000-0000-0000-000000000000",
"api-version":"2016-10-01"
},
"responses":{
"200":{
"headers":{},
"body":{
"id":"/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault",
"name":"sample-vault",
"type":"Microsoft.KeyVault/deletedVaults",
"properties":{
"vaultId":"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault",
"location":"westus",
"tags":{},
"deletionDate":"2017-01-01T00:00:59Z",
"scheduledPurgeDate":"2017-04-01T00:00:59Z"
}
}
}
}
}
28 changes: 28 additions & 0 deletions ...on/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/examples/getSecret.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"parameters": {
"resourceGroupName": "sample-group",
"vaultName": "sample-vault",
"secretName":"secret-name",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"api-version": "2016-10-01"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/secrets/secret-name",
"name": "secret-name",
"type": "Microsoft.KeyVault/vaults/secrets",
"location": "westus",
"properties": {
"attributes": {
"enabled": true,
"created": 1514940950,
"updated": 1514940950
},
Copy link
Copy Markdown
Contributor

@jianghaolu jianghaolu Jan 3, 2018

Choose a reason for hiding this comment

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

Missing required property "value".

Copy link
Copy Markdown
Contributor

@jianghaolu jianghaolu Jan 3, 2018

Choose a reason for hiding this comment

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

Same for listSecrets.json

Copy link
Copy Markdown
Author

@schaabs schaabs Jan 4, 2018

Choose a reason for hiding this comment

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

value is not actually required in this model. I've update the model to reflect that.

"secretUri": "https://sample-vault.vault.azure.net/secrets/secret-name",
"secretUriWithVersion": "https://sample-vault.vault.azure.net/secrets/secret-name/77445834f7de41bab81d0723bf996860"
}
}
}
}
}
Loading