From fabc6558320bbd052b7ba2db5e5a1f85ddfea1d3 Mon Sep 17 00:00:00 2001 From: finalchild Date: Fri, 3 May 2024 17:52:22 +0900 Subject: [PATCH] feat: exclude new schedule fields from REST API (#455) --- src/schema/v2.openapi.json | 316 +------------------------------------ 1 file changed, 1 insertion(+), 315 deletions(-) diff --git a/src/schema/v2.openapi.json b/src/schema/v2.openapi.json index 59e516a69..ca28a1f78 100644 --- a/src/schema/v2.openapi.json +++ b/src/schema/v2.openapi.json @@ -16552,32 +16552,6 @@ "description": "

계좌이체 정보

\n", "x-portone-title": "계좌이체 정보" }, - "BillingKeyPaymentMethodType": { - "title": "빌링키 결제 수단", - "type": "string", - "description": "

빌링키 결제 수단

\n", - "enum": [ - "CARD", - "EASY_PAY", - "MOBILE", - "TRANSFER" - ], - "x-portone-title": "빌링키 결제 수단", - "x-portone-enum": { - "CARD": { - "title": "카드" - }, - "MOBILE": { - "title": "모바일" - }, - "EASY_PAY": { - "title": "간편 결제" - }, - "TRANSFER": { - "title": "계좌 이체" - } - } - }, "BillingKeyPaymentSummary": { "title": "빌링키 결제 완료된 결제 건 요약 정보", "required": [ @@ -22031,14 +22005,10 @@ "required": [ "status", "id", - "graphqlId", "merchantId", - "merchantGraphqlId", "storeId", - "storeGraphqlId", "paymentId", "billingKey", - "billingKeyInfo", "orderName", "isCulturalExpense", "isEscrow", @@ -22061,26 +22031,14 @@ "type": "string", "title": "결제 예약 건 아이디" }, - "graphqlId": { - "type": "string", - "title": "결제 예약 건 아이디" - }, "merchantId": { "type": "string", "title": "가맹점 아이디" }, - "merchantGraphqlId": { - "type": "string", - "title": "가맹점 아이디" - }, "storeId": { "type": "string", "title": "상점 아이디" }, - "storeGraphqlId": { - "type": "string", - "title": "상점 아이디" - }, "paymentId": { "type": "string", "title": "결제 건 아이디" @@ -22089,10 +22047,6 @@ "type": "string", "title": "빌링키" }, - "billingKeyInfo": { - "$ref": "#/components/schemas/PaymentScheduleBillingKeyInfo", - "title": "빌링키 요약 정보" - }, "orderName": { "type": "string", "title": "주문명" @@ -28301,64 +28255,6 @@ "x-portone-title": "결제 예약건이 이미 취소된 경우", "x-portone-status-code": 409 }, - "PaymentScheduleBillingKeyEasyPayMethodType": { - "title": "빌링키 간편결제 상세 결제 수단", - "type": "string", - "description": "

빌링키 간편결제 상세 결제 수단

\n", - "enum": [ - "CARD", - "CHARGE", - "TRANSFER" - ], - "x-portone-title": "빌링키 간편결제 상세 결제 수단", - "x-portone-enum": { - "CARD": { - "title": "카드" - }, - "TRANSFER": { - "title": "계좌 이체" - }, - "CHARGE": { - "title": "포인트" - } - } - }, - "PaymentScheduleBillingKeyInfo": { - "title": "결제 예약 시 입력된 빌링키 요약 정보", - "type": "object", - "properties": { - "billingKey": { - "type": "string", - "title": "빌링키" - }, - "methodType": { - "$ref": "#/components/schemas/BillingKeyPaymentMethodType", - "title": "빌링키 결제 수단" - }, - "easyPayMethodType": { - "$ref": "#/components/schemas/PaymentScheduleBillingKeyEasyPayMethodType", - "title": "빌링키 간편 결제 수단" - }, - "groupId": { - "type": "string", - "title": "빌링키 발급에 사용한 그룹 ID" - }, - "groupName": { - "type": "string", - "title": "빌링키 발급에 사용한 그룹 이름" - }, - "pgCompany": { - "$ref": "#/components/schemas/PgCompany", - "title": "빌링키 발급에 사용한 PG사" - }, - "pgProvider": { - "$ref": "#/components/schemas/PgProvider", - "title": "빌링키 발급에 사용한 PG사 결제 모듈" - } - }, - "description": "

결제 예약 시 입력된 빌링키 요약 정보

\n", - "x-portone-title": "결제 예약 시 입력된 빌링키 요약 정보" - }, "PaymentScheduleFilterInput": { "title": "결제 예약 건 다건 조회를 위한 입력 정보", "type": "object", @@ -28372,27 +28268,6 @@ "type": "string", "title": "빌링키" }, - "paymentScheduleId": { - "type": "string", - "title": "결제 예약 건 ID" - }, - "paymentId": { - "type": "string", - "title": "결제건 ID" - }, - "customerId": { - "type": "string", - "title": "고객 ID" - }, - "textSearch": { - "$ref": "#/components/schemas/PaymentScheduleTextSearchInput", - "title": "텍스트 검색 필터" - }, - "timeRangeField": { - "$ref": "#/components/schemas/PaymentScheduleTimeRangeField", - "title": "시각 범위를 적용할 필드", - "description": "

from 과 until 필드가 해당 필드의 값에 대해 적용됩니다. 미입력 시 TIME_TO_PAY 로 기본값이 설정됩니다.

\n" - }, "from": { "type": "string", "format": "date-time", @@ -28412,30 +28287,6 @@ "$ref": "#/components/schemas/PaymentScheduleStatus" }, "description": "

값을 입력하지 않으면 상태 필터링이 적용되지 않습니다.

\n" - }, - "pgProviders": { - "title": "PG사 결제 모듈 리스트", - "type": "array", - "items": { - "$ref": "#/components/schemas/PgProvider" - }, - "description": "

값을 입력하지 않으면 PG사 결제 모듈 필터링이 적용되지 않습니다.

\n" - }, - "pgCompanies": { - "title": "PG사 리스트", - "type": "array", - "items": { - "$ref": "#/components/schemas/PgCompany" - }, - "description": "

값을 입력하지 않으면 PG사 필터링이 적용되지 않습니다.

\n" - }, - "smartRoutingGroupIds": { - "type": "array", - "items": { - "type": "string" - }, - "title": "스마트 라우팅 그룹 아이디 리스트", - "description": "

값을 입력하지 않으면 스마트 라우팅 그룹 아이디 필터링이 적용되지 않습니다.

\n" } }, "description": "

결제 예약 건 다건 조회를 위한 입력 정보

\n", @@ -28466,7 +28317,6 @@ "enum": [ "COMPLETED_AT", "CREATED_AT", - "STATUS_TIMESTAMP", "TIME_TO_PAY" ], "x-portone-title": "결제 예약 건 정렬 기준", @@ -28552,70 +28402,6 @@ "description": "

결제 예약 건

\n", "x-portone-title": "결제 예약 건" }, - "PaymentScheduleTextSearchField": { - "title": "결제 예약 건 다건 조회 시, 텍스트 검색 필터의 검색 기준 필드", - "type": "string", - "description": "

결제 예약 건 다건 조회 시, 텍스트 검색 필터의 검색 기준 필드

\n", - "enum": [ - "CUSTOMER_NAME", - "ORDER_NAME" - ], - "x-portone-title": "결제 예약 건 다건 조회 시, 텍스트 검색 필터의 검색 기준 필드", - "x-portone-enum": { - "CUSTOMER_NAME": { - "title": "고객명" - }, - "ORDER_NAME": { - "title": "주문명" - } - } - }, - "PaymentScheduleTextSearchInput": { - "title": "결제 예약 건 다건 조회 시, 텍스트 검색 필터 정보", - "required": [ - "field", - "value" - ], - "type": "object", - "properties": { - "field": { - "$ref": "#/components/schemas/PaymentScheduleTextSearchField", - "title": "검색 기준 필드" - }, - "value": { - "type": "string", - "title": "검색할 값" - } - }, - "description": "

결제 예약 건 다건 조회 시, 텍스트 검색 필터 정보

\n", - "x-portone-title": "결제 예약 건 다건 조회 시, 텍스트 검색 필터 정보" - }, - "PaymentScheduleTimeRangeField": { - "title": "결제 예약 건 다건 조회 시, 시각 범위를 적용할 필드", - "type": "string", - "description": "

결제 예약 건 다건 조회 시, 시각 범위를 적용할 필드

\n", - "enum": [ - "COMPLETED_AT", - "CREATED_AT", - "STATUS_TIMESTAMP", - "TIME_TO_PAY" - ], - "x-portone-title": "결제 예약 건 다건 조회 시, 시각 범위를 적용할 필드", - "x-portone-enum": { - "CREATED_AT": { - "title": "결제 예약 생성 시각" - }, - "TIME_TO_PAY": { - "title": "결제 예정 시각" - }, - "COMPLETED_AT": { - "title": "예약 결제 시도(성공 / 실패) 시각" - }, - "STATUS_TIMESTAMP": { - "title": "결제 시도 또는 예정 시각. 해지 건은 해지 시각." - } - } - }, "PaymentSortBy": { "title": "결제 건 정렬 기준", "type": "string", @@ -29018,14 +28804,10 @@ "required": [ "status", "id", - "graphqlId", "merchantId", - "merchantGraphqlId", "storeId", - "storeGraphqlId", "paymentId", "billingKey", - "billingKeyInfo", "orderName", "isCulturalExpense", "isEscrow", @@ -29048,26 +28830,14 @@ "type": "string", "title": "결제 예약 건 아이디" }, - "graphqlId": { - "type": "string", - "title": "결제 예약 건 아이디" - }, "merchantId": { "type": "string", "title": "가맹점 아이디" }, - "merchantGraphqlId": { - "type": "string", - "title": "가맹점 아이디" - }, "storeId": { "type": "string", "title": "상점 아이디" }, - "storeGraphqlId": { - "type": "string", - "title": "상점 아이디" - }, "paymentId": { "type": "string", "title": "결제 건 아이디" @@ -29076,10 +28846,6 @@ "type": "string", "title": "빌링키" }, - "billingKeyInfo": { - "$ref": "#/components/schemas/PaymentScheduleBillingKeyInfo", - "title": "빌링키 요약 정보" - }, "orderName": { "type": "string", "title": "주문명" @@ -35507,14 +35273,10 @@ "required": [ "status", "id", - "graphqlId", "merchantId", - "merchantGraphqlId", "storeId", - "storeGraphqlId", "paymentId", "billingKey", - "billingKeyInfo", "orderName", "isCulturalExpense", "isEscrow", @@ -35536,26 +35298,14 @@ "type": "string", "title": "결제 예약 건 아이디" }, - "graphqlId": { - "type": "string", - "title": "결제 예약 건 아이디" - }, "merchantId": { "type": "string", "title": "가맹점 아이디" }, - "merchantGraphqlId": { - "type": "string", - "title": "가맹점 아이디" - }, "storeId": { "type": "string", "title": "상점 아이디" }, - "storeGraphqlId": { - "type": "string", - "title": "상점 아이디" - }, "paymentId": { "type": "string", "title": "결제 건 아이디" @@ -35564,10 +35314,6 @@ "type": "string", "title": "빌링키" }, - "billingKeyInfo": { - "$ref": "#/components/schemas/PaymentScheduleBillingKeyInfo", - "title": "빌링키 요약 정보" - }, "orderName": { "type": "string", "title": "주문명" @@ -36115,14 +35861,10 @@ "required": [ "status", "id", - "graphqlId", "merchantId", - "merchantGraphqlId", "storeId", - "storeGraphqlId", "paymentId", "billingKey", - "billingKeyInfo", "orderName", "isCulturalExpense", "isEscrow", @@ -36143,26 +35885,14 @@ "type": "string", "title": "결제 예약 건 아이디" }, - "graphqlId": { - "type": "string", - "title": "결제 예약 건 아이디" - }, "merchantId": { "type": "string", "title": "가맹점 아이디" }, - "merchantGraphqlId": { - "type": "string", - "title": "가맹점 아이디" - }, "storeId": { "type": "string", "title": "상점 아이디" }, - "storeGraphqlId": { - "type": "string", - "title": "상점 아이디" - }, "paymentId": { "type": "string", "title": "결제 건 아이디" @@ -36171,10 +35901,6 @@ "type": "string", "title": "빌링키" }, - "billingKeyInfo": { - "$ref": "#/components/schemas/PaymentScheduleBillingKeyInfo", - "title": "빌링키 요약 정보" - }, "orderName": { "type": "string", "title": "주문명" @@ -36519,14 +36245,10 @@ "required": [ "status", "id", - "graphqlId", "merchantId", - "merchantGraphqlId", "storeId", - "storeGraphqlId", "paymentId", "billingKey", - "billingKeyInfo", "orderName", "isCulturalExpense", "isEscrow", @@ -36548,26 +36270,14 @@ "type": "string", "title": "결제 예약 건 아이디" }, - "graphqlId": { - "type": "string", - "title": "결제 예약 건 아이디" - }, "merchantId": { "type": "string", "title": "가맹점 아이디" }, - "merchantGraphqlId": { - "type": "string", - "title": "가맹점 아이디" - }, "storeId": { "type": "string", "title": "상점 아이디" }, - "storeGraphqlId": { - "type": "string", - "title": "상점 아이디" - }, "paymentId": { "type": "string", "title": "결제 건 아이디" @@ -36576,10 +36286,6 @@ "type": "string", "title": "빌링키" }, - "billingKeyInfo": { - "$ref": "#/components/schemas/PaymentScheduleBillingKeyInfo", - "title": "빌링키 요약 정보" - }, "orderName": { "type": "string", "title": "주문명" @@ -36729,14 +36435,10 @@ "required": [ "status", "id", - "graphqlId", "merchantId", - "merchantGraphqlId", "storeId", - "storeGraphqlId", "paymentId", "billingKey", - "billingKeyInfo", "orderName", "isCulturalExpense", "isEscrow", @@ -36759,26 +36461,14 @@ "type": "string", "title": "결제 예약 건 아이디" }, - "graphqlId": { - "type": "string", - "title": "결제 예약 건 아이디" - }, "merchantId": { "type": "string", "title": "가맹점 아이디" }, - "merchantGraphqlId": { - "type": "string", - "title": "가맹점 아이디" - }, "storeId": { "type": "string", "title": "상점 아이디" }, - "storeGraphqlId": { - "type": "string", - "title": "상점 아이디" - }, "paymentId": { "type": "string", "title": "결제 건 아이디" @@ -36787,10 +36477,6 @@ "type": "string", "title": "빌링키" }, - "billingKeyInfo": { - "$ref": "#/components/schemas/PaymentScheduleBillingKeyInfo", - "title": "빌링키 요약 정보" - }, "orderName": { "type": "string", "title": "주문명" @@ -38039,4 +37725,4 @@ "description": "

특정 PG사에 국한된 API 기능을 제공합니다.

\n" } ] -} \ No newline at end of file +}