Callbacks service docs updated
This commit is contained in:
@@ -1,9 +1,9 @@
|
||||
components:
|
||||
requestBodies:
|
||||
CallbackBody:
|
||||
description: JSON body containing callback endpoint configuration.
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../request/callback.yaml#/components/schemas/CallbackRequest
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
components:
|
||||
schemas:
|
||||
CallbackRequest:
|
||||
$ref: ../../../models/callback/callback.yaml#/components/schemas/Callback
|
||||
|
||||
description: Request payload used to create or update a callback configuration.
|
||||
$ref: ../../../models/callback/callback.yaml#/components/schemas/CallbackContent
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
components:
|
||||
schemas:
|
||||
CallbacksAuthData:
|
||||
description: Authenticated response payload containing callback configurations.
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required:
|
||||
@@ -8,12 +9,14 @@ components:
|
||||
- callbacks
|
||||
properties:
|
||||
accessToken:
|
||||
description: Refreshed access token to be used in subsequent API calls.
|
||||
$ref: ../../../models/auth/token_data.yaml#/components/schemas/TokenData
|
||||
callbacks:
|
||||
description: Collection of callbacks configured for the authenticated scope.
|
||||
type: array
|
||||
items:
|
||||
$ref: ../../../models/callback/callback.yaml#/components/schemas/Callback
|
||||
generatedSigningSecret:
|
||||
description: Newly generated signing secret when secret rotation is requested.
|
||||
type: string
|
||||
nullable: true
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
tags: [Callbacks]
|
||||
summary: Rotate callback signing secret
|
||||
description: Generates and stores a new HMAC secret for the callback in Vault and returns it once.
|
||||
description: Generates and stores a new HMAC secret for the callback and returns it once.
|
||||
operationId: callbacksRotateSecret
|
||||
security:
|
||||
- bearerAuth: []
|
||||
|
||||
Reference in New Issue
Block a user