swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AcrMetadata API
schemes:
- https
tags:
- name: AcrMetadata
paths:
  /acr/v1/{name}:
    get:
      tags:
      - AcrMetadata
      description: Get repository attributes
      operationId: microsoftAzureGetacrrepositoryattributes
      x-ms-examples:
        Get details of repository:
          $ref: ./examples/GetAcrRepositoryAttributes.json
      parameters:
      - $ref: '#/parameters/ImageName'
      responses:
        '200':
          description: Returns a list of attributes
          schema:
            $ref: '#/definitions/RepositoryAttributes'
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Get Acr Name
    patch:
      tags:
      - AcrMetadata
      description: Update the attribute identified by `name` where `reference` is the name of the repository.
      operationId: microsoftAzureUpdateacrrepositoryattributes
      x-ms-examples:
        Update repository attributes:
          $ref: ./examples/UpdateAcrRepository.json
      consumes:
      - application/json
      parameters:
      - $ref: '#/parameters/ImageName'
      - name: value
        in: body
        description: Repository attribute value
        required: false
        schema:
          $ref: '#/definitions/ChangeableAttributes'
      responses:
        '200':
          description: The attributes is updated
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Patch Acr Name
  /acr/v1/{name}/_tags:
    get:
      tags:
      - AcrMetadata
      description: List tags of a repository
      operationId: microsoftAzureGetacrtags
      x-ms-examples:
        Get tags of a repository:
          $ref: ./examples/GetAcrTags.json
      parameters:
      - $ref: '#/parameters/ImageName'
      - $ref: '#/parameters/QueryLast'
      - $ref: '#/parameters/QueryNum'
      - $ref: '#/parameters/QueryOrderBy'
      - $ref: '#/parameters/QueryDigest'
      responses:
        '200':
          description: Tag details of a repository
          schema:
            $ref: '#/definitions/AcrRepositoryTags'
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Get Acr Name Tags
  /acr/v1/{name}/_tags/{reference}:
    get:
      tags:
      - AcrMetadata
      description: Get tag attributes by tag
      operationId: microsoftAzureGetacrtagattributes
      x-ms-examples:
        Get tag attributes:
          $ref: ./examples/GetAcrTagAttributes.json
      parameters:
      - $ref: '#/parameters/ImageName'
      - $ref: '#/parameters/ManifestReference'
      responses:
        '200':
          description: Tag attributes
          schema:
            $ref: '#/definitions/AcrTagAttributes'
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Get Acr Name Tags Reference
    patch:
      tags:
      - AcrMetadata
      description: Update tag attributes
      operationId: microsoftAzureUpdateacrtagattributes
      consumes:
      - application/json
      x-ms-examples:
        Update attributes of a manifest:
          $ref: ./examples/UpdateAcrTagAttributes.json
      parameters:
      - $ref: '#/parameters/ImageName'
      - $ref: '#/parameters/ManifestReference'
      - $ref: '#/parameters/RepoValue'
      responses:
        '200':
          description: The attributes are updated
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Patch Acr Name Tags Reference
    delete:
      tags:
      - AcrMetadata
      description: Delete tag
      operationId: microsoftAzureDeleteacrtag
      consumes:
      - application/json
      x-ms-examples:
        Update attributes of a manifest:
          $ref: ./examples/DeleteAcrTag.json
      parameters:
      - $ref: '#/parameters/ImageName'
      - $ref: '#/parameters/ManifestReference'
      responses:
        '202':
          description: The tag is deleted
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Delete Acr Name Tags Reference
  /acr/v1/{name}/_manifests:
    get:
      tags:
      - AcrMetadata
      description: List manifests of a repository
      operationId: microsoftAzureGetacrmanifests
      x-ms-examples:
        Get details of repository:
          $ref: ./examples/GetAcrManifests.json
      parameters:
      - $ref: '#/parameters/ImageName'
      - $ref: '#/parameters/QueryLast'
      - $ref: '#/parameters/QueryNum'
      - $ref: '#/parameters/QueryOrderBy'
      responses:
        '200':
          description: Returns a list of manifests
          schema:
            $ref: '#/definitions/AcrManifests'
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Get Acr Name Manifests
  /acr/v1/{name}/_manifests/{reference}:
    get:
      tags:
      - AcrMetadata
      description: Get manifest attributes
      operationId: microsoftAzureGetacrmanifestattributes
      x-ms-examples:
        Get manifest attributes:
          $ref: ./examples/GetAcrManifestAttributes.json
      parameters:
      - $ref: '#/parameters/ImageName'
      - $ref: '#/parameters/ImageReference'
      responses:
        '200':
          description: List of attributes
          schema:
            $ref: '#/definitions/AcrManifestAttributes'
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Get Acr Name Manifests Reference
    patch:
      tags:
      - AcrMetadata
      description: Update attributes of a manifest
      operationId: microsoftAzureUpdateacrmanifestattributes
      consumes:
      - application/json
      x-ms-examples:
        Update attributes of a manifest:
          $ref: ./examples/UpdateAcrManifestAttributes.json
      parameters:
      - $ref: '#/parameters/ImageName'
      - $ref: '#/parameters/ImageReference'
      - $ref: '#/parameters/RepoValue'
      responses:
        '200':
          description: The attributes are updated
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Patch Acr Name Manifests Reference
definitions:
  ChangeableAttributes:
    properties:
      deleteEnabled:
        type: boolean
        description: Delete enabled
      writeEnabled:
        type: boolean
        description: Write enabled
      listEnabled:
        type: boolean
        description: List enabled
      readEnabled:
        type: boolean
        description: Read enabled
    example:
      readEnabled: true
      listEnabled: true
      deleteEnabled: true
      writeEnabled: true
  AcrTagAttributesBase:
    description: Tag attribute details
    properties:
      name:
        type: string
        description: Tag name
      digest:
        type: string
        description: Tag digest
      createdTime:
        type: string
        description: Tag created time
      lastUpdateTime:
        type: string
        description: Tag last update time
      signed:
        type: boolean
        description: Is signed
      changeableAttributes:
        $ref: '#/definitions/ChangeableAttributes'
        description: Changeable attributes
    example:
      changeableAttributes:
        readEnabled: true
        listEnabled: true
        deleteEnabled: true
        writeEnabled: true
      name: tagname
      digest: sha256:0873c923e00e0fd2ba78041bfb64a105e1ecb7678916d1f7776311e45bf5634b
      createdTime: '2018-08-10T17:28:44.1082945Z'
      signed: true
      lastUpdateTime: '2018-08-10T17:28:44.1082945Z'
  AcrRepositoryTags:
    description: List of tag details
    properties:
      registry:
        type: string
        description: Registry name
      imageName:
        type: string
        description: Image name
      tags:
        type: array
        x-ms-client-name: TagsAttributes
        description: List of tag attribute details
        items:
          $ref: '#/definitions/AcrTagAttributesBase'
    example:
      registry: registry
      imageName: imageName
      tags:
      - changeableAttributes:
          readEnabled: true
          listEnabled: true
          deleteEnabled: true
          writeEnabled: true
        name: name
        digest: digest
        createdTime: createdTime
        signed: true
        lastUpdateTime: lastUpdateTime
      - changeableAttributes:
          readEnabled: true
          listEnabled: true
          deleteEnabled: true
          writeEnabled: true
        name: name
        digest: digest
        createdTime: createdTime
        signed: true
        lastUpdateTime: lastUpdateTime
  AcrTagAttributes:
    description: Tag attributes
    properties:
      registry:
        type: string
        description: Registry name
      imageName:
        type: string
        description: Image name
      tag:
        x-ms-client-name: TagAttributes
        description: List of tag attribute details
        $ref: '#/definitions/AcrTagAttributesBase'
    example:
      registry: registry
      imageName: imageName
      tag:
        changeableAttributes:
          readEnabled: true
          listEnabled: true
          deleteEnabled: true
          writeEnabled: true
        name: name
        digest: digest
        createdTime: createdTime
        signed: true
        lastUpdateTime: lastUpdateTime
  AcrManifestAttributesBase:
    type: object
    description: Manifest details
    properties:
      digest:
        type: string
        description: Manifest
      imageSize:
        type: integer
        description: Image size
      createdTime:
        type: string
        description: Created time
      lastUpdateTime:
        type: string
        description: Last update time
      architecture:
        type: string
        description: CPU architecture
      os:
        type: string
        description: Operating system
      mediaType:
        type: string
        description: Media type
      configMediaType:
        type: string
        description: Config blob media type
      tags:
        type: array
        description: List of tags
        items:
          type: string
          description: Tag name
      changeableAttributes:
        $ref: '#/definitions/ChangeableAttributes'
        description: Changeable attributes
    example:
      changeableAttributes:
        readEnabled: true
        listEnabled: true
        deleteEnabled: true
        writeEnabled: true
      os: os
      digest: digest
      imageSize: 2401606
      createdTime: createdTime
      mediaType: mediaType
      configMediaType: configMediaType
      lastUpdateTime: lastUpdateTime
      architecture: architecture
      tags:
      - tags
      - tags
  RepositoryAttributes:
    type: object
    description: Repository attributes
    properties:
      registry:
        type: string
        description: Registry name
      imageName:
        type: string
        description: Image name
      createdTime:
        type: string
        description: Image created time
      lastUpdateTime:
        type: string
        description: Image last update time
      manifestCount:
        type: integer
        description: Number of the manifests
      tagCount:
        type: integer
        description: Number of the tags
      changeableAttributes:
        description: Changeable attributes
        $ref: '#/definitions/ChangeableAttributes'
    example:
      registry: registryname.azurecr.io
      changeableAttributes:
        readEnabled: true
        listEnabled: true
        deleteEnabled: true
        writeEnabled: true
      imageName: imageName
      createdTime: '2018-09-07T16:30:46.6583219Z'
      tagCount: 6
      manifestCount: 2
      lastUpdateTime: '2018-09-07T16:30:46.6583219Z'
  AcrErrors:
    description: Acr error response describing why the operation failed
    properties:
      errors:
        type: array
        description: Array of detailed error
        items:
          $ref: '#/definitions/AcrErrorInfo'
  AcrManifestAttributes:
    description: Manifest attributes details
    properties:
      registry:
        description: Registry name
        type: string
      imageName:
        description: Image name
        type: string
      manifest:
        x-ms-client-name: ManifestAttributes
        description: Manifest attributes
        $ref: '#/definitions/AcrManifestAttributesBase'
    example:
      registry: acrapi.azurecr-test.io
      imageName: nanoserver
      manifest:
        digest: sha256:110d2b6c84592561338aa040b1b14b7ab81c2f9edbd564c2285dd7d70d777086
        imageSize: 2401606
        createdTime: '2018-09-06T06:17:20.9983915Z'
        lastUpdateTime: '2018-09-06T06:17:20.9983915Z'
        architecture: amd64
        os: windows
        mediaType: application/vnd.docker.distribution.manifest.v2+json
        configMediaType: application/vnd.docker.container.image.v1+json
        tags:
        - 4.7.2-20180905-nanoserver-1803
        changeableAttributes:
          deleteEnabled: true
          writeEnabled: true
          readEnabled: true
          listEnabled: true
  AcrManifests:
    description: Manifest attributes
    properties:
      registry:
        type: string
        description: Registry name
      imageName:
        type: string
        description: Image name
      manifests:
        x-ms-client-name: ManifestsAttributes
        type: array
        description: List of manifests
        items:
          $ref: '#/definitions/AcrManifestAttributesBase'
          description: Manifest details
    example:
      registry: registry
      imageName: imageName
      manifests:
      - changeableAttributes:
          quarantineDetails: quarantineDetails
          readEnabled: true
          quarantineState: quarantineState
          listEnabled: true
          deleteEnabled: true
          writeEnabled: true
        os: os
        digest: digest
        imageSize: 2401606
        createdTime: createdTime
        mediaType: mediaType
        configMediaType: configMediaType
        lastUpdateTime: lastUpdateTime
        architecture: architecture
        tags:
        - tags
        - tags
      - changeableAttributes:
          quarantineDetails: quarantineDetails
          readEnabled: true
          quarantineState: quarantineState
          listEnabled: true
          deleteEnabled: true
          writeEnabled: true
        os: os
        digest: digest
        imageSize: 2401606
        createdTime: createdTime
        mediaType: mediaType
        configMediaType: configMediaType
        lastUpdateTime: lastUpdateTime
        architecture: architecture
        tags:
        - tags
        - tags
  AcrErrorInfo:
    description: Error information
    properties:
      code:
        description: Error code
        type: string
      message:
        type: string
        description: Error message
      detail:
        type: object
        description: Error details
parameters:
  RepoValue:
    name: value
    in: body
    description: Repository attribute value
    required: false
    schema:
      $ref: '#/definitions/ChangeableAttributes'
    x-ms-parameter-location: method
  ManifestReference:
    name: reference
    in: path
    description: Tag or digest of the target manifest
    required: true
    type: string
    x-ms-parameter-location: method
  ImageName:
    name: name
    in: path
    description: Name of the image (including the namespace)
    required: true
    type: string
    x-ms-parameter-location: method
  QueryLast:
    name: last
    in: query
    description: Query parameter for the last item in previous query. Result set will include values lexically after last.
    required: false
    type: string
    x-ms-parameter-location: method
  QueryNum:
    name: n
    in: query
    description: query parameter for max number of items
    required: false
    type: integer
    x-ms-parameter-location: method
  ImageReference:
    name: reference
    in: path
    description: A tag or a digest, pointing to a specific image
    required: true
    type: string
    x-ms-parameter-location: method
  QueryOrderBy:
    name: orderby
    in: query
    description: orderby query parameter
    required: false
    type: string
    x-ms-parameter-location: method
  QueryDigest:
    name: digest
    in: query
    description: filter by digest
    required: false
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'