From acebd86e5e6c002e8b8d589040e3f2c975747186 Mon Sep 17 00:00:00 2001 From: Shubham Gupta Date: Mon, 19 Apr 2021 23:32:31 -0400 Subject: [PATCH] Fixing issue with missing filter documentation in Access Review APIs (#13892) --- .../authorization-AccessReviewCalls.json | 32 +++++++++++++++++++ ...ssReviewInstanceAssignedForMyApproval.json | 3 +- ...sReviewInstancesAssignedForMyApproval.json | 3 +- ...eduleDefinitionsAssignedForMyApproval.json | 3 +- .../authorization/resource-manager/readme.md | 6 ++++ 5 files changed, 44 insertions(+), 3 deletions(-) diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/authorization-AccessReviewCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/authorization-AccessReviewCalls.json index 49df2a165880..ec5721809f8d 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/authorization-AccessReviewCalls.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/authorization-AccessReviewCalls.json @@ -81,6 +81,9 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" } ], "responses": { @@ -301,6 +304,9 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" } ], "responses": { @@ -592,6 +598,9 @@ }, { "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" } ], "responses": { @@ -707,6 +716,9 @@ "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" } ], "responses": { @@ -750,6 +762,9 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" } ], "responses": { @@ -891,6 +906,9 @@ }, { "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AccessReviewsFilterParameter" } ], "responses": { @@ -1386,6 +1404,11 @@ "name": "AccessReviewScopePrincipalType", "modelAsString": true } + }, + "inactiveDuration": { + "type": "string", + "format": "duration", + "description": "Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" } }, "description": "Descriptor for what needs to be reviewed" @@ -1824,6 +1847,15 @@ "required": true, "type": "string", "description": "The API version to be used with the HTTP request." + }, + "AccessReviewsFilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Other than standard filters, one custom filter option is supported : 'assignedToMeToReview()'. When one specified $filter=assignedToMeToReview(), only items that are assigned to the calling user to review are returned", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" } } } diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstanceAssignedForMyApproval.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstanceAssignedForMyApproval.json index 21c7b4f65958..6a31c9a623a6 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstanceAssignedForMyApproval.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstanceAssignedForMyApproval.json @@ -2,7 +2,8 @@ "parameters": { "api-version": "2021-03-01-preview", "scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661", - "id": "4135f961-be78-4005-8101-c72a5af307a2" + "id": "4135f961-be78-4005-8101-c72a5af307a2", + "$filter": "assignedToMeToReview()" }, "responses": { "200": { diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstancesAssignedForMyApproval.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstancesAssignedForMyApproval.json index ecde1dabf322..106c6b99a13f 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstancesAssignedForMyApproval.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstancesAssignedForMyApproval.json @@ -1,7 +1,8 @@ { "parameters": { "api-version": "2021-03-01-preview", - "scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661" + "scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661", + "$filter": "assignedToMeToReview()" }, "responses": { "200": { diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json index e4225ed1bb8c..c45aa036bb0c 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json @@ -1,6 +1,7 @@ { "parameters": { - "api-version": "2021-03-01-preview" + "api-version": "2021-03-01-preview", + "$filter": "assignedToMeToReview()" }, "responses": { "200": { diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index 7609065927cc..26a9eb3a2360 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -82,6 +82,12 @@ directive: - suppress: XmsPathsMustOverloadPaths from: authorization-RoleDefinitionsCalls.json reason: x-ms-paths extension was previously required. Suppressing so that we don't have to make changes to existing APIs. + - suppress: AddedPropertyInResponse + from: authorization-AccessReviewCalls.json + reason: API documentation is not exposed yet. We're making some small changes before publishing documentation. + - suppress: AddingOptionalProperty + from: authorization-AccessReviewCalls.json + reason: API documentation is not exposed yet. We're making some small changes before publishing documentation. ``` ### Tag: package-2021-03-01-preview-only