diff --git a/custom-words.txt b/custom-words.txt index 196478d40f1e..321acfd59dec 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -88,6 +88,7 @@ apimusers apimversionsets apitoken APNS +appconfig appinsights applynetworkconfigurationupdates appservice @@ -745,8 +746,10 @@ kubeconfigs kubenet kubernetes kusto +kvset l'avion labaccounts +labelset labservices Lajolla largefacelists diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/appconfiguration.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/appconfiguration.json new file mode 100644 index 000000000000..e81498f64d44 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/appconfiguration.json @@ -0,0 +1,1347 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0", + "title": "Azure App Configuration" + }, + "schemes": [ + "https" + ], + "paths": { + "/keys": { + "get": { + "tags": [ + "Keys" + ], + "summary": "Gets a list of keys.", + "operationId": "GetKeys", + "consumes": [], + "produces": [ + "application/vnd.microsoft.appconfig.keyset+json", + "application/json", + "application/problem+json" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "A filter for the name of the returned keys.", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", + "type": "string" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KeyListResult" + }, + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "GetKeys": { + "$ref": "./examples/GetKeys.json" + } + }, + "x-ms-pageable": { + "itemName": "items", + "nextLinkName": "@nextLink" + } + }, + "head": { + "tags": [ + "Keys" + ], + "summary": "Requests the headers and status of the given resource.", + "operationId": "CheckKeys", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "A filter for the name of the returned keys.", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", + "type": "string" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed" + } + }, + "x-ms-examples": { + "CheckKeys": { + "$ref": "./examples/CheckKeys.json" + } + } + } + }, + "/kv": { + "get": { + "tags": [ + "KeyValues" + ], + "summary": "Gets a list of key-values.", + "operationId": "GetKeyValues", + "consumes": [], + "produces": [ + "application/vnd.microsoft.appconfig.kvset+json", + "application/json", + "application/problem+json" + ], + "parameters": [ + { + "name": "key", + "in": "query", + "description": "A filter used to match keys.", + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "A filter used to match labels", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", + "type": "string" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ] + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KeyValueListResult" + }, + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "GetKeyValues": { + "$ref": "./examples/GetKeyValues.json" + } + }, + "x-ms-pageable": { + "itemName": "items", + "nextLinkName": "@nextLink" + } + }, + "head": { + "tags": [ + "KeyValues" + ], + "summary": "Requests the headers and status of the given resource.", + "operationId": "CheckKeyValues", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "key", + "in": "query", + "description": "A filter used to match keys.", + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "A filter used to match labels", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", + "type": "string" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ] + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed" + } + }, + "x-ms-examples": { + "CheckKeyValues": { + "$ref": "./examples/CheckKeyValues.json" + } + } + } + }, + "/kv/{key}": { + "get": { + "tags": [ + "KeyValues" + ], + "summary": "Gets a single key-value.", + "operationId": "GetKeyValue", + "consumes": [], + "produces": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/json", + "application/problem+json" + ], + "parameters": [ + { + "name": "key", + "in": "path", + "description": "The key of the key-value to retrieve.", + "required": true, + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "The label of the key-value to retrieve.", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + }, + { + "name": "If-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", + "type": "string" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", + "type": "string" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ] + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KeyValue" + }, + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + }, + "ETag": { + "description": "An identifier representing the returned state of the resource.", + "type": "string" + }, + "Last-Modified": { + "description": "A UTC datetime that specifies the last time the resource was modified.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "GetKeyValue": { + "$ref": "./examples/GetKeyValue.json" + }, + "GetKeyValue_IfMatch": { + "$ref": "./examples/GetKeyValue_IfMatch.json" + }, + "GetKeyValue_IfNoneMatch": { + "$ref": "./examples/GetKeyValue_IfNoneMatch.json" + } + } + }, + "put": { + "tags": [ + "KeyValues" + ], + "summary": "Creates a key-value.", + "operationId": "PutKeyValue", + "consumes": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/vnd.microsoft.appconfig.kvset+json", + "application/json", + "text/json", + "application/*+json", + "application/json-patch+json" + ], + "produces": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/json", + "application/problem+json" + ], + "parameters": [ + { + "name": "key", + "in": "path", + "description": "The key of the key-value to create.", + "required": true, + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "The label of the key-value to create.", + "type": "string" + }, + { + "name": "entity", + "in": "body", + "description": "The key-value to create.", + "schema": { + "$ref": "#/definitions/KeyValue" + } + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "If-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", + "type": "string" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KeyValue" + }, + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + }, + "ETag": { + "description": "An identifier representing the returned state of the resource.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "PutKeyValue": { + "$ref": "./examples/PutKeyValue.json" + }, + "PutKeyValue_IfMatch": { + "$ref": "./examples/PutKeyValue_IfMatch.json" + } + } + }, + "delete": { + "tags": [ + "KeyValues" + ], + "summary": "Deletes a key-value.", + "operationId": "DeleteKeyValue", + "consumes": [], + "produces": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/json", + "application/problem+json" + ], + "parameters": [ + { + "name": "key", + "in": "path", + "description": "The key of the key-value to delete.", + "required": true, + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "The label of the key-value to delete.", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "If-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KeyValue" + }, + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + }, + "ETag": { + "description": "An identifier representing the returned state of the resource.", + "type": "string" + } + } + }, + "204": { + "description": "Success", + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "DeleteKeyValue": { + "$ref": "./examples/DeleteKeyValue.json" + }, + "DeleteKeyValue_IfMatch": { + "$ref": "./examples/DeleteKeyValue_IfMatch.json" + } + } + }, + "head": { + "tags": [ + "KeyValues" + ], + "summary": "Requests the headers and status of the given resource.", + "operationId": "CheckKeyValue", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "key", + "in": "path", + "description": "The key of the key-value to retrieve.", + "required": true, + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "The label of the key-value to retrieve.", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + }, + { + "name": "If-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", + "type": "string" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", + "type": "string" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ] + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + }, + "ETag": { + "description": "An identifier representing the returned state of the resource.", + "type": "string" + }, + "Last-Modified": { + "description": "A UTC datetime that specifies the last time the resource was modified.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed" + } + }, + "x-ms-examples": { + "CheckKeyValue": { + "$ref": "./examples/CheckKeyValue.json" + }, + "CheckKeyValue_IfMatch": { + "$ref": "./examples/CheckKeyValue_IfMatch.json" + }, + "CheckKeyValue_IfNoneMatch": { + "$ref": "./examples/CheckKeyValue_IfNoneMatch.json" + } + } + } + }, + "/labels": { + "get": { + "tags": [ + "Labels" + ], + "summary": "Gets a list of labels.", + "operationId": "GetLabels", + "consumes": [], + "produces": [ + "application/vnd.microsoft.appconfig.labelset+json", + "application/json", + "application/problem+json" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "A filter for the name of the returned labels.", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", + "type": "string" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "type": "array", + "items": { + "type": "string", + "enum": [ + "name" + ] + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LabelListResult" + }, + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "GetLabels": { + "$ref": "./examples/GetLabels.json" + } + }, + "x-ms-pageable": { + "itemName": "items", + "nextLinkName": "@nextLink" + } + }, + "head": { + "tags": [ + "Labels" + ], + "summary": "Requests the headers and status of the given resource.", + "operationId": "CheckLabels", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "A filter for the name of the returned labels.", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", + "type": "string" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "type": "array", + "items": { + "type": "string", + "enum": [ + "name" + ] + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed" + } + }, + "x-ms-examples": { + "CheckLabels": { + "$ref": "./examples/CheckLabels.json" + } + } + } + }, + "/locks/{key}": { + "put": { + "tags": [ + "Locks" + ], + "summary": "Locks a key-value.", + "operationId": "PutLock", + "consumes": [], + "produces": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/json", + "application/problem+json" + ], + "parameters": [ + { + "name": "key", + "in": "path", + "description": "The key of the key-value to lock.", + "required": true, + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "The label, if any, of the key-value to lock.", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "If-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", + "type": "string" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KeyValue" + }, + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + }, + "ETag": { + "description": "An identifier representing the returned state of the resource.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "PutLock": { + "$ref": "./examples/PutLock.json" + }, + "PutLock_IfMatch": { + "$ref": "./examples/PutLock_IfMatch.json" + } + } + }, + "delete": { + "tags": [ + "Locks" + ], + "summary": "Unlocks a key-value.", + "operationId": "DeleteLock", + "consumes": [], + "produces": [ + "application/vnd.microsoft.appconfig.kv+json", + "application/json", + "application/problem+json" + ], + "parameters": [ + { + "name": "key", + "in": "path", + "description": "The key of the key-value to unlock.", + "required": true, + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "The label, if any, of the key-value to unlock.", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "If-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag matches the value provided.", + "type": "string" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Used to perform an operation only if the targeted resource's etag does not match the value provided.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KeyValue" + }, + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + }, + "ETag": { + "description": "An identifier representing the returned state of the resource.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "DeleteLock": { + "$ref": "./examples/DeleteLock.json" + }, + "DeleteLock_IfMatch": { + "$ref": "./examples/DeleteLock_IfMatch.json" + } + } + } + }, + "/revisions": { + "get": { + "tags": [ + "Revisions" + ], + "summary": "Gets a list of key-value revisions.", + "operationId": "GetRevisions", + "consumes": [], + "produces": [ + "application/vnd.microsoft.appconfig.kvset+json", + "application/json", + "application/problem+json" + ], + "parameters": [ + { + "name": "key", + "in": "query", + "description": "A filter used to match keys.", + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "A filter used to match labels", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", + "type": "string" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ] + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/KeyValueListResult" + }, + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "GetRevisions": { + "$ref": "./examples/GetRevisions.json" + } + }, + "x-ms-pageable": { + "itemName": "items", + "nextLinkName": "@nextLink" + } + }, + "head": { + "tags": [ + "Revisions" + ], + "summary": "Requests the headers and status of the given resource.", + "operationId": "CheckRevisions", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "key", + "in": "query", + "description": "A filter used to match keys.", + "type": "string" + }, + { + "name": "label", + "in": "query", + "description": "A filter used to match labels", + "type": "string" + }, + { + "$ref": "#/parameters/SyncTokens" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "After", + "in": "query", + "description": "Instructs the server to return elements that appear after the element referred to by the specified token.", + "type": "string" + }, + { + "name": "Accept-Datetime", + "in": "header", + "description": "Requests the server to respond with the state of the resource at the specified time.", + "type": "string" + }, + { + "name": "$Select", + "in": "query", + "description": "Used to select what fields are present in the returned resource(s).", + "type": "array", + "items": { + "type": "string", + "enum": [ + "key", + "label", + "content_type", + "value", + "last_modified", + "tags", + "locked", + "etag" + ] + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "Sync-Token": { + "description": "Enables real-time consistency between requests by providing the returned value in the next request made to the server.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed" + } + }, + "x-ms-examples": { + "CheckRevisions": { + "$ref": "./examples/CheckRevisions.json" + } + } + } + } + }, + "definitions": { + "Key": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true + } + } + }, + "KeyValue": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "label": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "value": { + "type": "string" + }, + "last_modified": { + "format": "date-time", + "type": "string" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "locked": { + "type": "boolean" + }, + "etag": { + "type": "string" + } + } + }, + "Label": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true + } + } + }, + "Error": { + "description": "Azure App Configuration error object.", + "properties": { + "type": { + "description": "The type of the error.", + "type": "string" + }, + "title": { + "description": "A brief summary of the error.", + "type": "string" + }, + "name": { + "description": "The name of the parameter that resulted in the error.", + "type": "string" + }, + "detail": { + "description": "A detailed description of the error.", + "type": "string" + }, + "status": { + "description": "The HTTP status code that the error maps to.", + "type": "integer" + } + }, + "readOnly": true + }, + "KeyListResult": { + "description": "The result of a list request.", + "type": "object", + "properties": { + "items": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/Key" + } + }, + "@nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "KeyValueListResult": { + "description": "The result of a list request.", + "type": "object", + "properties": { + "items": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/KeyValue" + } + }, + "@nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "LabelListResult": { + "description": "The result of a list request.", + "type": "object", + "properties": { + "items": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/Label" + } + }, + "@nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + } + }, + "parameters": { + "SyncTokens": { + "name": "Sync-Token", + "in": "header", + "description": "Used to guarantee real-time consistency between requests.", + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "The API version to be used with the HTTP request.", + "required": true, + "type": "string" + }, + "Endpoint": { + "name": "endpoint", + "in": "path", + "description": "The endpoint of the App Configuration instance to send requests to.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValue.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValue.json new file mode 100644 index 000000000000..e4091585c90f --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValue.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValue_IfMatch.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValue_IfMatch.json new file mode 100644 index 000000000000..5869285ca89a --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValue_IfMatch.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValue_IfNoneMatch.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValue_IfNoneMatch.json new file mode 100644 index 000000000000..e1f38be05186 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValue_IfNoneMatch.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValues.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValues.json new file mode 100644 index 000000000000..cc1f7b790220 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeyValues.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.kvset+json" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeys.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeys.json new file mode 100644 index 000000000000..9e9508f43eba --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.keyset+json" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckLabels.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckLabels.json new file mode 100644 index 000000000000..3195f29dd2f0 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckLabels.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.labelset+json" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckRevisions.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckRevisions.json new file mode 100644 index 000000000000..cc1f7b790220 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/CheckRevisions.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.kvset+json" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteKeyValue.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteKeyValue.json new file mode 100644 index 000000000000..d454edcce5d3 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteKeyValue.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteKeyValue_IfMatch.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteKeyValue_IfMatch.json new file mode 100644 index 000000000000..826341d6130f --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteKeyValue_IfMatch.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteLock.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteLock.json new file mode 100644 index 000000000000..0a293666e22e --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteLock.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteLock_IfMatch.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteLock_IfMatch.json new file mode 100644 index 000000000000..61b904beae94 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/DeleteLock_IfMatch.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValue.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValue.json new file mode 100644 index 000000000000..216c6f2d47b5 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValue.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValue_IfMatch.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValue_IfMatch.json new file mode 100644 index 000000000000..61b904beae94 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValue_IfMatch.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValue_IfNoneMatch.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValue_IfNoneMatch.json new file mode 100644 index 000000000000..576887464fb4 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValue_IfNoneMatch.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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" + }, + "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" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValues.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValues.json new file mode 100644 index 000000000000..3d0cd3ab0c96 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeyValues.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.kvset+json" + }, + "body": { + "items": [ + { + "etag": "CTgHR5UrDKNj2nsoGWDOipST9Pv", + "key": "Background", + "label": "Asset1", + "content_type": null, + "value": "blue", + "tags": {}, + "locked": false, + "last_modified": "2019-03-04T17:12:23+00:00" + }, + { + "etag": "UTSN1zePHbBQ0npbRB6elGRRuH7", + "key": "MaxLogFiles", + "label": "Asset1", + "content_type": null, + "value": "50", + "tags": {}, + "locked": false, + "last_modified": "2019-03-04T17:12:23+00:00" + }, + { + "etag": "7XpB48ET4VAlB9068ft6fKMyA3m", + "key": "Message", + "label": null, + "content_type": null, + "value": "Hello World", + "tags": {}, + "locked": false, + "last_modified": "2019-06-20T16:52:23+00:00" + }, + { + "etag": "fAFm4jkGNB1hsIr4o0S5hnhCCvY", + "key": "WebDemo:Settings:BackgroundColor", + "label": null, + "content_type": null, + "value": "blue", + "tags": {}, + "locked": false, + "last_modified": "2019-06-20T15:48:01+00:00" + } + ] + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeys.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeys.json new file mode 100644 index 000000000000..ce3031487d22 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetKeys.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.keyset+json" + }, + "body": { + "items": [ + { + "name": "MaxRequests" + }, + { + "name": "RequestTimeout" + } + ] + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetLabels.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetLabels.json new file mode 100644 index 000000000000..1e0a2445a70d --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetLabels.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.labelset+json" + }, + "body": { + "items": [ + { + "name": null + }, + { + "name": "Asset1" + }, + { + "name": "Asset1/devCi" + }, + { + "name": "Asset1/devCi/branch1" + }, + { + "name": "WestUs" + } + ] + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetRevisions.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetRevisions.json new file mode 100644 index 000000000000..f4ca1ccf46ae --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/GetRevisions.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.kvset+json" + }, + "body": { + "items": [ + { + "etag": "0BGYCoQ6iNdp5NtQ7N8shrobo6s", + "key": "Message", + "label": null, + "content_type": null, + "value": "Hello World!", + "tags": {}, + "locked": false, + "last_modified": "2019-08-27T16:52:32+00:00" + }, + { + "etag": "L10qpBghN693OaxydgTkLmrBbV4", + "key": "Message", + "label": null, + "content_type": null, + "value": "A new message.", + "tags": {}, + "locked": false, + "last_modified": "2019-08-27T16:52:20+00:00" + }, + { + "etag": "tnIHBkDYQwtdNMLoWtr5aybkKwL", + "key": "Message", + "label": null, + "content_type": null, + "value": "Hello World!", + "tags": {}, + "locked": false, + "last_modified": "2019-08-27T16:50:47+00:00" + } + ] + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutKeyValue.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutKeyValue.json new file mode 100644 index 000000000000..83b231e011f3 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutKeyValue.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "key": "Message" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.kv+json", + "ETag": "W/\"tnIHBkDYQwtdNMLoWtr5aybkKwL\"", + "Last-Modified": "Tue, 27 Aug 2019 16:52:32 GMT", + "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763" + }, + "body": { + "etag": "tnIHBkDYQwtdNMLoWtr5aybkKwL", + "key": "Message", + "label": null, + "content_type": null, + "value": "Hello World!", + "tags": {}, + "locked": false, + "last_modified": "2019-08-27T16:52:32+00:00" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutKeyValue_IfMatch.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutKeyValue_IfMatch.json new file mode 100644 index 000000000000..61b904beae94 --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutKeyValue_IfMatch.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutLock.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutLock.json new file mode 100644 index 000000000000..20b2710f0a2d --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutLock.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "key": "Message" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/vnd.microsoft.appconfig.kv+json", + "ETag": "W/\"L10qpBghN693OaxydgTkLmrBbV4\"", + "Last-Modified": "Tue, 27 Aug 2019 16:52:32 GMT", + "Sync-Token": "zAJw6V16=NjotMSM3ODk3NjM=;sn=789763" + }, + "body": { + "etag": "L10qpBghN693OaxydgTkLmrBbV4", + "key": "Message", + "label": null, + "content_type": null, + "value": "Hello World!", + "tags": {}, + "locked": true, + "last_modified": "2019-08-27T16:52:32+00:00" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutLock_IfMatch.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutLock_IfMatch.json new file mode 100644 index 000000000000..2678730e0c6b --- /dev/null +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/stable/1.0/examples/PutLock_IfMatch.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "endpoint": "https://{exampleAppConfigurationName}.azconfig.io", + "api-version": "1.0", + "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": true, + "last_modified": "2019-08-27T16:52:32+00:00" + } + } + } +} diff --git a/specification/appconfiguration/data-plane/readme.md b/specification/appconfiguration/data-plane/readme.md new file mode 100644 index 000000000000..48be15cbfd9f --- /dev/null +++ b/specification/appconfiguration/data-plane/readme.md @@ -0,0 +1,84 @@ +# AppConfiguration + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for AppConfiguration. + +--- + +## Getting Started + +To build the SDK for AppConfiguration, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information + +These are the global settings for the AppConfiguration API. + +``` yaml +# common +openapi-type: data-plane +tag: package-1-0 +``` + +### Tag: package-2019-07 + +These settings apply only when `--tag=package-1-0` is specified on the command line. + +``` yaml $(tag) == 'package-1-0' +input-file: +- Microsoft.AppConfiguration/stable/1.0/appconfiguration.json +``` + +--- + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-net +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.AppConfiguration + sync-methods: None + output-folder: $(csharp-sdks-folder)/AppConfiguration/preview/Microsoft.Azure.AppConfiguration/src/Generated + clear-output-folder: true + add-credentials: true +``` +## Suppression + +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + from: appconfiguration.json + where: $.definitions.KeyValue.properties.content_type + reason: Existing property names. The service uses snake casing for json properties. + - suppress: DefinitionsPropertiesNamesCamelCase + from: appconfiguration.json + where: $.definitions.KeyValue.properties.last_modified + reason: Existing property names. The service uses snake casing for json properties. + - suppress: XmsParameterLocation + from: appconfiguration.json + where: $.parameters.SyncTokens + reason: The latest sync token should be used on every request. It is more proper to be globally stored per client rather than passed in for individual requests. +``` \ No newline at end of file