Skip to content

Commit e8a989c

Browse files
Charan MVShiaga
Charan MVS
authored andcommitted
manual swagger fix
adding change to newer version ResourceGuardProxy APIs and example fixing parameter refs fixing refs incorrect ref fixes pattern for resourceGuardProxyName param semantic fixes
1 parent 8468620 commit e8a989c

File tree

6 files changed

+500
-0
lines changed

6 files changed

+500
-0
lines changed

specification/dataprotection/resource-manager/Microsoft.DataProtection/stable/2023-01-01/dataprotection.json

+358
Original file line numberDiff line numberDiff line change
@@ -3456,6 +3456,275 @@
34563456
}
34573457
}
34583458
}
3459+
},
3460+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies": {
3461+
"get": {
3462+
"tags": [
3463+
"DppResourceGuardProxies"
3464+
],
3465+
"operationId": "DppResourceGuardProxy_List",
3466+
"produces": [
3467+
"application/json"
3468+
],
3469+
"parameters": [
3470+
{
3471+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
3472+
},
3473+
{
3474+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
3475+
},
3476+
{
3477+
"$ref": "#/parameters/VaultName"
3478+
},
3479+
{
3480+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
3481+
}
3482+
],
3483+
"responses": {
3484+
"200": {
3485+
"description": "OK",
3486+
"schema": {
3487+
"$ref": "#/definitions/ResourceGuardProxyBaseResourceList"
3488+
}
3489+
},
3490+
"default": {
3491+
"description": "Error response describing why the operation failed.",
3492+
"schema": {
3493+
"$ref": "#/definitions/CloudError"
3494+
}
3495+
}
3496+
},
3497+
"x-ms-pageable": {
3498+
"nextLinkName": "nextLink"
3499+
},
3500+
"x-ms-examples": {
3501+
"Get ResourceGuardProxies": {
3502+
"$ref": "./examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json"
3503+
}
3504+
}
3505+
}
3506+
},
3507+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}": {
3508+
"get": {
3509+
"tags": [
3510+
"DppResourceGuardProxies"
3511+
],
3512+
"operationId": "DppResourceGuardProxy_Get",
3513+
"produces": [
3514+
"application/json"
3515+
],
3516+
"parameters": [
3517+
{
3518+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
3519+
},
3520+
{
3521+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
3522+
},
3523+
{
3524+
"$ref": "#/parameters/VaultName"
3525+
},
3526+
{
3527+
"name": "resourceGuardProxyName",
3528+
"description": "name of the resource guard proxy",
3529+
"in": "path",
3530+
"required": true,
3531+
"type": "string",
3532+
"pattern": "^[A-Za-z0-9]*$"
3533+
},
3534+
{
3535+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
3536+
}
3537+
],
3538+
"responses": {
3539+
"200": {
3540+
"description": "OK",
3541+
"schema": {
3542+
"$ref": "#/definitions/ResourceGuardProxyBaseResource"
3543+
}
3544+
},
3545+
"default": {
3546+
"description": "Error response describing why the operation failed.",
3547+
"schema": {
3548+
"$ref": "#/definitions/CloudError"
3549+
}
3550+
}
3551+
},
3552+
"x-ms-examples": {
3553+
"Get ResourceGuardProxy": {
3554+
"$ref": "./examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json"
3555+
}
3556+
}
3557+
},
3558+
"put": {
3559+
"tags": [
3560+
"DppResourceGuardProxies"
3561+
],
3562+
"operationId": "DppResourceGuardProxy_Put",
3563+
"produces": [
3564+
"application/json"
3565+
],
3566+
"parameters": [
3567+
{
3568+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
3569+
},
3570+
{
3571+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
3572+
},
3573+
{
3574+
"$ref": "#/parameters/VaultName"
3575+
},
3576+
{
3577+
"name": "resourceGuardProxyName",
3578+
"description": "name of the resource guard proxy",
3579+
"in": "path",
3580+
"required": true,
3581+
"type": "string",
3582+
"pattern": "^[A-Za-z0-9]*$"
3583+
},
3584+
{
3585+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
3586+
},
3587+
{
3588+
"name": "parameters",
3589+
"in": "body",
3590+
"description": "Request body for operation",
3591+
"required": true,
3592+
"schema": {
3593+
"$ref": "#/definitions/ResourceGuardProxyBaseResource"
3594+
}
3595+
}
3596+
],
3597+
"responses": {
3598+
"200": {
3599+
"description": "OK",
3600+
"schema": {
3601+
"$ref": "#/definitions/ResourceGuardProxyBaseResource"
3602+
}
3603+
},
3604+
"default": {
3605+
"description": "Error response describing why the operation failed.",
3606+
"schema": {
3607+
"$ref": "#/definitions/CloudError"
3608+
}
3609+
}
3610+
},
3611+
"x-ms-examples": {
3612+
"Create ResourceGuardProxy": {
3613+
"$ref": "./examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json"
3614+
}
3615+
}
3616+
},
3617+
"delete": {
3618+
"tags": [
3619+
"DppResourceGuardProxies"
3620+
],
3621+
"operationId": "DppResourceGuardProxy_Delete",
3622+
"produces": [
3623+
"application/json"
3624+
],
3625+
"parameters": [
3626+
{
3627+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
3628+
},
3629+
{
3630+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
3631+
},
3632+
{
3633+
"$ref": "#/parameters/VaultName"
3634+
},
3635+
{
3636+
"name": "resourceGuardProxyName",
3637+
"description": "name of the resource guard proxy",
3638+
"in": "path",
3639+
"required": true,
3640+
"type": "string",
3641+
"pattern": "^[A-Za-z0-9]*$"
3642+
},
3643+
{
3644+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
3645+
}
3646+
],
3647+
"responses": {
3648+
"200": {
3649+
"description": "OK"
3650+
},
3651+
"204": {
3652+
"description": "NoContent"
3653+
},
3654+
"default": {
3655+
"description": "Error response describing why the operation failed.",
3656+
"schema": {
3657+
"$ref": "#/definitions/CloudError"
3658+
}
3659+
}
3660+
},
3661+
"x-ms-examples": {
3662+
"Delete ResourceGuardProxy": {
3663+
"$ref": "./examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json"
3664+
}
3665+
}
3666+
}
3667+
},
3668+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete": {
3669+
"post": {
3670+
"tags": [
3671+
"DppResourceGuardProxies"
3672+
],
3673+
"operationId": "DppResourceGuardProxy_UnlockDelete",
3674+
"produces": [
3675+
"application/json"
3676+
],
3677+
"parameters": [
3678+
{
3679+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter"
3680+
},
3681+
{
3682+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter"
3683+
},
3684+
{
3685+
"$ref": "#/parameters/VaultName"
3686+
},
3687+
{
3688+
"name": "resourceGuardProxyName",
3689+
"description": "name of the resource guard proxy",
3690+
"in": "path",
3691+
"required": true,
3692+
"type": "string",
3693+
"pattern": "^[A-Za-z0-9]*$"
3694+
},
3695+
{
3696+
"$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter"
3697+
},
3698+
{
3699+
"name": "parameters",
3700+
"in": "body",
3701+
"description": "Request body for operation",
3702+
"required": true,
3703+
"schema": {
3704+
"$ref": "#/definitions/UnlockDeleteRequest"
3705+
}
3706+
}
3707+
],
3708+
"responses": {
3709+
"200": {
3710+
"description": "OK",
3711+
"schema": {
3712+
"$ref": "#/definitions/UnlockDeleteResponse"
3713+
}
3714+
},
3715+
"default": {
3716+
"description": "Error response describing why the operation failed.",
3717+
"schema": {
3718+
"$ref": "#/definitions/CloudError"
3719+
}
3720+
}
3721+
},
3722+
"x-ms-examples": {
3723+
"UnlockDelete ResourceGuardProxy": {
3724+
"$ref": "./examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json"
3725+
}
3726+
}
3727+
}
34593728
}
34603729
},
34613730
"definitions": {
@@ -6973,6 +7242,95 @@
69737242
}
69747243
}
69757244
}
7245+
},
7246+
"ResourceGuardOperationDetail": {
7247+
"type": "object",
7248+
"properties": {
7249+
"vaultCriticalOperation": {
7250+
"type": "string"
7251+
},
7252+
"defaultResourceRequest": {
7253+
"type": "string"
7254+
}
7255+
}
7256+
},
7257+
"ResourceGuardProxyBase": {
7258+
"type": "object",
7259+
"properties": {
7260+
"resourceGuardResourceId": {
7261+
"type": "string"
7262+
},
7263+
"resourceGuardOperationDetails": {
7264+
"type": "array",
7265+
"items": {
7266+
"$ref": "#/definitions/ResourceGuardOperationDetail"
7267+
},
7268+
"x-ms-identifiers": []
7269+
},
7270+
"lastUpdatedTime": {
7271+
"type": "string"
7272+
},
7273+
"description": {
7274+
"type": "string"
7275+
}
7276+
}
7277+
},
7278+
"ResourceGuardProxyBaseResource": {
7279+
"type": "object",
7280+
"allOf": [
7281+
{
7282+
"$ref": "#/definitions/DppResource"
7283+
}
7284+
],
7285+
"properties": {
7286+
"properties": {
7287+
"$ref": "#/definitions/ResourceGuardProxyBase",
7288+
"description": "ResourceGuardProxyBaseResource properties"
7289+
}
7290+
}
7291+
},
7292+
"ResourceGuardProxyBaseResourceList": {
7293+
"description": "List of ResourceGuardProxyBase resources",
7294+
"type": "object",
7295+
"allOf": [
7296+
{
7297+
"$ref": "#/definitions/DppResourceList"
7298+
}
7299+
],
7300+
"properties": {
7301+
"value": {
7302+
"description": "List of resources.",
7303+
"type": "array",
7304+
"items": {
7305+
"$ref": "#/definitions/ResourceGuardProxyBaseResource"
7306+
}
7307+
}
7308+
}
7309+
},
7310+
"UnlockDeleteRequest": {
7311+
"description": "Request body of unlock delete API.",
7312+
"type": "object",
7313+
"properties": {
7314+
"resourceGuardOperationRequests": {
7315+
"type": "array",
7316+
"items": {
7317+
"type": "string"
7318+
}
7319+
},
7320+
"resourceToBeDeleted": {
7321+
"type": "string"
7322+
}
7323+
}
7324+
},
7325+
"UnlockDeleteResponse": {
7326+
"description": "Response of Unlock Delete API.",
7327+
"type": "object",
7328+
"properties": {
7329+
"unlockDeleteExpiryTime": {
7330+
"description": "This is the time when unlock delete privileges will get expired.",
7331+
"type": "string"
7332+
}
7333+
}
69767334
}
69777335
},
69787336
"parameters": {
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7",
4+
"vaultName": "sampleVault",
5+
"resourceGroupName": "SampleResourceGroup",
6+
"resourceGuardProxyName": "swaggerExample",
7+
"api-version": "2023-01-01"
8+
},
9+
"responses": {
10+
"200": {},
11+
"204": {}
12+
}
13+
}

0 commit comments

Comments
 (0)