[AppConfig] Migrate App Configuration swagger to TypeSpec (#28634)

* initial commit + cleanup * add docs + cleanup linter warnings * add auth + update swagger * convert models to resources * update routes with standard ops + more accuracy * regenerate openapi * add examples * flavor: azure * tsp format * add spec examples * fix accept header + spec consistency * fix nextLink + headers * use encodedName * fix accept header * fix enums * format * move accept header * remove comment * format * spelling * test examples * fix examples * wip * content type header * fix delete content type + getlabels op * clean up * update suppression * add consumes * fix error * rename alias * alias sync token header * tsp compile * fix errors * improvements * more improvements * fix datetimes * client generation fixes * more clean up * add scope + request id headers * add service op template * improve template * client request id header * property type fix * tsp compile * client.tsp * tsp update --------- Co-authored-by: Catalina Peralta <[email protected]>
Azure · May 14, 2024 · 3531504 · 3531504
1 parent da326fe
commit 3531504
Show file tree

Hide file tree

Showing 84 changed files with 4,955 additions and 1,140 deletions.
diff --git a/specification/appconfiguration/AppConfiguration/client.tsp b/specification/appconfiguration/AppConfiguration/client.tsp
@@ -0,0 +1,9 @@
+import "./main.tsp";
+import "@azure-tools/typespec-client-generator-core";
+
+using Azure.ClientGenerator.Core;
+using AzureAppConfiguration;
+
+namespace SdkCustomizations;
+
+@@clientName(Error, "AppConfigError", "python");
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValue.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValue.json
@@ -0,0 +1,19 @@
+{
+  "operationId": "CheckKeyValue",
+  "title": "Requests the headers and status of the given resource.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "key": "Message"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kv+json",
+        "ETag": "W/\"7XpB48ET4VAlB9068ft6fKMyA3m\"",
+        "Last-Modified": "Tue, 27 Aug 2019 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763"
+      }
+    }
+  }
+}
diff --git a/...fication/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValue_IfMatch.json b/...fication/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValue_IfMatch.json
@@ -0,0 +1,20 @@
+{
+  "operationId": "CheckKeyValue",
+  "title": "Requests the headers and status of the given resource using the If-Match header.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "key": "Message",
+    "If-Match": "\"L10qpBghN693OaxydgTkLmrBbV5\""
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kv+json",
+        "ETag": "W/\"L10qpBghN693OaxydgTkLmrBbV5\"",
+        "Last-Modified": "Tue, 27 Aug 2019 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763"
+      }
+    }
+  }
+}
diff --git a/...tion/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValue_IfNoneMatch.json b/...tion/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValue_IfNoneMatch.json
@@ -0,0 +1,20 @@
+{
+  "operationId": "CheckKeyValue",
+  "title": "Requests the headers and status of the given resource using the If-None-Match header.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "key": "Message",
+    "If-None-Match": "L10qpBghN693OaxydgTkLmrBbV5"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kv+json",
+        "ETag": "W/\"7XpB48ET4VAlB9068ft6fKMyA3m\"",
+        "Last-Modified": "Tue, 27 Aug 2019 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763"
+      }
+    }
+  }
+}
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValues.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValues.json
@@ -0,0 +1,15 @@
+{
+  "operationId": "CheckKeyValues",
+  "title": "Requests the headers and status of the given resource.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kvset+json"
+      }
+    }
+  }
+}
diff --git a/...ication/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValues_IfMatch.json b/...ication/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValues_IfMatch.json
@@ -0,0 +1,17 @@
+{
+  "operationId": "CheckKeyValues",
+  "title": "Requests the headers and status of the given resource using the If-Match header.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "If-Match": "\"L10qpBghN693OaxydgTkLmrBbV5\""
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kvset+json",
+        "ETag": "W/\"L10qpBghN693OaxydgTkLmrBbV5\""
+      }
+    }
+  }
+}
diff --git a/...ion/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValues_IfNoneMatch.json b/...ion/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeyValues_IfNoneMatch.json
@@ -0,0 +1,17 @@
+{
+  "operationId": "CheckKeyValues",
+  "title": "Requests the headers and status of the given resource using the If-None-Match header.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "If-None-Match": "\"L10qpBghN693OaxydgTkLmrBbV5\""
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kvset+json",
+        "ETag": "W/\"7XpB48ET4VAlB9068ft6fKMyA3m\""
+      }
+    }
+  }
+}
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeys.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckKeys.json
@@ -0,0 +1,15 @@
+{
+  "operationId": "CheckKeys",
+  "title": "Check keys",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.keyset+json"
+      }
+    }
+  }
+}
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckLabels.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckLabels.json
@@ -0,0 +1,15 @@
+{
+  "operationId": "CheckLabels",
+  "title": "Requests the headers and status of the given resource.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.labelset+json"
+      }
+    }
+  }
+}
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckRevisions.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckRevisions.json
@@ -0,0 +1,15 @@
+{
+  "operationId": "CheckRevisions",
+  "title": "Requests the headers and status of the given resource.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kvset+json"
+      }
+    }
+  }
+}
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckSnapshot.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckSnapshot.json
@@ -0,0 +1,20 @@
+{
+  "operationId": "CheckSnapshot",
+  "title": "Requests the headers and status of the given resource.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "name": "Prod-2022-08-01"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.snapshot+json",
+        "ETag": "W/\"4f6dd610dd5e4deebc7fbaef685fb903\"",
+        "Last-Modified": "Tue, 01 Aug 2022 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763",
+        "Link": "</kv?snapshot=Prod-2022-08-01?api-version={api-ver}>; rel=\"items\""
+      }
+    }
+  }
+}
diff --git a/...fication/appconfiguration/AppConfiguration/examples/2023-11-01/CheckSnapshot_IfMatch.json b/...fication/appconfiguration/AppConfiguration/examples/2023-11-01/CheckSnapshot_IfMatch.json
@@ -0,0 +1,21 @@
+{
+  "operationId": "CheckSnapshot",
+  "title": "Requests the headers and status of the given resource using If-Match header.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "name": "Prod-2022-08-01",
+    "If-Match": "\"4f6dd610dd5e4deebc7fbaef685fb903\""
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.snapshot+json",
+        "ETag": "W/\"4f6dd610dd5e4deebc7fbaef685fb903\"",
+        "Last-Modified": "Tue, 01 Aug 2022 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763",
+        "Link": "</kv?snapshot=Prod-2022-08-01?api-version={api-ver}>; rel=\"items\""
+      }
+    }
+  }
+}
diff --git a/...tion/appconfiguration/AppConfiguration/examples/2023-11-01/CheckSnapshot_IfNoneMatch.json b/...tion/appconfiguration/AppConfiguration/examples/2023-11-01/CheckSnapshot_IfNoneMatch.json
@@ -0,0 +1,21 @@
+{
+  "operationId": "CheckSnapshot",
+  "title": "Requests the headers and status of the given resource using If-None-Match header",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "name": "Prod-2022-08-01",
+    "If-None-Match": "\"L10qpBghN693OaxydgTkLmrBbV5\""
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.snapshot+json",
+        "ETag": "W/\"4f6dd610dd5e4deebc7fbaef685fb903\"",
+        "Last-Modified": "Tue, 01 Aug 2022 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763",
+        "Link": "</kv?snapshot=Prod-2022-08-01?api-version={api-ver}>; rel=\"items\""
+      }
+    }
+  }
+}
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckSnapshots.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CheckSnapshots.json
@@ -0,0 +1,15 @@
+{
+  "operationId": "CheckSnapshots",
+  "title": "Requests the headers and status of the given resource.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.snapshotset+json"
+      }
+    }
+  }
+}
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CreateSnapshot.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/CreateSnapshot.json
@@ -0,0 +1,46 @@
+{
+  "operationId": "CreateSnapshot",
+  "title": "Creates a key-value snapshot.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "name": "Prod-2022-08-01",
+    "entity": {
+      "filters": [
+        {
+          "key": "app1/*",
+          "label": "Production"
+        }
+      ],
+      "retention_period": 3600
+    }
+  },
+  "responses": {
+    "201": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.snapshot+json",
+        "ETag": "W/\"4f6dd610dd5e4deebc7fbaef685fb903\"",
+        "Last-Modified": "Tue, 01 Aug 2022 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763",
+        "Operation-Location": "https://{exampleAppConfigurationName}.azconfig.io/operations?snapshot=Prod-2022-08-01&Api-Version=2023-11-01"
+      },
+      "body": {
+        "etag": "4f6dd610dd5e4deebc7fbaef685fb903",
+        "name": "Prod-2022-08-01",
+        "status": "provisioning",
+        "filters": [
+          {
+            "key": "app1/*",
+            "label": "Production"
+          }
+        ],
+        "composition_type": "all",
+        "created": "2022-08-01T22:19:40+00:00",
+        "size": 0,
+        "items_count": 0,
+        "retention_period": 3600,
+        "tags": {}
+      }
+    }
+  }
+}
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/DeleteKeyValue.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/DeleteKeyValue.json
@@ -0,0 +1,30 @@
+{
+  "operationId": "DeleteKeyValue",
+  "title": "Deletes a key-value.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "key": "Message"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kv+json",
+        "ETag": "W/\"7XpB48ET4VAlB9068ft6fKMyA3m\"",
+        "Last-Modified": "Tue, 27 Aug 2019 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763"
+      },
+      "body": {
+        "etag": "7XpB48ET4VAlB9068ft6fKMyA3m",
+        "key": "Message",
+        "label": null,
+        "content_type": null,
+        "value": "Hello World!",
+        "tags": {},
+        "locked": false,
+        "last_modified": "2019-08-27T16:52:32+00:00"
+      }
+    },
+    "204": {}
+  }
+}
diff --git a/...ication/appconfiguration/AppConfiguration/examples/2023-11-01/DeleteKeyValue_IfMatch.json b/...ication/appconfiguration/AppConfiguration/examples/2023-11-01/DeleteKeyValue_IfMatch.json
@@ -0,0 +1,31 @@
+{
+  "operationId": "DeleteKeyValue",
+  "title": "Deletes a key-value using If-Match header",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "key": "Message",
+    "If-Match": "\"L10qpBghN693OaxydgTkLmrBbV5\""
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kv+json",
+        "ETag": "W/\"L10qpBghN693OaxydgTkLmrBbV5\"",
+        "Last-Modified": "Tue, 27 Aug 2019 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763"
+      },
+      "body": {
+        "etag": "L10qpBghN693OaxydgTkLmrBbV5",
+        "key": "Message",
+        "label": null,
+        "content_type": null,
+        "value": "Hello World!",
+        "tags": {},
+        "locked": false,
+        "last_modified": "2019-08-27T16:52:32+00:00"
+      }
+    },
+    "204": {}
+  }
+}
diff --git a/specification/appconfiguration/AppConfiguration/examples/2023-11-01/DeleteLock.json b/specification/appconfiguration/AppConfiguration/examples/2023-11-01/DeleteLock.json
@@ -0,0 +1,29 @@
+{
+  "operationId": "DeleteLock",
+  "title": "Unlocks a key-value.",
+  "parameters": {
+    "endpoint": "https://{exampleAppConfigurationName}.azconfig.io",
+    "api-version": "2023-11-01",
+    "key": "Message"
+  },
+  "responses": {
+    "200": {
+      "headers": {
+        "Content-Type": "application/vnd.microsoft.appconfig.kv+json",
+        "ETag": "W/\"0BGYCoQ6iNdp5NtQ7N8shrobo6s\"",
+        "Last-Modified": "Tue, 27 Aug 2019 16:52:32 GMT",
+        "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763"
+      },
+      "body": {
+        "etag": "0BGYCoQ6iNdp5NtQ7N8shrobo6s",
+        "key": "Message",
+        "label": null,
+        "content_type": null,
+        "value": "Hello World!",
+        "tags": {},
+        "locked": false,
+        "last_modified": "2019-08-27T16:52:32+00:00"
+      }
+    }
+  }
+}