swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Locks API
schemes:
- https
tags:
- name: Locks
paths:
  /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
      - 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
      description: Needs a more full description created.
definitions:
  KeyValue:
    type: object
    properties:
      key:
        type: string
        description: The key of the key-value.
      label:
        type: string
        description: The label the key-value belongs to.
      content_type:
        type: string
        description: The content type of the value stored within the key-value.
      value:
        type: string
        description: The value of the key-value.
      last_modified:
        format: date-time
        type: string
        description: A date representing the last time the key-value was modified.
      tags:
        type: object
        additionalProperties:
          type: string
        description: The tags of the key-value
      locked:
        type: boolean
        description: Indicates whether the key-value is locked.
      etag:
        type: string
        description: A value representing the current state of the resource.
  Error:
    description: Azure App Configuration error object.
    type: 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
parameters:
  ApiVersion:
    name: api-version
    in: query
    description: The API version to be used with the HTTP request.
    required: true
    type: string
  SyncTokens:
    name: Sync-Token
    in: header
    description: Used to guarantee real-time consistency between requests.
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'