swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AcrRepository API
  description: ACR APIs related to repositories
schemes:
- https
tags:
- name: AcrRepository
  description: ACR APIs related to repositories
paths:
  /acr/v1/_catalog:
    get:
      tags:
      - AcrRepository
      description: List repositories
      operationId: microsoftAzureGetacrrepositories
      x-ms-examples:
        Get repositories in a registry:
          $ref: ./examples/GetRepositories.json
      parameters:
      - $ref: '#/parameters/QueryLast'
      - $ref: '#/parameters/QueryNum'
      responses:
        '200':
          description: Returns a list of repositories
          schema:
            $ref: '#/definitions/Repositories'
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Get Acr  Catalog
  /acr/v1/{name}:
    get:
      tags:
      - AcrRepository
      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
    delete:
      tags:
      - AcrRepository
      description: Delete the repository identified by `name`
      operationId: microsoftAzureDeleteacrrepository
      x-ms-examples:
        Delete a repository:
          $ref: ./examples/DeleteAcrRepository.json
      parameters:
      - $ref: '#/parameters/ImageName'
      responses:
        '202':
          description: The repository is deleted
          schema:
            $ref: '#/definitions/DeletedRepository'
        default:
          description: ACR error response describing why the operation failed.
          schema:
            $ref: '#/definitions/AcrErrors'
      summary: Microsoft Azure Delete Acr Name
    patch:
      tags:
      - AcrRepository
      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
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
  DeletedRepository:
    description: Deleted repository
    properties:
      manifestsDeleted:
        type: array
        description: SHA of the deleted image
        items:
          type: string
      tagsDeleted:
        type: array
        description: Tag of the deleted image
        items:
          type: string
  Repositories:
    description: List of repositories
    properties:
      repositories:
        type: array
        x-ms-client-name: Names
        description: Repository names
        items:
          type: string
    example:
      repositories:
      - production/alpine
      - testing/alpine
  AcrErrors:
    description: Acr error response describing why the operation failed
    properties:
      errors:
        type: array
        description: Array of detailed error
        items:
          $ref: '#/definitions/AcrErrorInfo'
  AcrErrorInfo:
    description: Error information
    properties:
      code:
        description: Error code
        type: string
      message:
        type: string
        description: Error message
      detail:
        type: object
        description: Error details
  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'
parameters:
  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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'