swagger: '2.0'
info:
  version: 2.0.0
  title: registries
host: localhost
basePath: /rest/admin/v2/
tags:
  - name: registries
paths:
  /registries:
    get:
      tags:
        - registries
      summary: Get all the registry names.
      description: Get all the registry names.
      operationId: getRegistry
      produces:
        - application/json
      parameters:
        - name: responseFormat
          in: query
          description: 'The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn''t specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn''t specified as well, the default response format shall be in json.'
          required: false
          type: string
      responses:
        '200':
          description: Get all the registry names.
  '/registries/{registryName}/refresh':
    post:
      tags:
        - registries
      summary: Regresh registry of a given registry name.
      description: Regresh registry of a given registry name.
      operationId: refreshRegistryByRegistryName
      produces:
        - application/json
      parameters:
        - name: registryName
          in: path
          description: The name of the registry to update.
          required: true
          type: string
        - name: responseFormat
          in: query
          description: 'The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn''t specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn''t specified as well, the default response format shall be in json.'
          required: false
          type: string
      responses:
        '200':
          description: A new broadcast job is added to the Commerce Scheduler that will execute the RefreshLocalRegistry command to refresh registry of a given registry name.  Job reference number of the broadcast job and job instance number are returned in response.
          schema:
            $ref: '#/definitions/Job'
  /registries/refresh:
    post:
      tags:
        - registries
      summary: Regresh all registries.
      description: Regresh registries.
      operationId: refreshRegistries
      produces:
        - application/json
      parameters:
        - name: responseFormat
          in: query
          description: 'The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn''t specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn''t specified as well, the default response format shall be in json.'
          required: false
          type: string
      responses:
        '200':
          description: A new broadcast job is added to the Commerce Scheduler that will execute the RefreshLocalRegistry command to refresh all registries.  Job reference number of the broadcast job and job instance number are returned in response.
          schema:
            $ref: '#/definitions/Job'
definitions:
  Job:
    type: object
    properties:
      jobId:
        type: integer
        format: int64
      jobInstanceId:
        type: integer
        format: int64
