swag-payments/spec/paths/processing@webhooks.yaml

post:
  description: Установить новый webhook.
  tags:
    - Webhooks
  operationId: createWebhook
  parameters:
    - $ref: '#/parameters/requestID'
    - $ref: '#/parameters/deadline'
    - name: webhookParams
      description: Параметры устанавливаемого webhook'а
      in: body
      required: true
      schema:
        $ref: '#/definitions/Webhook'
  responses:
    '201':
      description: Webhook установлен
      schema:
        $ref: '#/definitions/Webhook'
    '401':
      $ref: '#/responses/Unauthorized'
    '400':
      description: Ошибочные данные webhook'а
      schema:
        type: object
        required:
          - code
          - message
        properties:
          code:
            description: |
              [Код ошибки](#tag/Error-Codes)
            type: string
            enum:
              - invalidShopID
              - invalidRequest
              - invalidDeadline
          message:
            description: Человекочитаемое описание ошибки
            type: string
            example: Shop not found

get:
  description: Получить набор установленных webhook'ов.
  tags:
    - Webhooks
  operationId: getWebhooks
  parameters:
    - $ref: '#/parameters/requestID'
    - $ref: '#/parameters/deadline'
  responses:
    '200':
      description: Набор webhook'ов
      schema:
        type: array
        items:
          $ref: '#/definitions/Webhook'
    '401':
      $ref: '#/responses/Unauthorized'
    '400':
      $ref: '#/responses/DefaultLogicError'
-												HOOK-1: Describe webhook resources (#55)

* HOOK-1: Describe webhook resources

* HOOK-1: Deprecate and remove callback handlers

* HOOK-1: Get rid of allOfs hacked earlier to inject descriptions

											
										
										
											2017-04-24 13:30:38 +00:00
+								post:
 								  description: Установить новый webhook.
 								  tags:
 								    - Webhooks
 								  operationId: createWebhook
 								  parameters:
 								    - $ref: '#/parameters/requestID'
-												CAPI-300: Deadline to header (#243)



											
										
										
											2018-09-27 06:44:49 +00:00
+								    - $ref: '#/parameters/deadline'
-												HOOK-1: Describe webhook resources (#55)

* HOOK-1: Describe webhook resources

* HOOK-1: Deprecate and remove callback handlers

* HOOK-1: Get rid of allOfs hacked earlier to inject descriptions

											
										
										
											2017-04-24 13:30:38 +00:00
+								    - name: webhookParams
 								      description: Параметры устанавливаемого webhook'а
 								      in: body
 								      required: true
 								      schema:
-												HG-231: Introduce subscriptions (#125)


											
										
										
											2017-10-23 13:26:44 +00:00
+								        $ref: '#/definitions/Webhook'
-												HOOK-1: Describe webhook resources (#55)

* HOOK-1: Describe webhook resources

* HOOK-1: Deprecate and remove callback handlers

* HOOK-1: Get rid of allOfs hacked earlier to inject descriptions

											
										
										
											2017-04-24 13:30:38 +00:00
+								  responses:
 								    '201':
 								      description: Webhook установлен
 								      schema:
 								        $ref: '#/definitions/Webhook'
-												added 400 & 401 in all places

											
										
										
											2018-10-22 08:45:48 +00:00
+								    '401':
 								      $ref: '#/responses/Unauthorized'
-												HOOK-1: Describe webhook resources (#55)

* HOOK-1: Describe webhook resources

* HOOK-1: Deprecate and remove callback handlers

* HOOK-1: Get rid of allOfs hacked earlier to inject descriptions

											
										
										
											2017-04-24 13:30:38 +00:00
+								    '400':
-												Describe thoroughly all BadRequest errors (#188)


											
										
										
											2018-05-07 13:05:18 +00:00
+								      description: Ошибочные данные webhook'а
 								      schema:
 								        type: object
 								        required:
 								          - code
 								          - message
 								        properties:
 								          code:
 								            description: |
 								              [Код ошибки](#tag/Error-Codes)
 								            type: string
 								            enum:
 								              - invalidShopID
-												added 400 & 401 in all places

											
										
										
											2018-10-22 08:45:48 +00:00
+								              - invalidRequest
 								              - invalidDeadline
-												Describe thoroughly all BadRequest errors (#188)


											
										
										
											2018-05-07 13:05:18 +00:00
+								          message:
 								            description: Человекочитаемое описание ошибки
 								            type: string
 								            example: Shop not found
-												HOOK-1: Describe webhook resources (#55)

* HOOK-1: Describe webhook resources

* HOOK-1: Deprecate and remove callback handlers

* HOOK-1: Get rid of allOfs hacked earlier to inject descriptions

											
										
										
											2017-04-24 13:30:38 +00:00
 								get:
 								  description: Получить набор установленных webhook'ов.
 								  tags:
 								    - Webhooks
 								  operationId: getWebhooks
 								  parameters:
 								    - $ref: '#/parameters/requestID'
-												CAPI-300: Deadline to header (#243)



											
										
										
											2018-09-27 06:44:49 +00:00
+								    - $ref: '#/parameters/deadline'
-												HOOK-1: Describe webhook resources (#55)

* HOOK-1: Describe webhook resources

* HOOK-1: Deprecate and remove callback handlers

* HOOK-1: Get rid of allOfs hacked earlier to inject descriptions

											
										
										
											2017-04-24 13:30:38 +00:00
+								  responses:
 								    '200':
 								      description: Набор webhook'ов
 								      schema:
 								        type: array
 								        items:
 								          $ref: '#/definitions/Webhook'
-												added 400 & 401 in all places

											
										
										
											2018-10-22 08:45:48 +00:00
+								    '401':
 								      $ref: '#/responses/Unauthorized'
 								    '400':
-												refactored

											
										
										
											2018-10-22 11:43:35 +00:00
+								      $ref: '#/responses/DefaultLogicError'