Skip to content

Commit 1849597

Browse files
HarshaNallurudeyaaeldeenjimmyca15
authored andcommitted
Update appconfiguration.json to include the "operations" path (Azure#23125)
* Update appconfiguration.json * Update specification/appconfiguration/data-plane/Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json * Update specification/appconfiguration/data-plane/Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json Co-authored-by: Deyaaeldeen Almahallawi <[email protected]> * Update specification/appconfiguration/data-plane/Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json * Update appconfiguration.json - Deya feedback * example GetOperationStatus * Update specification/appconfiguration/data-plane/Microsoft.AppConfiguration/preview/2022-11-01-preview/examples/GetOperationStatus.json Co-authored-by: Deyaaeldeen Almahallawi <[email protected]> * Updates to descriptions, names, id format. * Update operation status to use error detail as defined by Azure REST API guidelines. * Prettier fixes. * dummy commit for CI --------- Co-authored-by: Deyaaeldeen Almahallawi <[email protected]> Co-authored-by: Jimmy Campbell <[email protected]>
1 parent 4f6cd05 commit 1849597

File tree

2 files changed

+142
-0
lines changed

2 files changed

+142
-0
lines changed

specification/appconfiguration/data-plane/Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1482,6 +1482,50 @@
14821482
}
14831483
}
14841484
}
1485+
},
1486+
"/operations": {
1487+
"get": {
1488+
"tags": [
1489+
"Operations"
1490+
],
1491+
"summary": "Gets the state of a long running operation.",
1492+
"operationId": "GetOperationDetails",
1493+
"consumes": [],
1494+
"produces": [
1495+
"application/json"
1496+
],
1497+
"parameters": [
1498+
{
1499+
"$ref": "#/parameters/ApiVersion"
1500+
},
1501+
{
1502+
"name": "snapshot",
1503+
"in": "query",
1504+
"description": "Snapshot identifier for the long running operation.",
1505+
"required": true,
1506+
"type": "string"
1507+
}
1508+
],
1509+
"responses": {
1510+
"200": {
1511+
"description": "Success",
1512+
"schema": {
1513+
"$ref": "#/definitions/OperationDetails"
1514+
}
1515+
},
1516+
"default": {
1517+
"description": "Error response describing why the operation failed",
1518+
"schema": {
1519+
"$ref": "#/definitions/Error"
1520+
}
1521+
}
1522+
},
1523+
"x-ms-examples": {
1524+
"GetOperationStatus": {
1525+
"$ref": "./examples/GetOperationStatus.json"
1526+
}
1527+
}
1528+
}
14851529
}
14861530
},
14871531
"definitions": {
@@ -1723,6 +1767,82 @@
17231767
},
17241768
"readOnly": true
17251769
},
1770+
"OperationDetails": {
1771+
"description": "Details of a long running operation.",
1772+
"type": "object",
1773+
"properties": {
1774+
"id": {
1775+
"description": "The unique id of the operation.",
1776+
"type": "string"
1777+
},
1778+
"status": {
1779+
"description": "The current status of the operation",
1780+
"enum": [
1781+
"NotStarted",
1782+
"Running",
1783+
"Succeeded",
1784+
"Failed",
1785+
"Canceled"
1786+
],
1787+
"type": "string",
1788+
"x-ms-enum": {
1789+
"modelAsString": false,
1790+
"name": "State"
1791+
}
1792+
},
1793+
"error": {
1794+
"description": "An error, available when the status is `Failed`, describing why the operation failed.",
1795+
"$ref": "#/definitions/ErrorDetail"
1796+
}
1797+
},
1798+
"required": [
1799+
"id",
1800+
"status"
1801+
]
1802+
},
1803+
"ErrorDetail": {
1804+
"description": "The details of an error.",
1805+
"type": "object",
1806+
"properties": {
1807+
"code": {
1808+
"description": "One of a server-defined set of error codes.",
1809+
"type": "string"
1810+
},
1811+
"message": {
1812+
"description": "A human-readable representation of the error.",
1813+
"type": "string"
1814+
},
1815+
"details": {
1816+
"description": "An array of details about specific errors that led to this reported error.",
1817+
"type": "array",
1818+
"items": {
1819+
"$ref": "#/definitions/ErrorDetail"
1820+
}
1821+
},
1822+
"innererror": {
1823+
"description": "An object containing more specific information than the current object about the error.",
1824+
"$ref": "#/definitions/InnerError"
1825+
}
1826+
},
1827+
"required": [
1828+
"code",
1829+
"message"
1830+
]
1831+
},
1832+
"InnerError": {
1833+
"description": "An object containing specific information about an error.",
1834+
"type": "object",
1835+
"properties": {
1836+
"code": {
1837+
"description": "One of a server-defined set of error codes.",
1838+
"type": "string"
1839+
},
1840+
"innererror": {
1841+
"description": "An object containing more specific information than the current object about the error.",
1842+
"$ref": "#/definitions/InnerError"
1843+
}
1844+
}
1845+
},
17261846
"KeyListResult": {
17271847
"description": "The result of a list request.",
17281848
"type": "object",
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"parameters": {
3+
"endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
4+
"api-version": "2022-11-01-preview",
5+
"snapshot": "Prod-2022-08-01"
6+
},
7+
"responses": {
8+
"200": {
9+
"headers": {
10+
"Content-Type": "application/json; charset=utf-8",
11+
"Date": "Thu, 16 Mar 2023 23:14:44 GMT",
12+
"Retry-After": "10",
13+
"Sync-Token": "zAJw6V16=MDotMSMyNzM2OTA=;sn=273690"
14+
},
15+
"body": {
16+
"id": "4yghgV_8lJJ5t7_kxhMpsyNCyjmZE5Q6zU0pXOp7Jvs",
17+
"status": "Running",
18+
"error": null
19+
}
20+
}
21+
}
22+
}

0 commit comments

Comments
 (0)