swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Operator API
schemes:
- https
tags:
- name: Operator
paths:
  /operatorconnect/operators:
    get:
      tags:
      - Operator
      x-ms-examples:
        GetOperators:
          $ref: ./examples/GetOperators.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      description: This endpoint gets a list of all operators
      summary: Microsoft Azure Get A List Of All Operators
      produces:
      - application/json
      operationId: microsoftAzureGetoperators
      parameters:
      - in: query
        name: skip
        description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0
        type: integer
        format: int32
        default: 0
      - in: query
        name: top
        description: An optional parameter for how many entries to return, for pagination purposes. The default will return the entire list.
        type: integer
        format: int32
      - in: query
        name: api-version
        description: Version of API
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ListOfOperators'
          headers:
            x-ms-request-id:
              type: string
              description: Microsoft request id used for tracing requests.
        default:
          description: Failure
          schema:
            $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
          headers:
            x-ms-error-code:
              type: string
              description: Error code
definitions:
  OperatorOffering:
    type: object
    properties:
      offerType:
        type: string
        description: The type of offer that operator is advertising
      availableCountries:
        type: array
        description: List of 2 character codes of available countries in ISO 3166-1 format
        items:
          type: string
  Operator:
    type: object
    properties:
      operatorId:
        type: string
        description: Unique GUID that represents the operator record
      friendlyName:
        type: string
        description: Public facing brand name of the operator
      landingPage:
        type: string
        description: URL of the Operator's Operator Connect offerings
      logoUri:
        type: string
        description: URL of the Operator's logo
      logoThumbnailUri:
        type: string
        description: URL of the Operator's thumbnail logo
      acquiredNumbersCount:
        type: integer
        description: Count of phone numbers acquired from the operator
      offerings:
        type: array
        items:
          $ref: '#/definitions/OperatorOffering'
    additionalProperties: false
  ListOfOperators:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Operator'
      nextLink:
        type: string
        description: Represents the URL link to the next page of operators.
    required:
    - value
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'