docs(API): Swagger API 문서 업데이트
- AdminFcmApi, BillApi, ExpectedExpenseApi 개선 - PositionApi, ProcessApi, QuoteApi 개선 - ReceivablesApi, ShipmentApi, StockApi, VendorLedgerApi 개선 Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -11,6 +11,7 @@
|
||||
* @OA\Schema(
|
||||
* schema="ExpectedExpense",
|
||||
* type="object",
|
||||
*
|
||||
* @OA\Property(property="id", type="integer", example=1),
|
||||
* @OA\Property(property="tenant_id", type="integer", example=1),
|
||||
* @OA\Property(property="expected_payment_date", type="string", format="date", example="2025-01-15"),
|
||||
@@ -46,6 +47,7 @@
|
||||
* @OA\Schema(
|
||||
* schema="ExpectedExpensePagination",
|
||||
* type="object",
|
||||
*
|
||||
* @OA\Property(property="current_page", type="integer", example=1),
|
||||
* @OA\Property(property="data", type="array", @OA\Items(ref="#/components/schemas/ExpectedExpense")),
|
||||
* @OA\Property(property="first_page_url", type="string"),
|
||||
@@ -64,6 +66,7 @@
|
||||
* schema="ExpectedExpenseCreateRequest",
|
||||
* type="object",
|
||||
* required={"expected_payment_date", "transaction_type", "amount"},
|
||||
*
|
||||
* @OA\Property(property="expected_payment_date", type="string", format="date", example="2025-01-15"),
|
||||
* @OA\Property(property="settlement_date", type="string", format="date", nullable=true, example="2025-01-10"),
|
||||
* @OA\Property(property="transaction_type", type="string", enum={"purchase","advance","suspense","rent","salary","insurance","tax","utilities","other"}, example="purchase"),
|
||||
@@ -80,6 +83,7 @@
|
||||
* @OA\Schema(
|
||||
* schema="ExpectedExpenseUpdateRequest",
|
||||
* type="object",
|
||||
*
|
||||
* @OA\Property(property="expected_payment_date", type="string", format="date", example="2025-01-20"),
|
||||
* @OA\Property(property="settlement_date", type="string", format="date", nullable=true),
|
||||
* @OA\Property(property="transaction_type", type="string", enum={"purchase","advance","suspense","rent","salary","insurance","tax","utilities","other"}),
|
||||
@@ -96,6 +100,7 @@
|
||||
* @OA\Schema(
|
||||
* schema="ExpectedExpenseSummary",
|
||||
* type="object",
|
||||
*
|
||||
* @OA\Property(property="total_amount", type="number", format="float", example=15000000),
|
||||
* @OA\Property(property="total_count", type="integer", example=12),
|
||||
* @OA\Property(property="by_payment_status", type="object"),
|
||||
@@ -111,6 +116,7 @@ class ExpectedExpenseApi
|
||||
* summary="미지급비용 목록 조회",
|
||||
* tags={"ExpectedExpense"},
|
||||
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
|
||||
*
|
||||
* @OA\Parameter(name="search", in="query", description="검색어 (거래처명, 계정과목, 적요)", @OA\Schema(type="string")),
|
||||
* @OA\Parameter(name="start_date", in="query", description="시작일", @OA\Schema(type="string", format="date")),
|
||||
* @OA\Parameter(name="end_date", in="query", description="종료일", @OA\Schema(type="string", format="date")),
|
||||
@@ -122,10 +128,13 @@ class ExpectedExpenseApi
|
||||
* @OA\Parameter(name="sort_dir", in="query", description="정렬 방향", @OA\Schema(type="string", enum={"asc","desc"}, default="asc")),
|
||||
* @OA\Parameter(name="per_page", in="query", description="페이지당 항목 수", @OA\Schema(type="integer", default=50)),
|
||||
* @OA\Parameter(name="page", in="query", description="페이지 번호", @OA\Schema(type="integer", default=1)),
|
||||
*
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="성공",
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="success", type="boolean", example=true),
|
||||
* @OA\Property(property="message", type="string"),
|
||||
* @OA\Property(property="data", ref="#/components/schemas/ExpectedExpensePagination")
|
||||
@@ -141,14 +150,19 @@ public function index() {}
|
||||
* summary="미지급비용 등록",
|
||||
* tags={"ExpectedExpense"},
|
||||
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
|
||||
*
|
||||
* @OA\RequestBody(
|
||||
* required=true,
|
||||
*
|
||||
* @OA\JsonContent(ref="#/components/schemas/ExpectedExpenseCreateRequest")
|
||||
* ),
|
||||
*
|
||||
* @OA\Response(
|
||||
* response=201,
|
||||
* description="생성 성공",
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="success", type="boolean", example=true),
|
||||
* @OA\Property(property="message", type="string"),
|
||||
* @OA\Property(property="data", ref="#/components/schemas/ExpectedExpense")
|
||||
@@ -164,11 +178,15 @@ public function store() {}
|
||||
* summary="미지급비용 상세 조회",
|
||||
* tags={"ExpectedExpense"},
|
||||
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
|
||||
*
|
||||
* @OA\Parameter(name="id", in="path", required=true, description="미지급비용 ID", @OA\Schema(type="integer")),
|
||||
*
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="성공",
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="success", type="boolean", example=true),
|
||||
* @OA\Property(property="message", type="string"),
|
||||
* @OA\Property(property="data", ref="#/components/schemas/ExpectedExpense")
|
||||
@@ -184,15 +202,21 @@ public function show() {}
|
||||
* summary="미지급비용 수정",
|
||||
* tags={"ExpectedExpense"},
|
||||
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
|
||||
*
|
||||
* @OA\Parameter(name="id", in="path", required=true, description="미지급비용 ID", @OA\Schema(type="integer")),
|
||||
*
|
||||
* @OA\RequestBody(
|
||||
* required=true,
|
||||
*
|
||||
* @OA\JsonContent(ref="#/components/schemas/ExpectedExpenseUpdateRequest")
|
||||
* ),
|
||||
*
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="수정 성공",
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="success", type="boolean", example=true),
|
||||
* @OA\Property(property="message", type="string"),
|
||||
* @OA\Property(property="data", ref="#/components/schemas/ExpectedExpense")
|
||||
@@ -208,11 +232,15 @@ public function update() {}
|
||||
* summary="미지급비용 삭제",
|
||||
* tags={"ExpectedExpense"},
|
||||
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
|
||||
*
|
||||
* @OA\Parameter(name="id", in="path", required=true, description="미지급비용 ID", @OA\Schema(type="integer")),
|
||||
*
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="삭제 성공",
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="success", type="boolean", example=true),
|
||||
* @OA\Property(property="message", type="string")
|
||||
* )
|
||||
@@ -227,16 +255,22 @@ public function destroy() {}
|
||||
* summary="미지급비용 일괄 삭제",
|
||||
* tags={"ExpectedExpense"},
|
||||
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
|
||||
*
|
||||
* @OA\RequestBody(
|
||||
* required=true,
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="ids", type="array", @OA\Items(type="integer"), example={1, 2, 3})
|
||||
* )
|
||||
* ),
|
||||
*
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="일괄 삭제 성공",
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="success", type="boolean", example=true),
|
||||
* @OA\Property(property="message", type="string"),
|
||||
* @OA\Property(property="data", type="object",
|
||||
@@ -254,17 +288,23 @@ public function destroyMany() {}
|
||||
* summary="예상 지급일 일괄 변경",
|
||||
* tags={"ExpectedExpense"},
|
||||
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
|
||||
*
|
||||
* @OA\RequestBody(
|
||||
* required=true,
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="ids", type="array", @OA\Items(type="integer"), example={1, 2, 3}),
|
||||
* @OA\Property(property="expected_payment_date", type="string", format="date", example="2025-02-01")
|
||||
* )
|
||||
* ),
|
||||
*
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="일괄 변경 성공",
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="success", type="boolean", example=true),
|
||||
* @OA\Property(property="message", type="string"),
|
||||
* @OA\Property(property="data", type="object",
|
||||
@@ -282,13 +322,17 @@ public function updateExpectedPaymentDate() {}
|
||||
* summary="미지급비용 요약 (기간별 합계)",
|
||||
* tags={"ExpectedExpense"},
|
||||
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
|
||||
*
|
||||
* @OA\Parameter(name="start_date", in="query", description="시작일", @OA\Schema(type="string", format="date")),
|
||||
* @OA\Parameter(name="end_date", in="query", description="종료일", @OA\Schema(type="string", format="date")),
|
||||
* @OA\Parameter(name="payment_status", in="query", description="지급상태", @OA\Schema(type="string")),
|
||||
*
|
||||
* @OA\Response(
|
||||
* response=200,
|
||||
* description="성공",
|
||||
*
|
||||
* @OA\JsonContent(
|
||||
*
|
||||
* @OA\Property(property="success", type="boolean", example=true),
|
||||
* @OA\Property(property="message", type="string"),
|
||||
* @OA\Property(property="data", ref="#/components/schemas/ExpectedExpenseSummary")
|
||||
|
||||
Reference in New Issue
Block a user