114 lines
4.1 KiB
YAML
114 lines
4.1 KiB
YAML
components:
|
|
schemas:
|
|
CallbackBackoffInput:
|
|
description: Optional retry backoff overrides. Non-positive values currently fall back to server defaults.
|
|
type: object
|
|
additionalProperties: false
|
|
properties:
|
|
minDelayMs:
|
|
type: integer
|
|
maxDelayMs:
|
|
type: integer
|
|
|
|
CallbackRetryPolicyInput:
|
|
description: Optional retry and signing overrides. Omitted or non-positive numeric values currently fall back to server defaults.
|
|
type: object
|
|
additionalProperties: false
|
|
properties:
|
|
backoff:
|
|
$ref: '#/components/schemas/CallbackBackoffInput'
|
|
signingMode:
|
|
description: |
|
|
Optional signing mode. Canonical values are documented here; current handler also accepts legacy aliases such as `hmac`, `hmac-sha256`, `jws-eddsa-ed25519`, `jws+eddsa-ed25519`, `jws_eddsa`, and `eddsa_ed25519`.
|
|
type: string
|
|
enum:
|
|
- none
|
|
- hmac_sha256
|
|
- jws_eddsa_ed25519
|
|
headers:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
maxAttempts:
|
|
type: integer
|
|
requestTimeoutMs:
|
|
type: integer
|
|
|
|
CallbackCreateRequest:
|
|
description: |
|
|
Request payload used to create a callback configuration.
|
|
Only `url` is hard-required by current create logic. Other mutable fields are optional and defaulted by the handler when omitted.
|
|
type: object
|
|
additionalProperties: false
|
|
required:
|
|
- url
|
|
properties:
|
|
name:
|
|
description: Optional callback display name. When omitted, the handler defaults it to `url`.
|
|
type: string
|
|
description:
|
|
description: Optional callback description.
|
|
type: string
|
|
nullable: true
|
|
status:
|
|
description: |
|
|
Optional callback status. Canonical values are documented here; current handler also accepts `enabled` and `inactive` aliases.
|
|
type: string
|
|
enum:
|
|
- active
|
|
- disabled
|
|
url:
|
|
description: Absolute HTTPS callback endpoint URL.
|
|
type: string
|
|
format: uri
|
|
eventTypes:
|
|
description: Optional callback event types. When omitted or empty, the handler defaults this list.
|
|
type: array
|
|
items:
|
|
type: string
|
|
retryPolicy:
|
|
$ref: '#/components/schemas/CallbackRetryPolicyInput'
|
|
|
|
CallbackUpdateRequest:
|
|
description: |
|
|
Request payload used to update a callback configuration.
|
|
The current PUT handler requires `id`, `organizationRef`, and `url`. Other mutable fields are optional, but omitted values may be reset to handler defaults during normalization.
|
|
type: object
|
|
additionalProperties: false
|
|
required:
|
|
- id
|
|
- organizationRef
|
|
- url
|
|
properties:
|
|
id:
|
|
description: Callback identifier to update.
|
|
$ref: ../../../models/objectid.yaml#/components/schemas/ObjectId
|
|
organizationRef:
|
|
description: Organization identifier carried in the stored callback record and currently required by the update path.
|
|
$ref: ../../../models/objectid.yaml#/components/schemas/ObjectId
|
|
name:
|
|
description: Optional callback display name. When omitted, the handler defaults it to `url`.
|
|
type: string
|
|
description:
|
|
description: Optional callback description.
|
|
type: string
|
|
nullable: true
|
|
status:
|
|
description: |
|
|
Optional callback status. Canonical values are documented here; current handler also accepts `enabled` and `inactive` aliases.
|
|
type: string
|
|
enum:
|
|
- active
|
|
- disabled
|
|
url:
|
|
description: Absolute HTTPS callback endpoint URL.
|
|
type: string
|
|
format: uri
|
|
eventTypes:
|
|
description: Optional callback event types. When omitted or empty, the handler defaults this list.
|
|
type: array
|
|
items:
|
|
type: string
|
|
retryPolicy:
|
|
$ref: '#/components/schemas/CallbackRetryPolicyInput'
|