잘못된 콜백 객체 참조 (OpenAPI 3.0)

설명

콜백의 $ref는 유효한 콜백 객체를 가리켜야 합니다. 경로나 이름이 틀리면 API가 나중에 보낼 콜백 요청의 정의를 불러올 수 없습니다.

잠재적 영향

문서나 클라이언트 코드 생성에 실패하거나 콜백 연동에 필요한 정보가 누락될 수 있습니다.

해결 방법

공통 콜백은 #/components/callbacks/...의 실제 정의를 참조하세요. 외부 파일의 유효한 콜백 객체도 사용할 수 있습니다. 경로와 이름을 함께 확인하세요.

예시

다음 발췌 예시는 POST 요청의 콜백 참조에서 callbaccgcks를 callbacks로 수정합니다. 콜백 URL을 전달하는 원래 요청 본문의 정의는 생략했습니다.

변경 전

json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "post": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "Success"
          }
        },
        "callbacks": {
          "myEvent": {
            "$ref": "#/components/callbaccgcks/inProgress"
          }
        }
      }
    }
  },
  "components": {
    "callbacks": {
      "inProgress": {
        "{$request.body#/inProgressUrl}": {
          "post": {
            "requestBody": {
              "content": {
                "application/json": {
                  "schema": {
                    "type": "object"
                  }
                }
              }
            },
            "responses": {
              "200": {
                "description": "OK"
              }
            }
          }
        }
      }
    }
  }
}

변경 후

json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Simple API Overview",
    "version": "1.0.0"
  },
  "paths": {
    "/": {
      "post": {
        "operationId": "listVersionsv2",
        "summary": "List API versions",
        "responses": {
          "200": {
            "description": "Success"
          }
        },
        "callbacks": {
          "myEvent": {
            "$ref": "#/components/callbacks/inProgress"
          }
        }
      }
    }
  },
  "components": {
    "callbacks": {
      "inProgress": {
        "{$request.body#/inProgressUrl}": {
          "post": {
            "requestBody": {
              "content": {
                "application/json": {
                  "schema": {
                    "type": "object"
                  }
                }
              }
            },
            "responses": {
              "200": {
                "description": "OK"
              }
            }
          }
        }
      }
    }
  }
}