Skip to content

Commit f060ba3

Browse files
poshettRheaHooda23
andauthored
Updating response objects of Provider level APIs (Pure Proxy RTs) (#23650)
* Updating UserApiKeyResponse and ElasticVersionsListResponse for properties * Updating UserApiKeyResponse * Updating ElasticVersionsListResponse * Fixing PrettierCheck * Fixing PrettierCheck from ElasticVersionsListResponseProperties * Adding x-ms-pageable in elasticVersions * Adding nextLink in ElasticVersionsListResponse * Removing nextLink from ElasticVersionsListResponseProperties * updated response for elasticVersions API * prettier fix * prettier fix elasticversions_list * Added description to ElasticVersionsListResponse * added description to all objects --------- Co-authored-by: Rhea Hooda <[email protected]>
1 parent db124c9 commit f060ba3

File tree

3 files changed

+40
-6
lines changed

3 files changed

+40
-6
lines changed

specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-02-01-preview/elastic.json

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,9 @@
146146
}
147147
}
148148
},
149+
"x-ms-pageable": {
150+
"nextLinkName": "nextLink"
151+
},
149152
"x-ms-examples": {
150153
"ElasticVersions_List": {
151154
"$ref": "./examples/ElasticVersions_List.json"
@@ -2005,6 +2008,25 @@
20052008
}
20062009
}
20072010
},
2011+
"ElasticVersionListFormat": {
2012+
"description": "Elastic Version List Format",
2013+
"type": "object",
2014+
"properties": {
2015+
"properties": {
2016+
"$ref": "#/definitions/ElasticVersionListProperties"
2017+
}
2018+
}
2019+
},
2020+
"ElasticVersionListProperties": {
2021+
"description": "Elastic Version Properties",
2022+
"type": "object",
2023+
"properties": {
2024+
"version": {
2025+
"description": "Available elastic version of the given region",
2026+
"type": "string"
2027+
}
2028+
}
2029+
},
20082030
"ElasticVersionsListResponse": {
20092031
"description": "List of elastic versions available in a region.",
20102032
"type": "object",
@@ -2013,7 +2035,7 @@
20132035
"description": "Results of a list operation.",
20142036
"type": "array",
20152037
"items": {
2016-
"type": "string"
2038+
"$ref": "#/definitions/ElasticVersionListFormat"
20172039
}
20182040
},
20192041
"nextLink": {
@@ -2422,11 +2444,19 @@
24222444
},
24232445
"UserApiKeyResponse": {
24242446
"description": "The User Api Key created for the Organization associated with the User Email Id that was passed in the request",
2447+
"type": "object",
2448+
"properties": {
2449+
"properties": {
2450+
"$ref": "#/definitions/UserApiKeyResponseProperties"
2451+
}
2452+
}
2453+
},
2454+
"UserApiKeyResponseProperties": {
24252455
"type": "object",
24262456
"properties": {
24272457
"apiKey": {
2458+
"description": "The User Api Key Generated based on GenerateApiKey flag. This is applicable for non-Portal clients only.",
24282459
"type": "string",
2429-
"description": "The User Api Key Generated based on ReturnApiKey flag. This is applicable for non-Portal clients only.",
24302460
"x-ms-secret": true
24312461
}
24322462
}

specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-02-01-preview/examples/ElasticVersions_List.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@
88
"200": {
99
"body": {
1010
"value": [
11-
"version1",
12-
"version2",
13-
"version3"
11+
{
12+
"properties": {
13+
"version": "version1"
14+
}
15+
}
1416
]
1517
}
1618
}

specification/elastic/resource-manager/Microsoft.Elastic/preview/2023-02-01-preview/examples/Organizations_GetApiKey.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
"responses": {
1010
"200": {
1111
"body": {
12-
"apiKey": "AbCdEfGhIjKlMnOpQrStUvWxYz"
12+
"properties": {
13+
"apiKey": "AbCdEfGhIjKlMnOpQrStUvWxYz"
14+
}
1315
}
1416
}
1517
}

0 commit comments

Comments
 (0)