how to reference callback that defined under the components to the path operation?

[RSH17]

when the callbacks are defined under the components and need to be referenced using $ref. how do define the $ref?
is this mentioned method okay to define the $ref under the callbacks? But the Swagger Editor gives an error.

{
"openapi": "3.1.0",
"info": {
"title": "My API",
"version": "1.0.0"
},
"components": {
"callbacks": {
"myCallback": {
"{$request.path}/success": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Callback was successful"
},
"400": {
"description": "Bad request"
}
}
}
},
"{$request.path}/failure": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"500": {
"description": "Internal server error"
}
}
}
}
}
}
},
"paths": {
"/example": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"callbacks": {
"$ref": "#/components/callbacks/myCallback"
},
"responses": {
"200": {
"description": "Success response"
},
"400": {
"description": "Bad request"
}
}
}
}
}
}

[hkosova]

Replace

"callbacks": {
"$ref": "#/components/callbacks/myCallback"
},

with

"callbacks": {
  "myCallback": {
    "$ref": "#/components/callbacks/myCallback"
  }
},

[eric-gonzalez-tfs]

@hkosova - This answer did not work for me.

{
   "openapi":"3.1.0",
   "info":{
      "title":"My API",
      "version":"1.0.0"
   },
   "components":{
      "callbacks":{
         "myCallback":{
            "{$request.path}/success":{
               "post":{
                  "requestBody":{
                     "content":{
                        "application/json":{
                           "schema":{
                              "type":"object"
                           }
                        }
                     }
                  },
                  "responses":{
                     "200":{
                        "description":"Callback was successful"
                     },
                     "400":{
                        "description":"Bad request"
                     }
                  }
               }
            },
            "{$request.path}/failure":{
               "post":{
                  "requestBody":{
                     "content":{
                        "application/json":{
                           "schema":{
                              "type":"object"
                           }
                        }
                     }
                  },
                  "responses":{
                     "500":{
                        "description":"Internal server error"
                     }
                  }
               }
            }
         }
      }
   },
   "paths":{
      "/example":{
         "post":{
            "requestBody":{
               "required":true,
               "content":{
                  "application/json":{
                     "schema":{
                        "type":"object"
                     }
                  }
               }
            },
            "callbacks":{
               "myCallback":{
                  "$ref":"#/components/callbacks/myCallback"
               }
            },
            "responses":{
               "200":{
                  "description":"Success response"
               },
               "400":{
                  "description":"Bad request"
               }
            }
         }
      }
   }
}

[hkosova]

@eric-gonzalez-tfs your callback syntax is correct. The error reported by the tool is a false positive. Open an issue with the tool vendor.

If the tool on your image is Swagger Editor - it's a known issue swagger-api/swagger-editor#4682

[eric-gonzalez-tfs]

Thanks for the response @hkosova - I indeed was using the Swagger Editor. I appreciate the link to the open issue!

[handrews]

Closing as resolved.