swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Hook API
schemes:
- https
tags:
- name: Hook
paths:
  /hooks:
    get:
      tags:
      - Hook
      summary: Microsoft Azure List All Hooks
      operationId: microsoftAzureListhooks
      produces:
      - application/json
      parameters:
      - in: query
        name: hookName
        description: filter hook by its name
        type: string
      - in: query
        name: $skip
        description: for paging, skipped number
        type: integer
        format: int32
      - in: query
        name: $maxpagesize
        description: the maximum number of items in one page
        type: integer
        format: int32
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/HookList'
        default:
          description: Client error or server error (4xx or 5xx)
          schema:
            $ref: '#/definitions/ErrorCode'
      x-ms-pageable:
        nextLinkName: '@nextLink'
      x-ms-examples:
        List all hooks:
          $ref: ./examples/listHooks.json
      description: Needs a more full description created.
    post:
      tags:
      - Hook
      summary: Microsoft Azure Create A New Hook
      operationId: microsoftAzureCreatehook
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: Create hook request
        required: true
        schema:
          $ref: '#/definitions/HookInfo'
      responses:
        '201':
          description: Success
          headers:
            Location:
              description: Location of the newly created resource.
              type: string
        default:
          description: Client error or server error (4xx or 5xx)
          schema:
            $ref: '#/definitions/ErrorCode'
      x-ms-examples:
        Create a new hook:
          $ref: ./examples/createHook.json
      description: Needs a more full description created.
  /hooks/{hookId}:
    get:
      tags:
      - Hook
      summary: Microsoft Azure Get A Hook By Its Id
      operationId: microsoftAzureGethook
      produces:
      - application/json
      parameters:
      - in: path
        name: hookId
        description: Hook unique ID
        required: true
        type: string
        format: uuid
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/HookInfo'
        default:
          description: Client error or server error (4xx or 5xx)
          schema:
            $ref: '#/definitions/ErrorCode'
      x-ms-examples:
        Get a hook by its id:
          $ref: ./examples/getHook.json
      description: Needs a more full description created.
    patch:
      tags:
      - Hook
      summary: Microsoft Azure Update A Hook
      operationId: microsoftAzureUpdatehook
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: hookId
        description: Hook unique ID
        required: true
        type: string
        format: uuid
      - in: body
        name: body
        description: Update hook request
        required: true
        schema:
          $ref: '#/definitions/HookInfoPatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/HookInfo'
        default:
          description: Client error or server error (4xx or 5xx)
          schema:
            $ref: '#/definitions/ErrorCode'
      x-ms-examples:
        Update a hook:
          $ref: ./examples/updateHook.json
      description: Needs a more full description created.
    delete:
      tags:
      - Hook
      summary: Microsoft Azure Delete A Hook
      operationId: microsoftAzureDeletehook
      produces:
      - application/json
      parameters:
      - in: path
        name: hookId
        description: Hook unique ID
        required: true
        type: string
        format: uuid
      responses:
        '204':
          description: The resource is deleted successfully or does not exist.
        default:
          description: Client error or server error (4xx or 5xx)
          schema:
            $ref: '#/definitions/ErrorCode'
      x-ms-examples:
        Delete a hook:
          $ref: ./examples/deleteHook.json
      description: Needs a more full description created.
definitions:
  HookInfoPatch:
    required:
    - hookType
    type: object
    properties:
      hookType:
        description: hook type
        enum:
        - Webhook
        - Email
        type: string
        x-ms-enum:
          name: HookType
          modelAsString: true
      hookName:
        description: hook unique name
        type: string
      description:
        description: hook description
        type: string
      externalLink:
        description: hook external link
        type: string
      admins:
        description: hook administrators
        uniqueItems: true
        type: array
        items:
          type: string
    discriminator: hookType
  HookInfo:
    required:
    - hookName
    - hookType
    type: object
    properties:
      hookType:
        description: hook type
        enum:
        - Webhook
        - Email
        type: string
        x-ms-enum:
          name: HookType
          modelAsString: true
      hookId:
        format: uuid
        description: Hook unique id
        type: string
        readOnly: true
      hookName:
        description: hook unique name
        type: string
      description:
        description: hook description
        default: ''
        type: string
      externalLink:
        description: hook external link
        default: ''
        type: string
      admins:
        description: hook administrators
        uniqueItems: true
        type: array
        items:
          type: string
    discriminator: hookType
  ErrorCode:
    type: object
    properties:
      message:
        type: string
      code:
        type: string
  HookList:
    type: object
    properties:
      '@nextLink':
        type: string
        readOnly: true
      value:
        uniqueItems: true
        type: array
        items:
          $ref: '#/definitions/HookInfo'
        readOnly: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'