We are having a requirement to host apis in our APIC Connect (version 10.0.5) with OAS 3.0.x version elements (callbacks).
API Connect does not support this callbacks or links. If it detects callback definitions APIC does not allow API to publish.
Ref:
https://www.ibm.com/docs/en/api-connect/10.0.8_lts?topic=definition-openapi-30-support-in-api-connect
https://www.ibm.com/docs/en/api-connect/10.0.5_lts?topic=definition-openapi-30-support-in-api-connect
We want to know if there is any workaround to make this happen?
Exaplem Schema:
Current OAS 3.0 Implementation
paths:
/operation:
post:
summary: operation information
description: |
operation
operationId: operation.id
tags:
- operation
requestBody:
required: true
description: Payload containing operation details and optional callback configuration.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/operationRequest'
examples:
requestPayload:
summary: operation information request example
value:
"@type": "operationInformation"
requestId: "generated-uuid"
requestDate: "2025-03-05T11:30:00Z"
applicationId: "xxxxx-xxx-xxx-9xx8-048x4x9x609cx"
baseInput:
field1: "field1"
field2: "field2"
callback:
url: "https://api.example.com/callback"
headers:
- key: "string"
value: "string"
body:
- name: "string"
value: "string"
requestor:
name: "string"
email: "email@example.com"
role: "string"
responses:
'200':
description: Successful operation response
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/operationResponse'
'400':
$ref: '#/components/responses/badRequest'
callbacks:
onOperationResult:
'{$request.body#/callback.url}':
post:
summary: Callback with operation result
description: Invoked on the provided callback URL with the operation outcome.
operationId: callback.notify
tags:
- callback.notification
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/callbackResponse'
examples:
callbackSuccess:
summary: Successful operation notification example
value:
"@type": "field1Information"
requestId: "generated-uuid"
responseDate: "2025-03-05T11:35:00Z"
success: true
baseOutput:
field1: "field1"
field2: "field2"
status: "complete"
externalData:
- name: "string"
value: "string"
responses:
'200':
description: Callback received successfully.
------------------------------
Neel Mehta
------------------------------