존재하지 않는 매개변수 참조 (OpenAPI 2.0)

설명

#/parameters/...로 참조하는 공통 매개변수는 실제 parameters 정의에 존재해야 합니다. 이름이 잘못되거나 정의가 삭제되면 필요한 요청 매개변수를 불러올 수 없습니다.

잠재적 영향

문서 생성이나 검증이 실패하거나 요청에 필요한 매개변수 정보가 누락될 수 있습니다.

해결 방법

참조 이름과 정의를 일치시키세요. 필요한 정의는 복원하고, 더 이상 필요하지 않은 참조만 제거하세요. 이름을 바꾸면 사용하는 위치도 함께 갱신하세요.

예시

다음 발췌 예시는 필요하지 않은 maxParam 참조를 제거하고 실제 정의된 limitParam을 유지합니다.

변경 전

json

{
  "paths": {
    "/": {
      "get": {
        "parameters": [
          {
            "$ref": "#/parameters/maxParam"
          },
          {
            "$ref": "#/parameters/limitParam"
          }
        ]
      }
    }
  },
  "parameters": {
    "limitParam": {
      "name": "limit",
      "in": "query",
      "required": true,
      "type": "integer"
    }
  }
}

변경 후

json

{
  "paths": {
    "/": {
      "get": {
        "parameters": [
          {
            "$ref": "#/parameters/limitParam"
          }
        ]
      }
    }
  },
  "parameters": {
    "limitParam": {
      "name": "limit",
      "in": "query",
      "required": true,
      "type": "integer"
    }
  }
}