90 lines
3.0 KiB
YAML
90 lines
3.0 KiB
YAML
components:
|
|
schemas:
|
|
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:
|
|
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
|
|
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
|
|
|
|
CallbackContent:
|
|
description: Callback endpoint configuration and delivery parameters.
|
|
allOf:
|
|
- type: object
|
|
additionalProperties: false
|
|
required:
|
|
- status
|
|
- url
|
|
- eventTypes
|
|
- retryPolicy
|
|
properties:
|
|
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'
|