SamProject/sam-api
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(API): Swagger API 문서 업데이트

Browse Source 
- AdminFcmApi, BillApi, ExpectedExpenseApi 개선
- PositionApi, ProcessApi, QuoteApi 개선
- ReceivablesApi, ShipmentApi, StockApi, VendorLedgerApi 개선

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
권혁성
2026-01-13 19:48:54 +09:00
parent fc6d88bd26
commit e571f8c38e
10 changed files with 172 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
app/Swagger/v1/ProcessApi.php
View File

@@ -13,6 +13,7 @@
* @OA\Schema(
* schema="ProcessItem",
* type="object",
*
* @OA\Property(property="id", type="integer", example=1),
* @OA\Property(property="process_id", type="integer", example=1),
* @OA\Property(property="item_id", type="integer", example=123),
@@ -28,6 +29,7 @@
* @OA\Schema(
* schema="ProcessClassificationRule",
* type="object",
*
* @OA\Property(property="id", type="integer", example=1),
* @OA\Property(property="process_id", type="integer", example=1),
* @OA\Property(property="registration_type", type="string", example="pattern"),
@@ -42,6 +44,7 @@
* @OA\Schema(
* schema="Process",
* type="object",
*
* @OA\Property(property="id", type="integer", example=1),
* @OA\Property(property="tenant_id", type="integer", example=1),
* @OA\Property(property="process_code", type="string", example="P-001"),
@@ -63,6 +66,7 @@
* schema="ProcessCreateRequest",
* type="object",
* required={"process_name", "process_type"},
*
* @OA\Property(property="process_name", type="string", maxLength=100, example="스크린 생산"),
* @OA\Property(property="description", type="string", nullable=true),
* @OA\Property(property="process_type", type="string", enum={"생산", "검사", "포장", "조립"}),
@@ -75,9 +79,11 @@
* @OA\Property(property="is_active", type="boolean", nullable=true),
* @OA\Property(property="classification_rules", type="array", nullable=true,
* description="패턴 기반 분류 규칙",
*
* @OA\Items(
* type="object",
* required={"rule_type", "matching_type", "condition_value"},
*
* @OA\Property(property="rule_type", type="string", enum={"품목코드", "품목명", "품목구분"}),
* @OA\Property(property="matching_type", type="string", enum={"startsWith", "endsWith", "contains", "equals"}),
* @OA\Property(property="condition_value", type="string", maxLength=255),
@@ -88,6 +94,7 @@
* ),
* @OA\Property(property="item_ids", type="array", nullable=true,
* description="개별 품목 ID 배열",
*
* @OA\Items(type="integer", example=123)
* )
* )
@@ -100,13 +107,17 @@ class ProcessApi
* tags={"Process"},
* summary="공정 목록 조회",
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
*
* @OA\Parameter(name="page", in="query", @OA\Schema(type="integer", default=1)),
* @OA\Parameter(name="size", in="query", @OA\Schema(type="integer", default=20)),
* @OA\Parameter(name="q", in="query", description="검색어", @OA\Schema(type="string")),
* @OA\Parameter(name="status", in="query", @OA\Schema(type="string", enum={"active", "inactive"})),
* @OA\Parameter(name="process_type", in="query", @OA\Schema(type="string", enum={"생산", "검사", "포장", "조립"})),
*
* @OA\Response(response=200, description="성공",
*
* @OA\JsonContent(
*
* @OA\Property(property="success", type="boolean", example=true),
* @OA\Property(property="data", type="array", @OA\Items(ref="#/components/schemas/Process"))
* )
@@ -121,9 +132,13 @@ public function index() {}
* tags={"Process"},
* summary="공정 상세 조회",
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
*
* @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
*
* @OA\Response(response=200, description="성공",
*
* @OA\JsonContent(
*
* @OA\Property(property="success", type="boolean", example=true),
* @OA\Property(property="data", ref="#/components/schemas/Process")
* )
@@ -138,11 +153,16 @@ public function show() {}
* tags={"Process"},
* summary="공정 생성",
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
*
* @OA\RequestBody(required=true,
*
* @OA\JsonContent(ref="#/components/schemas/ProcessCreateRequest")
* ),
*
* @OA\Response(response=201, description="생성됨",
*
* @OA\JsonContent(
*
* @OA\Property(property="success", type="boolean", example=true),
* @OA\Property(property="message", type="string", example="message.created"),
* @OA\Property(property="data", ref="#/components/schemas/Process")
@@ -158,12 +178,18 @@ public function store() {}
* tags={"Process"},
* summary="공정 수정",
* security={{"ApiKeyAuth": {}}, {"BearerAuth": {}}},
*
* @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
*
* @OA\RequestBody(required=true,
*
* @OA\JsonContent(ref="#/components/schemas/ProcessCreateRequest")
* ),
*
* @OA\Response(response=200, description="성공",
*
* @OA\JsonContent(
*
* @OA\Property(property="success", type="boolean", example=true),
* @OA\Property(property="message", type="string", example="message.updated"),
* @OA\Property(property="data", ref="#/components/schemas/Process")