Skip to content

Commit 0a2c56e

Browse files
adarcekayousef
authored andcommitted
Clarify AKV's description for the maxresults parameter. (Azure#21697)
1 parent 9ea7351 commit 0a2c56e

32 files changed

+145
-145
lines changed

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@
298298
"format": "int32",
299299
"minimum": 1,
300300
"maximum": 25,
301-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
301+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
302302
},
303303
{
304304
"$ref": "#/parameters/ApiVersionParameter"
@@ -345,7 +345,7 @@
345345
"format": "int32",
346346
"minimum": 1,
347347
"maximum": 25,
348-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
348+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
349349
},
350350
{
351351
"$ref": "#/parameters/ApiVersionParameter"
@@ -825,7 +825,7 @@
825825
"format": "int32",
826826
"minimum": 1,
827827
"maximum": 25,
828-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
828+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
829829
},
830830
{
831831
"$ref": "#/parameters/ApiVersionParameter"
@@ -1185,7 +1185,7 @@
11851185
"format": "int32",
11861186
"minimum": 1,
11871187
"maximum": 25,
1188-
"description": "Maximum number of results to return in a page. If not specified, the service will return up to 25 results."
1188+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
11891189
},
11901190
{
11911191
"$ref": "#/parameters/ApiVersionParameter"
@@ -1239,7 +1239,7 @@
12391239
"format": "int32",
12401240
"minimum": 1,
12411241
"maximum": 25,
1242-
"description": "Maximum number of results to return in a page. If not specified, the service will return up to 25 results."
1242+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
12431243
},
12441244
{
12451245
"$ref": "#/parameters/ApiVersionParameter"
@@ -1286,7 +1286,7 @@
12861286
"format": "int32",
12871287
"minimum": 1,
12881288
"maximum": 25,
1289-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
1289+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
12901290
},
12911291
{
12921292
"$ref": "#/parameters/ApiVersionParameter"
@@ -1536,7 +1536,7 @@
15361536
"format": "int32",
15371537
"minimum": 1,
15381538
"maximum": 25,
1539-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
1539+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
15401540
},
15411541
{
15421542
"name": "includePending",
@@ -1738,7 +1738,7 @@
17381738
"format": "int32",
17391739
"minimum": 1,
17401740
"maximum": 25,
1741-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
1741+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
17421742
},
17431743
{
17441744
"$ref": "#/parameters/ApiVersionParameter"
@@ -2074,7 +2074,7 @@
20742074
"format": "int32",
20752075
"minimum": 1,
20762076
"maximum": 25,
2077-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
2077+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
20782078
},
20792079
{
20802080
"$ref": "#/parameters/ApiVersionParameter"
@@ -2579,7 +2579,7 @@
25792579
"format": "int32",
25802580
"minimum": 1,
25812581
"maximum": 25,
2582-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
2582+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
25832583
},
25842584
{
25852585
"name": "includePending",
@@ -2750,7 +2750,7 @@
27502750
"format": "int32",
27512751
"minimum": 1,
27522752
"maximum": 25,
2753-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
2753+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
27542754
},
27552755
{
27562756
"$ref": "#/parameters/ApiVersionParameter"
@@ -2797,7 +2797,7 @@
27972797
"format": "int32",
27982798
"minimum": 1,
27992799
"maximum": 25,
2800-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
2800+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
28012801
},
28022802
{
28032803
"$ref": "#/parameters/ApiVersionParameter"
@@ -3286,7 +3286,7 @@
32863286
"format": "int32",
32873287
"minimum": 1,
32883288
"maximum": 25,
3289-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
3289+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
32903290
},
32913291
{
32923292
"$ref": "#/parameters/ApiVersionParameter"
@@ -3341,7 +3341,7 @@
33413341
"format": "int32",
33423342
"minimum": 1,
33433343
"maximum": 25,
3344-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
3344+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
33453345
},
33463346
{
33473347
"$ref": "#/parameters/ApiVersionParameter"

specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/certificates.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"format": "int32",
4545
"minimum": 1,
4646
"maximum": 25,
47-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
47+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
4848
},
4949
{
5050
"name": "includePending",
@@ -246,7 +246,7 @@
246246
"format": "int32",
247247
"minimum": 1,
248248
"maximum": 25,
249-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
249+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
250250
},
251251
{
252252
"$ref": "#/parameters/ApiVersionParameter"
@@ -582,7 +582,7 @@
582582
"format": "int32",
583583
"minimum": 1,
584584
"maximum": 25,
585-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
585+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
586586
},
587587
{
588588
"$ref": "#/parameters/ApiVersionParameter"
@@ -1087,7 +1087,7 @@
10871087
"format": "int32",
10881088
"minimum": 1,
10891089
"maximum": 25,
1090-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
1090+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
10911091
},
10921092
{
10931093
"name": "includePending",

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@
298298
"format": "int32",
299299
"minimum": 1,
300300
"maximum": 25,
301-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
301+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
302302
},
303303
{
304304
"$ref": "#/parameters/ApiVersionParameter"
@@ -345,7 +345,7 @@
345345
"format": "int32",
346346
"minimum": 1,
347347
"maximum": 25,
348-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
348+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
349349
},
350350
{
351351
"$ref": "#/parameters/ApiVersionParameter"
@@ -825,7 +825,7 @@
825825
"format": "int32",
826826
"minimum": 1,
827827
"maximum": 25,
828-
"description": "Maximum number of results to return in a page. If not specified the service will return up to 25 results."
828+
"description": "Specifies the maximum number of results to return in a page. Setting maxresults to a value less than 1 or greater than 25 results in error response code 400 (Bad Request). If there are additional results to return, then the service returns a nextLink containing a skip token for pagination. In certain cases, the service might return fewer results than specified by maxresults (even 0 results) and also return a nextLink. Clients should not make any assumptions on the minimum number of results per page, and should enumerate all pages until the nextLink becomes null."
829829
},
830830
{
831831
"$ref": "#/parameters/ApiVersionParameter"

0 commit comments

Comments
 (0)