Microsoft Azure App Configuration

swagger: '2.0'
info:
  version: 2022-11-01-preview
  title: Microsoft Azure Azure App Configuration
schemes:
  - https
paths:
  /keys:
    get:
      tags:
        - Keys
      summary: 'Microsoft Azure Gets A List Of Keys'
      operationId: microsoftAzureGetkeys
      consumes: []
      produces:
        - application/vnd.microsoft.appconfig.keyset+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'
      description: Needs a more full description created.
    head:
      tags:
        - Keys
      summary: 'Microsoft Azure Requests The Headers And Status Of The Given Resource'
      operationId: microsoftAzureCheckkeys
      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.
      x-ms-examples:
        CheckKeys:
          $ref: ./examples/CheckKeys.json
      description: Needs a more full description created.
  /kv:
    get:
      tags:
        - KeyValues
      summary: 'Microsoft Azure Gets A List Of Key Values'
      operationId: microsoftAzureGetkeyvalues
      consumes: []
      produces:
        - application/vnd.microsoft.appconfig.kvset+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
        - $ref: '#/parameters/KeyValueFields'
        - name: snapshot
          in: query
          description: >-
            A filter used get key-values for a snapshot. The value should be the
            name of the snapshot. Not valid when used with 'key' and 'label'
            filters.
          type: string
      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'
      description: Needs a more full description created.
    head:
      tags:
        - KeyValues
      summary: 'Microsoft Azure Requests The Headers And Status Of The Given Resource'
      operationId: microsoftAzureCheckkeyvalues
      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
        - $ref: '#/parameters/KeyValueFields'
        - name: snapshot
          in: query
          description: >-
            A filter used get key-values for a snapshot. Not valid when used
            with 'key' and 'label' filters.
          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.
      x-ms-examples:
        CheckKeyValues:
          $ref: ./examples/CheckKeyValues.json
      description: Needs a more full description created.
  /kv/{key}:
    get:
      tags:
        - KeyValues
      summary: 'Microsoft Azure Gets A Single Key Value'
      operationId: microsoftAzureGetkeyvalue
      consumes: []
      produces:
        - application/vnd.microsoft.appconfig.kv+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
        - $ref: '#/parameters/KeyValueFields'
      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:
        GetKeyValue:
          $ref: ./examples/GetKeyValue.json
        GetKeyValue_IfMatch:
          $ref: ./examples/GetKeyValue_IfMatch.json
        GetKeyValue_IfNoneMatch:
          $ref: ./examples/GetKeyValue_IfNoneMatch.json
      description: Needs a more full description created.
    put:
      tags:
        - KeyValues
      summary: 'Microsoft Azure Creates A Key Value'
      operationId: microsoftAzurePutkeyvalue
      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/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
      description: Needs a more full description created.
    delete:
      tags:
        - KeyValues
      summary: 'Microsoft Azure Deletes A Key Value'
      operationId: microsoftAzureDeletekeyvalue
      consumes: []
      produces:
        - application/vnd.microsoft.appconfig.kv+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
      description: Needs a more full description created.
    head:
      tags:
        - KeyValues
      summary: 'Microsoft Azure Requests The Headers And Status Of The Given Resource'
      operationId: microsoftAzureCheckkeyvalue
      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
        - $ref: '#/parameters/KeyValueFields'
      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
        default:
          description: Error response.
      x-ms-examples:
        CheckKeyValue:
          $ref: ./examples/CheckKeyValue.json
        CheckKeyValue_IfMatch:
          $ref: ./examples/CheckKeyValue_IfMatch.json
        CheckKeyValue_IfNoneMatch:
          $ref: ./examples/CheckKeyValue_IfNoneMatch.json
      description: Needs a more full description created.
  /snapshots:
    get:
      tags:
        - Snapshots
      summary: 'Microsoft Azure Gets A List Of Key Value Snapshots'
      operationId: microsoftAzureGetsnapshots
      consumes: []
      produces:
        - application/vnd.microsoft.appconfig.snapshotset+json
        - application/problem+json
      parameters:
        - name: name
          in: query
          description: A filter for the name of the returned snapshots.
          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
        - $ref: '#/parameters/SnapshotFields'
        - $ref: '#/parameters/Status'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SnapshotListResult'
          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:
        GetSnapshots:
          $ref: ./examples/GetSnapshots.json
      x-ms-pageable:
        itemName: items
        nextLinkName: '@nextLink'
      description: Needs a more full description created.
    head:
      tags:
        - Snapshots
      summary: 'Microsoft Azure Requests The Headers And Status Of The Given Resource'
      operationId: microsoftAzureChecksnapshots
      consumes: []
      produces: []
      parameters:
        - $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
      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.
      x-ms-examples:
        CheckSnapshots:
          $ref: ./examples/CheckSnapshots.json
      description: Needs a more full description created.
  /snapshots/{name}:
    get:
      tags:
        - Snapshots
      summary: 'Microsoft Azure Gets A Single Key Value Snapshot'
      operationId: microsoftAzureGetsnapshot
      consumes: []
      produces:
        - application/vnd.microsoft.appconfig.snapshot+json
        - application/problem+json
      parameters:
        - $ref: '#/parameters/SyncTokens'
        - $ref: '#/parameters/ApiVersion'
        - name: name
          in: path
          description: The name of the key-value snapshot to retrieve.
          required: true
          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
        - $ref: '#/parameters/SnapshotFields'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Snapshot'
          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
            Link:
              description: Includes links to related resources.
              type: string
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        GetSnapshot:
          $ref: ./examples/GetSnapshot.json
        GetSnapshot_IfMatch:
          $ref: ./examples/GetSnapshot_IfMatch.json
        GetSnapshot_IfNoneMatch:
          $ref: ./examples/GetSnapshot_IfNoneMatch.json
        GetSnapshot_Failed:
          $ref: ./examples/GetSnapshot_Failed.json
      description: Needs a more full description created.
    put:
      tags:
        - Snapshots
      summary: 'Microsoft Azure Creates A Key Value Snapshot'
      operationId: microsoftAzureCreatesnapshot
      consumes:
        - application/vnd.microsoft.appconfig.snapshot+json
        - application/json
      produces:
        - application/vnd.microsoft.appconfig.snapshot+json
        - application/problem+json
      parameters:
        - name: name
          in: path
          description: The name of the key-value snapshot to create.
          required: true
          type: string
          maxLength: 256
        - name: entity
          in: body
          description: The key-value snapshot to create.
          required: true
          schema:
            $ref: '#/definitions/Snapshot'
        - $ref: '#/parameters/SyncTokens'
        - $ref: '#/parameters/ApiVersion'
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/Snapshot'
          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
            Link:
              description: Includes links to related resources.
              type: string
            Operation-Location:
              description: The URL to track the status of the long running operation.
              type: string
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        CreateSnapshot:
          $ref: ./examples/CreateSnapshot.json
      x-ms-long-running-operation: true
      description: Needs a more full description created.
    patch:
      tags:
        - Snapshots
      summary: 'Microsoft Azure Updates The State Of A Key Value Snapshot'
      operationId: microsoftAzureUpdatesnapshot
      consumes:
        - application/json
      produces:
        - application/vnd.microsoft.appconfig.snapshot+json
        - application/problem+json
      parameters:
        - name: name
          in: path
          description: The name of the key-value snapshot to update.
          required: true
          type: string
        - name: entity
          in: body
          description: The parameters used to update the snapshot.
          required: true
          schema:
            $ref: '#/definitions/SnapshotUpdateParameters'
        - $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/Snapshot'
          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
            Link:
              description: Includes links to related resources.
              type: string
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/Error'
      x-ms-examples:
        UpdateSnapshot:
          $ref: ./examples/UpdateSnapshot.json
        UpdateSnapshot_IfMatch:
          $ref: ./examples/UpdateSnapshot_IfMatch.json
      description: Needs a more full description created.
    head:
      tags:
        - Snapshots
      summary: 'Microsoft Azure Requests The Headers And Status Of The Given Resource'
      operationId: microsoftAzureChecksnapshot
      consumes: []
      produces: []
      parameters:
        - name: name
          in: path
          description: The name of the key-value snapshot to check.
          required: true
          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
          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
            Link:
              description: Includes links to related resources.
              type: string
        default:
          description: Error response.
      x-ms-examples:
        CheckSnapshot:
          $ref: ./examples/CheckSnapshot.json
        CheckSnapshot_IfMatch:
          $ref: ./examples/CheckSnapshot_IfMatch.json
        CheckSnapshot_IfNoneMatch:
          $ref: ./examples/CheckSnapshot_IfNoneMatch.json
      description: Needs a more full description created.
  /labels:
    get:
      tags:
        - Labels
      summary: 'Microsoft Azure Gets A List Of Labels'
      operationId: microsoftAzureGetlabels
      consumes: []
      produces:
        - application/vnd.microsoft.appconfig.labelset+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
        - $ref: '#/parameters/LabelFields'
      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'
      description: Needs a more full description created.
    head:
      tags:
        - Labels
      summary: 'Microsoft Azure Requests The Headers And Status Of The Given Resource'
      operationId: microsoftAzureChecklabels
      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
        - $ref: '#/parameters/LabelFields'
      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.
      x-ms-examples:
        CheckLabels:
          $ref: ./examples/CheckLabels.json
      description: Needs a more full description created.
  /locks/{key}:
    put:
      tags:
        - Locks
      summary: 'Microsoft Azure Locks A Key Value'
      operationId: microsoftAzurePutlock
      consumes: []
      produces:
        - application/vnd.microsoft.appconfig.kv+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
      description: Needs a more full description created.
    delete:
      tags:
        - Locks
      summary: 'Microsoft Azure Unlocks A Key Value'
      operationId: microsoftAzureDeletelock
      consumes: []
      produces:
        - application/vnd.microsoft.appconfig.kv+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
 

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-app-configuration-openapi-original.yml