Skip to content

Commit acebd86

Browse files
Fixing issue with missing filter documentation in Access Review APIs (#13892)
1 parent f09e7e0 commit acebd86

File tree

5 files changed

+44
-3
lines changed

5 files changed

+44
-3
lines changed

specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/authorization-AccessReviewCalls.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@
8181
},
8282
{
8383
"$ref": "#/parameters/SubscriptionIdParameter"
84+
},
85+
{
86+
"$ref": "#/parameters/AccessReviewsFilterParameter"
8487
}
8588
],
8689
"responses": {
@@ -301,6 +304,9 @@
301304
},
302305
{
303306
"$ref": "#/parameters/SubscriptionIdParameter"
307+
},
308+
{
309+
"$ref": "#/parameters/AccessReviewsFilterParameter"
304310
}
305311
],
306312
"responses": {
@@ -592,6 +598,9 @@
592598
},
593599
{
594600
"$ref": "#/parameters/SubscriptionIdParameter"
601+
},
602+
{
603+
"$ref": "#/parameters/AccessReviewsFilterParameter"
595604
}
596605
],
597606
"responses": {
@@ -707,6 +716,9 @@
707716
"parameters": [
708717
{
709718
"$ref": "#/parameters/ApiVersionParameter"
719+
},
720+
{
721+
"$ref": "#/parameters/AccessReviewsFilterParameter"
710722
}
711723
],
712724
"responses": {
@@ -750,6 +762,9 @@
750762
},
751763
{
752764
"$ref": "#/parameters/ApiVersionParameter"
765+
},
766+
{
767+
"$ref": "#/parameters/AccessReviewsFilterParameter"
753768
}
754769
],
755770
"responses": {
@@ -891,6 +906,9 @@
891906
},
892907
{
893908
"$ref": "#/parameters/ApiVersionParameter"
909+
},
910+
{
911+
"$ref": "#/parameters/AccessReviewsFilterParameter"
894912
}
895913
],
896914
"responses": {
@@ -1386,6 +1404,11 @@
13861404
"name": "AccessReviewScopePrincipalType",
13871405
"modelAsString": true
13881406
}
1407+
},
1408+
"inactiveDuration": {
1409+
"type": "string",
1410+
"format": "duration",
1411+
"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))"
13891412
}
13901413
},
13911414
"description": "Descriptor for what needs to be reviewed"
@@ -1824,6 +1847,15 @@
18241847
"required": true,
18251848
"type": "string",
18261849
"description": "The API version to be used with the HTTP request."
1850+
},
1851+
"AccessReviewsFilterParameter": {
1852+
"name": "$filter",
1853+
"in": "query",
1854+
"required": false,
1855+
"type": "string",
1856+
"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",
1857+
"x-ms-skip-url-encoding": true,
1858+
"x-ms-parameter-location": "method"
18271859
}
18281860
}
18291861
}

specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstanceAssignedForMyApproval.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"parameters": {
33
"api-version": "2021-03-01-preview",
44
"scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661",
5-
"id": "4135f961-be78-4005-8101-c72a5af307a2"
5+
"id": "4135f961-be78-4005-8101-c72a5af307a2",
6+
"$filter": "assignedToMeToReview()"
67
},
78
"responses": {
89
"200": {

specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewInstancesAssignedForMyApproval.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"parameters": {
33
"api-version": "2021-03-01-preview",
4-
"scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661"
4+
"scheduleDefinitionId": "488a6d0e-0a63-4946-86e3-1f5bbc934661",
5+
"$filter": "assignedToMeToReview()"
56
},
67
"responses": {
78
"200": {

specification/authorization/resource-manager/Microsoft.Authorization/preview/2021-03-01-preview/examples/GetAccessReviewScheduleDefinitionsAssignedForMyApproval.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"parameters": {
3-
"api-version": "2021-03-01-preview"
3+
"api-version": "2021-03-01-preview",
4+
"$filter": "assignedToMeToReview()"
45
},
56
"responses": {
67
"200": {

specification/authorization/resource-manager/readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,12 @@ directive:
8282
- suppress: XmsPathsMustOverloadPaths
8383
from: authorization-RoleDefinitionsCalls.json
8484
reason: x-ms-paths extension was previously required. Suppressing so that we don't have to make changes to existing APIs.
85+
- suppress: AddedPropertyInResponse
86+
from: authorization-AccessReviewCalls.json
87+
reason: API documentation is not exposed yet. We're making some small changes before publishing documentation.
88+
- suppress: AddingOptionalProperty
89+
from: authorization-AccessReviewCalls.json
90+
reason: API documentation is not exposed yet. We're making some small changes before publishing documentation.
8591
```
8692
8793
### Tag: package-2021-03-01-preview-only

0 commit comments

Comments
 (0)