Skip to content

Commit 3941948

Browse files
authored
Merge pull request #271 from code-zero-to-one/feature/openapi-new
feat: new OpenAPI (automated)
2 parents 90ae867 + 6cb5994 commit 3941948

8 files changed

Lines changed: 115 additions & 19 deletions

src/api/openapi/.openapi-generator/FILES

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,8 @@ docs/GroupStudyThreadCommentRequest.md
133133
docs/GroupStudyThreadRequest.md
134134
docs/GroupStudyUpdateRequestDto.md
135135
docs/GrowthMetricResponse.md
136+
docs/HasMemberNewNotificationResponse.md
137+
docs/HasMemberNewNotificationSchema.md
136138
docs/HomeworkEditRequest.md
137139
docs/HomeworkSubmissionRequest.md
138140
docs/HomeworkSubmissionResponse.md
@@ -343,6 +345,8 @@ models/group-study-thread-comment-request.ts
343345
models/group-study-thread-request.ts
344346
models/group-study-update-request-dto.ts
345347
models/growth-metric-response.ts
348+
models/has-member-new-notification-response.ts
349+
models/has-member-new-notification-schema.ts
346350
models/homework-edit-request.ts
347351
models/homework-submission-request.ts
348352
models/homework-submission-response.ts

src/api/openapi/api/notification-api.ts

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
2222
// @ts-ignore
2323
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
2424
// @ts-ignore
25+
import type { HasMemberNewNotificationSchema } from '../models';
26+
// @ts-ignore
2527
import type { MemberNotificationSchema } from '../models';
2628
// @ts-ignore
2729
import type { NotificationCategoriesSchema } from '../models';
@@ -158,7 +160,7 @@ export const NotificationApiAxiosParamCreator = function (configuration?: Config
158160
};
159161
},
160162
/**
161-
* 작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **키** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | boolean | 알림 읽음 여부 | true / false | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" |
163+
* 작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **키** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | object | 응답 본문 | { ... } | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" | --- ### Response > content | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | isRead | boolean | 신규 알림 여부 | true / false |
162164
* @summary 회원 신규 알림 여부 조회
163165
* @param {*} [options] Override http request option.
164166
* @throws {RequiredError}
@@ -281,12 +283,12 @@ export const NotificationApiFp = function(configuration?: Configuration) {
281283
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
282284
},
283285
/**
284-
* 작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **키** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | boolean | 알림 읽음 여부 | true / false | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" |
286+
* 작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **키** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | object | 응답 본문 | { ... } | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" | --- ### Response > content | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | isRead | boolean | 신규 알림 여부 | true / false |
285287
* @summary 회원 신규 알림 여부 조회
286288
* @param {*} [options] Override http request option.
287289
* @throws {RequiredError}
288290
*/
289-
async hasMemberNewNotification(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
291+
async hasMemberNewNotification(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HasMemberNewNotificationSchema>> {
290292
const localVarAxiosArgs = await localVarAxiosParamCreator.hasMemberNewNotification(options);
291293
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
292294
const localVarOperationServerBasePath = operationServerMap['NotificationApi.hasMemberNewNotification']?.[localVarOperationServerIndex]?.url;
@@ -299,7 +301,7 @@ export const NotificationApiFp = function(configuration?: Configuration) {
299301
* @param {*} [options] Override http request option.
300302
* @throws {RequiredError}
301303
*/
302-
async readMemberNotifications(ids?: Array<any>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
304+
async readMemberNotifications(ids?: Array<any>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HasMemberNewNotificationSchema>> {
303305
const localVarAxiosArgs = await localVarAxiosParamCreator.readMemberNotifications(ids, options);
304306
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
305307
const localVarOperationServerBasePath = operationServerMap['NotificationApi.readMemberNotifications']?.[localVarOperationServerIndex]?.url;
@@ -347,12 +349,12 @@ export const NotificationApiFactory = function (configuration?: Configuration, b
347349
return localVarFp.getMemberNotifications(page, size, hasRead, topicType, options).then((request) => request(axios, basePath));
348350
},
349351
/**
350-
* 작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **키** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | boolean | 알림 읽음 여부 | true / false | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" |
352+
* 작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **키** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | object | 응답 본문 | { ... } | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" | --- ### Response > content | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | isRead | boolean | 신규 알림 여부 | true / false |
351353
* @summary 회원 신규 알림 여부 조회
352354
* @param {*} [options] Override http request option.
353355
* @throws {RequiredError}
354356
*/
355-
hasMemberNewNotification(options?: RawAxiosRequestConfig): AxiosPromise<void> {
357+
hasMemberNewNotification(options?: RawAxiosRequestConfig): AxiosPromise<HasMemberNewNotificationSchema> {
356358
return localVarFp.hasMemberNewNotification(options).then((request) => request(axios, basePath));
357359
},
358360
/**
@@ -362,7 +364,7 @@ export const NotificationApiFactory = function (configuration?: Configuration, b
362364
* @param {*} [options] Override http request option.
363365
* @throws {RequiredError}
364366
*/
365-
readMemberNotifications(ids?: Array<any>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
367+
readMemberNotifications(ids?: Array<any>, options?: RawAxiosRequestConfig): AxiosPromise<HasMemberNewNotificationSchema> {
366368
return localVarFp.readMemberNotifications(ids, options).then((request) => request(axios, basePath));
367369
},
368370
};
@@ -408,7 +410,7 @@ export class NotificationApi extends BaseAPI {
408410
}
409411

410412
/**
411-
* 작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **키** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | boolean | 알림 읽음 여부 | true / false | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" |
413+
* 작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **키** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | object | 응답 본문 | { ... } | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" | --- ### Response > content | **키** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | isRead | boolean | 신규 알림 여부 | true / false |
412414
* @summary 회원 신규 알림 여부 조회
413415
* @param {*} [options] Override http request option.
414416
* @throws {RequiredError}
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# HasMemberNewNotificationResponse
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**isRead** | **boolean** | | [optional] [default to undefined]
9+
10+
## Example
11+
12+
```typescript
13+
import { HasMemberNewNotificationResponse } from './api';
14+
15+
const instance: HasMemberNewNotificationResponse = {
16+
isRead,
17+
};
18+
```
19+
20+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# HasMemberNewNotificationSchema
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**statusCode** | **number** | | [optional] [default to undefined]
9+
**timestamp** | **string** | | [optional] [default to undefined]
10+
**content** | [**HasMemberNewNotificationResponse**](HasMemberNewNotificationResponse.md) | | [optional] [default to undefined]
11+
**message** | **string** | | [optional] [default to undefined]
12+
13+
## Example
14+
15+
```typescript
16+
import { HasMemberNewNotificationSchema } from './api';
17+
18+
const instance: HasMemberNewNotificationSchema = {
19+
statusCode,
20+
timestamp,
21+
content,
22+
message,
23+
};
24+
```
25+
26+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

src/api/openapi/docs/NotificationApi.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,13 @@ This endpoint does not have any parameters.
9595
### HTTP request headers
9696

9797
- **Content-Type**: Not defined
98-
- **Accept**: application/json, */*
98+
- **Accept**: application/json
9999

100100

101101
### HTTP response details
102102
| Status code | Description | Response headers |
103103
|-------------|-------------|------------------|
104104
|**200** | 회원 알림 카테고리 필터 목록 조회 성공 | - |
105-
|**401** | Bearer Token is invalid or no bearer token | - |
106-
|**403** | You are authenticated but not allowed authorization | - |
107105

108106
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
109107

@@ -168,9 +166,9 @@ const { status, data } = await apiInstance.getMemberNotifications(
168166
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
169167

170168
# **hasMemberNewNotification**
171-
> hasMemberNewNotification()
169+
> HasMemberNewNotificationSchema hasMemberNewNotification()
172170
173-
작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | boolean | 알림 읽음 여부 | true / false | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" |
171+
작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원의 신규 알림 존재 여부를 조회합니다. - 읽지 않은 알림이 하나 이상 존재하는 경우 false를 반환합니다. --- ## Request | **** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | --- ## Response | **** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 201: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | object | 응답 본문 | { ... } | | message | string | 처리 결과 | \"회원 신규 알림 여부 조회 성공\" | --- ### Response > content | **** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | isRead | boolean | 신규 알림 여부 | true / false |
174172

175173
### Example
176174

@@ -192,7 +190,7 @@ This endpoint does not have any parameters.
192190

193191
### Return type
194192

195-
void (empty response body)
193+
**HasMemberNewNotificationSchema**
196194

197195
### Authorization
198196

@@ -201,20 +199,18 @@ void (empty response body)
201199
### HTTP request headers
202200

203201
- **Content-Type**: Not defined
204-
- **Accept**: application/json, */*
202+
- **Accept**: application/json
205203

206204

207205
### HTTP response details
208206
| Status code | Description | Response headers |
209207
|-------------|-------------|------------------|
210208
|**200** | 회원 신규 알림 여부 조회 성공 | - |
211-
|**401** | Bearer Token is invalid or no bearer token | - |
212-
|**403** | You are authenticated but not allowed authorization | - |
213209

214210
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
215211

216212
# **readMemberNotifications**
217-
> readMemberNotifications()
213+
> HasMemberNewNotificationSchema readMemberNotifications()
218214
219215
작성일자: 2025-11-29 작성자: 성효빈 --- ## Description - 회원 알림을 읽음 처리합니다. - 알림 ID 목록을 전송하지 않는 경우, 전체 알림을 읽음 처리합니다. --- ## Request | **** | **타입** | **설명** | **필수 여부** | **예시** | | --- | --- | --- | --- | --- | | ids | array | 알림 ID 목록(전송하지 않는 경우 전체 알림 읽음 처리) | N | [1, 2, 3] | --- ## Response | **** | **타입** | **설명** | **예시** | | --- | --- | --- | --- | | statusCode | number | 상태 코드 | 200: 성공 / 400: 클라이언트 요청 오류 / 401: 인증 실패 / 403: 인가 실패 / 404: 리소스 조회 실패 / 409: 충돌 / 500: 그 외 | | timestamp | string(datetime) | 응답 일시 | \"2025-11-29T10:11:12.123456\" | | content | object | 응답 본문 | null | | message | string | 처리 결과 | \"회원 알림 읽음 처리 성공\" |
220216

@@ -245,7 +241,7 @@ const { status, data } = await apiInstance.readMemberNotifications(
245241

246242
### Return type
247243

248-
void (empty response body)
244+
**HasMemberNewNotificationSchema**
249245

250246
### Authorization
251247

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
/* tslint:disable */
2+
/* eslint-disable */
3+
/**
4+
* Zeroone API v1
5+
* v1
6+
*
7+
* The version of the OpenAPI document: v1
8+
*
9+
*
10+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11+
* https://openapi-generator.tech
12+
* Do not edit the class manually.
13+
*/
14+
15+
16+
17+
export interface HasMemberNewNotificationResponse {
18+
'isRead'?: boolean;
19+
}
20+
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/* tslint:disable */
2+
/* eslint-disable */
3+
/**
4+
* Zeroone API v1
5+
* v1
6+
*
7+
* The version of the OpenAPI document: v1
8+
*
9+
*
10+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11+
* https://openapi-generator.tech
12+
* Do not edit the class manually.
13+
*/
14+
15+
16+
// May contain unused imports in some cases
17+
// @ts-ignore
18+
import type { HasMemberNewNotificationResponse } from './has-member-new-notification-response';
19+
20+
export interface HasMemberNewNotificationSchema {
21+
'statusCode'?: number;
22+
'timestamp'?: string;
23+
'content'?: HasMemberNewNotificationResponse;
24+
'message'?: string;
25+
}
26+

0 commit comments

Comments
 (0)