Skip to content

Commit 5dd1107

Browse files
heathsheaths
authored
Remove redundant "rotate" from Keys API (#25714)
* Remove redundant "rotate" from Keys API Original goal was to properly document "Rotate" that Key Vault returned and "rotate" that Managed HSM returned (and was originally in the swagger), but that case-insensitively duplicative value caused issues with some code generators. Reverts parts of #24475 * Remove now-unnecessary exemptions * Fix description on Notify
1 parent 022b9c7 commit 5dd1107

File tree

16 files changed

+28
-111
lines changed

16 files changed

+28
-111
lines changed

‎specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.3-preview/keys.json‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2193,10 +2193,9 @@
21932193
"properties": {
21942194
"type": {
21952195
"type": "string",
2196-
"description": "The type of the action.",
2196+
"description": "The type of the action. The value should be compared case-insensitively.",
21972197
"enum": [
21982198
"Rotate",
2199-
"rotate",
22002199
"Notify"
22012200
],
22022201
"x-ms-enum": {
@@ -2205,11 +2204,7 @@
22052204
"values": [
22062205
{
22072206
"value": "Rotate",
2208-
"description": "Rotate the key based on the key policy. Key Vault only. Managed HSM uses camelCase 'rotate' instead."
2209-
},
2210-
{
2211-
"value": "rotate",
2212-
"description": "Rotate the key based on the key policy. Managed HSM only. Key Vault uses PascalCase 'Rotate' instead."
2207+
"description": "Rotate the key based on the key policy."
22132208
},
22142209
{
22152210
"value": "Notify",

‎specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2221,10 +2221,9 @@
22212221
"properties": {
22222222
"type": {
22232223
"type": "string",
2224-
"description": "The type of the action.",
2224+
"description": "The type of the action. The value should be compared case-insensitively.",
22252225
"enum": [
22262226
"Rotate",
2227-
"rotate",
22282227
"Notify"
22292228
],
22302229
"x-ms-enum": {
@@ -2233,11 +2232,7 @@
22332232
"values": [
22342233
{
22352234
"value": "Rotate",
2236-
"description": "Rotate the key based on the key policy. Key Vault only. Managed HSM uses camelCase 'rotate' instead."
2237-
},
2238-
{
2239-
"value": "rotate",
2240-
"description": "Rotate the key based on the key policy. Managed HSM only. Key Vault uses PascalCase 'Rotate' instead."
2235+
"description": "Rotate the key based on the key policy."
22412236
},
22422237
{
22432238
"value": "Notify",

‎specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.5-preview.1/keys.json‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2199,10 +2199,9 @@
21992199
"properties": {
22002200
"type": {
22012201
"type": "string",
2202-
"description": "The type of the action.",
2202+
"description": "The type of the action. The value should be compared case-insensitively.",
22032203
"enum": [
22042204
"Rotate",
2205-
"rotate",
22062205
"Notify"
22072206
],
22082207
"x-ms-enum": {
@@ -2211,11 +2210,7 @@
22112210
"values": [
22122211
{
22132212
"value": "Rotate",
2214-
"description": "Rotate the key based on the key policy. Key Vault only. Managed HSM uses camelCase 'rotate' instead."
2215-
},
2216-
{
2217-
"value": "rotate",
2218-
"description": "Rotate the key based on the key policy. Managed HSM only. Key Vault uses PascalCase 'Rotate' instead."
2213+
"description": "Rotate the key based on the key policy."
22192214
},
22202215
{
22212216
"value": "Notify",

‎specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.3/keys.json‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2194,10 +2194,9 @@
21942194
"properties": {
21952195
"type": {
21962196
"type": "string",
2197-
"description": "The type of the action.",
2197+
"description": "The type of the action. The value should be compared case-insensitively.",
21982198
"enum": [
21992199
"Rotate",
2200-
"rotate",
22012200
"Notify"
22022201
],
22032202
"x-ms-enum": {
@@ -2206,11 +2205,7 @@
22062205
"values": [
22072206
{
22082207
"value": "Rotate",
2209-
"description": "Rotate the key based on the key policy. Key Vault only. Managed HSM uses camelCase 'rotate' instead."
2210-
},
2211-
{
2212-
"value": "rotate",
2213-
"description": "Rotate the key based on the key policy. Managed HSM only. Key Vault uses PascalCase 'Rotate' instead."
2208+
"description": "Rotate the key based on the key policy."
22142209
},
22152210
{
22162211
"value": "Notify",

‎specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.4/keys.json‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2194,10 +2194,9 @@
21942194
"properties": {
21952195
"type": {
21962196
"type": "string",
2197-
"description": "The type of the action.",
2197+
"description": "The type of the action. The value should be compared case-insensitively.",
21982198
"enum": [
21992199
"Rotate",
2200-
"rotate",
22012200
"Notify"
22022201
],
22032202
"x-ms-enum": {
@@ -2206,11 +2205,7 @@
22062205
"values": [
22072206
{
22082207
"value": "Rotate",
2209-
"description": "Rotate the key based on the key policy. Key Vault only. Managed HSM uses camelCase 'rotate' instead."
2210-
},
2211-
{
2212-
"value": "rotate",
2213-
"description": "Rotate the key based on the key policy. Managed HSM only. Key Vault uses PascalCase 'Rotate' instead."
2208+
"description": "Rotate the key based on the key policy."
22142209
},
22152210
{
22162211
"value": "Notify",

‎specification/keyvault/data-plane/readme.md‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -496,10 +496,6 @@ directive:
496496
from: securitydomain.json
497497
where: $.definitions.TransferKey.properties.key_format
498498
reason: Consistency with other properties
499-
- suppress: EnumUniqueValue
500-
from: keys.json
501-
where: $.definitions.LifetimeActionsType.properties.type
502-
reason: SDK, docs workaround for current service behavior.
503499
- suppress: DOUBLE_FORWARD_SLASHES_IN_URL
504500
from: rbac.json
505501
reason: / is a valid scope in this scenario.

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-04-01-preview/keys.json‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -593,10 +593,9 @@
593593
"properties": {
594594
"type": {
595595
"type": "string",
596-
"description": "The type of the action.",
596+
"description": "The type of the action. The value should be compared case-insensitively.",
597597
"enum": [
598598
"Rotate",
599-
"rotate",
600599
"Notify"
601600
],
602601
"x-ms-enum": {
@@ -605,11 +604,7 @@
605604
"values": [
606605
{
607606
"value": "Rotate",
608-
"description": "Rotate the key based on the key policy. Key Vault only. Managed HSM uses camelCase 'rotate' instead."
609-
},
610-
{
611-
"value": "rotate",
612-
"description": "Rotate the key based on the key policy. Managed HSM only. Key Vault uses PascalCase 'Rotate' instead."
607+
"description": "Rotate the key based on the key policy."
613608
},
614609
{
615610
"value": "Notify",

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/keys.json‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -611,10 +611,9 @@
611611
"properties": {
612612
"type": {
613613
"type": "string",
614-
"description": "The type of the action.",
614+
"description": "The type of the action. The value should be compared case-insensitively.",
615615
"enum": [
616616
"Rotate",
617-
"rotate",
618617
"Notify"
619618
],
620619
"x-ms-enum": {
@@ -623,11 +622,7 @@
623622
"values": [
624623
{
625624
"value": "Rotate",
626-
"description": "Rotate the key based on the key policy. Key Vault only. Managed HSM uses camelCase 'rotate' instead."
627-
},
628-
{
629-
"value": "rotate",
630-
"description": "Rotate the key based on the key policy. Managed HSM only. Key Vault uses PascalCase 'Rotate' instead."
625+
"description": "Rotate the key based on the key policy."
631626
},
632627
{
633628
"value": "Notify",

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-11-01-preview/keys.json‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -611,10 +611,9 @@
611611
"properties": {
612612
"type": {
613613
"type": "string",
614-
"description": "The type of the action.",
614+
"description": "The type of the action. The value should be compared case-insensitively.",
615615
"enum": [
616616
"Rotate",
617-
"rotate",
618617
"Notify"
619618
],
620619
"x-ms-enum": {
@@ -623,11 +622,7 @@
623622
"values": [
624623
{
625624
"value": "Rotate",
626-
"description": "Rotate the key based on the key policy. Key Vault only. Managed HSM uses camelCase 'rotate' instead."
627-
},
628-
{
629-
"value": "rotate",
630-
"description": "Rotate the key based on the key policy. Managed HSM only. Key Vault uses PascalCase 'Rotate' instead."
625+
"description": "Rotate the key based on the key policy."
631626
},
632627
{
633628
"value": "Notify",

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2022-02-01-preview/keys.json‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -612,10 +612,9 @@
612612
"properties": {
613613
"type": {
614614
"type": "string",
615-
"description": "The type of the action.",
615+
"description": "The type of the action. The value should be compared case-insensitively.",
616616
"enum": [
617617
"Rotate",
618-
"rotate",
619618
"Notify"
620619
],
621620
"x-ms-enum": {
@@ -624,11 +623,7 @@
624623
"values": [
625624
{
626625
"value": "Rotate",
627-
"description": "Rotate the key based on the key policy. Key Vault only. Managed HSM uses camelCase 'rotate' instead."
628-
},
629-
{
630-
"value": "rotate",
631-
"description": "Rotate the key based on the key policy. Managed HSM only. Key Vault uses PascalCase 'Rotate' instead."
626+
"description": "Rotate the key based on the key policy."
632627
},
633628
{
634629
"value": "Notify",

0 commit comments

Comments
 (0)