Callbacks service docs updated
This commit is contained in:
@@ -1,67 +1,89 @@
|
||||
components:
|
||||
schemas:
|
||||
CallbackRetryPolicy:
|
||||
CallbackBackoff:
|
||||
description: Backoff window used between callback retry attempts.
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required:
|
||||
- minDelayMs
|
||||
- maxDelayMs
|
||||
properties:
|
||||
minDelayMs:
|
||||
description: Minimum delay in milliseconds before scheduling a retry attempt.
|
||||
type: integer
|
||||
minimum: 1
|
||||
maxDelayMs:
|
||||
description: Maximum delay in milliseconds before scheduling a retry attempt.
|
||||
type: integer
|
||||
minimum: 1
|
||||
|
||||
CallbackRetryPolicy:
|
||||
description: Retry and delivery behavior for callback requests.
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required:
|
||||
- backoff
|
||||
- signingMode
|
||||
- maxAttempts
|
||||
- requestTimeoutMs
|
||||
properties:
|
||||
minDelayMs:
|
||||
type: integer
|
||||
minimum: 1
|
||||
maxDelayMs:
|
||||
type: integer
|
||||
minimum: 1
|
||||
backoff:
|
||||
description: Delay boundaries used to compute retry backoff between attempts.
|
||||
$ref: '#/components/schemas/CallbackBackoff'
|
||||
signingMode:
|
||||
description: Request-signing strategy applied when dispatching callback payloads.
|
||||
type: string
|
||||
enum:
|
||||
- none
|
||||
- hmac_sha256
|
||||
secretRef:
|
||||
type: string
|
||||
nullable: true
|
||||
headers:
|
||||
description: Additional HTTP headers included with every callback request.
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: string
|
||||
maxAttempts:
|
||||
description: Maximum number of delivery attempts before marking dispatch as failed.
|
||||
type: integer
|
||||
minimum: 1
|
||||
requestTimeoutMs:
|
||||
description: Per-request timeout in milliseconds for callback HTTP calls.
|
||||
type: integer
|
||||
minimum: 1
|
||||
|
||||
Callback:
|
||||
CallbackContent:
|
||||
description: Callback endpoint configuration and delivery parameters.
|
||||
allOf:
|
||||
- $ref: ../permission_bound.yaml#/components/schemas/PermissionBound
|
||||
- $ref: ../common/describable.yaml#/components/schemas/Describable
|
||||
- type: object
|
||||
additionalProperties: false
|
||||
required:
|
||||
- clientId
|
||||
- status
|
||||
- url
|
||||
- eventTypes
|
||||
- retryPolicy
|
||||
properties:
|
||||
clientId:
|
||||
type: string
|
||||
status:
|
||||
description: Operational state controlling whether callback delivery is enabled.
|
||||
type: string
|
||||
enum:
|
||||
- active
|
||||
- disabled
|
||||
url:
|
||||
description: Absolute HTTPS endpoint URL that receives callback events.
|
||||
type: string
|
||||
format: uri
|
||||
eventTypes:
|
||||
description: Event type names that trigger callback delivery to this endpoint.
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
retryPolicy:
|
||||
description: Retry and timeout parameters used when dispatching callback events.
|
||||
$ref: '#/components/schemas/CallbackRetryPolicy'
|
||||
|
||||
|
||||
Callback:
|
||||
description: Stored callback configuration bound to an organization permission scope.
|
||||
allOf:
|
||||
- $ref: ../permission_bound.yaml#/components/schemas/PermissionBound
|
||||
- $ref: ../common/describable.yaml#/components/schemas/Describable
|
||||
- $ref: '#/components/schemas/CallbackContent'
|
||||
|
||||
Reference in New Issue
Block a user