fix: Swagger 경로 파라미터 라우트 일치 수정

- ItemsBomApi: {code} → {id} (10개 경로)
- BomCalculationApi: snake_case → camelCase 파라미터
- PermissionApi: {id} → 구체적 파라미터명 (dept_id, role_id, user_id)
- FieldProfileApi: opt-groups → settings/options, 중복 Fields 엔드포인트 제거

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
2025-12-21 14:17:44 +09:00
parent 1449683aae
commit 3f4541e632
4 changed files with 47 additions and 205 deletions

View File

@@ -7,77 +7,12 @@
/**
* 전역 태그 선언
*
* @OA\Tag(name="Tenant.Fields", description="테넌트별 필드 구동(효과값 조회/설정)")
* @OA\Tag(name="Tenant.Option Groups", description="테넌트 관리형 옵션 그룹")
* @OA\Tag(name="Tenant.Option Values", description="옵션 그룹의 항목(값) 관리")
* @OA\Tag(name="Tenant.Profiles", description="테넌트별 회원 프로필 조회/수정")
*/
class FieldProfileApi
{
/**
* Fields(효과값/설정) 스키마
*
* @OA\Schema(
* schema="FieldEffective",
* type="object",
* description="전역정의 + 테넌트설정이 merge된 필드 효과값",
* required={"field_key","label","data_type","input_type","enabled"},
*
* @OA\Property(property="field_key", type="string", example="position"),
* @OA\Property(property="label", type="string", example="직급"),
* @OA\Property(property="data_type", type="string", example="string"),
* @OA\Property(property="input_type", type="string", example="select"),
* @OA\Property(property="option_source", type="string", nullable=true, example="tenant_list"),
* @OA\Property(property="option_payload", type="object", nullable=true),
* @OA\Property(property="storage_area", type="string", example="tenant_profile"),
* @OA\Property(property="storage_key", type="string", example="position_key"),
* @OA\Property(property="is_core", type="boolean", example=false),
* @OA\Property(property="enabled", type="boolean", example=true),
* @OA\Property(property="required", type="boolean", example=false),
* @OA\Property(property="sort_order", type="integer", example=10),
* @OA\Property(property="option_group_id", type="integer", nullable=true, example=5),
* @OA\Property(property="code_group", type="string", nullable=true, example="employment_type")
* )
*
* @OA\Schema(
* schema="FieldSettingUpdateRequest",
* type="object",
*
* @OA\Property(property="enabled", type="boolean", example=true),
* @OA\Property(property="required", type="boolean", example=false),
* @OA\Property(property="sort_order", type="integer", example=20),
* @OA\Property(property="option_group_id", type="integer", nullable=true, example=5),
* @OA\Property(property="code_group", type="string", nullable=true, example="department")
* )
*
* @OA\Schema(
* schema="FieldSettingBulkItem",
* type="object",
* required={"field_key"},
*
* @OA\Property(property="field_key", type="string", example="position"),
* @OA\Property(property="enabled", type="boolean", example=true),
* @OA\Property(property="required", type="boolean", example=false),
* @OA\Property(property="sort_order", type="integer", example=10),
* @OA\Property(property="option_group_id", type="integer", nullable=true, example=5),
* @OA\Property(property="code_group", type="string", nullable=true, example="employment_type")
* )
*
* @OA\Schema(
* schema="FieldSettingBulkRequest",
* type="object",
* required={"items"},
*
* @OA\Property(
* property="items",
* type="array",
*
* @OA\Items(ref="#/components/schemas/FieldSettingBulkItem")
* )
* )
*/
public function _fieldSchemasNoop() {}
/**
* Option Group/Value 스키마
*
@@ -223,100 +158,7 @@ public function _profileSchemasNoop() {}
/**
* @OA\Get(
* path="/api/v1/fields",
* summary="효과값 필드 목록",
* description="전역 필드 정의와 테넌트 설정을 병합한, 실제 화면 노출용(Enabled) 필드 목록을 반환합니다.",
* tags={"Tenant.Fields"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
*
* @OA\Response(
* response=200,
* description="성공",
*
* @OA\JsonContent(allOf={
*
* @OA\Schema(ref="#/components/schemas/ApiResponse"),
* @OA\Schema(@OA\Property(property="data", type="array",
*
* @OA\Items(ref="#/components/schemas/FieldEffective")
* ))
* })
* ),
*
* @OA\Response(response=401, description="인증 실패", @OA\JsonContent(ref="#/components/schemas/ErrorResponse")),
* @OA\Response(response=403, description="권한 없음", @OA\JsonContent(ref="#/components/schemas/ErrorResponse")),
* @OA\Response(response=500, description="서버 에러", @OA\JsonContent(ref="#/components/schemas/ErrorResponse"))
* )
*/
public function fieldsIndex() {}
/**
* @OA\Put(
* path="/api/v1/fields/bulk",
* summary="필드 설정 대량 저장",
* description="여러 필드에 대해 enabled/required/sort_order/option_group_id/code_group 설정을 한번에 저장합니다.",
* tags={"Tenant.Fields"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
*
* @OA\RequestBody(required=true, @OA\JsonContent(ref="#/components/schemas/FieldSettingBulkRequest")),
*
* @OA\Response(
* response=200,
* description="저장 성공",
*
* @OA\JsonContent(allOf={
*
* @OA\Schema(ref="#/components/schemas/ApiResponse"),
* @OA\Schema(@OA\Property(property="data", type="object", example={"updated":true}))
* })
* ),
*
* @OA\Response(response=400, description="유효성 오류", @OA\JsonContent(ref="#/components/schemas/ErrorResponse")),
* @OA\Response(response=401, description="인증 실패", @OA\JsonContent(ref="#/components/schemas/ErrorResponse")),
* @OA\Response(response=403, description="권한 없음", @OA\JsonContent(ref="#/components/schemas/ErrorResponse")),
* @OA\Response(response=500, description="서버 에러", @OA\JsonContent(ref="#/components/schemas/ErrorResponse"))
* )
*/
public function fieldsBulk() {}
/**
* @OA\Patch(
* path="/api/v1/fields/{key}",
* summary="필드 설정 단건 수정",
* description="특정 field_key에 대한 테넌트 설정을 수정합니다.",
* tags={"Tenant.Fields"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
*
* @OA\Parameter(
* name="key", in="path", required=true,
* description="수정할 필드 키", @OA\Schema(type="string", example="position")
* ),
*
* @OA\RequestBody(required=true, @OA\JsonContent(ref="#/components/schemas/FieldSettingUpdateRequest")),
*
* @OA\Response(
* response=200,
* description="수정 성공",
*
* @OA\JsonContent(allOf={
*
* @OA\Schema(ref="#/components/schemas/ApiResponse"),
* @OA\Schema(@OA\Property(property="data", ref="#/components/schemas/FieldEffective"))
* })
* ),
*
* @OA\Response(response=400, description="유효성 오류", @OA\JsonContent(ref="#/components/schemas/ErrorResponse")),
* @OA\Response(response=401, description="인증 실패", @OA\JsonContent(ref="#/components/schemas/ErrorResponse")),
* @OA\Response(response=403, description="권한 없음", @OA\JsonContent(ref="#/components/schemas/ErrorResponse")),
* @OA\Response(response=404, description="필드 없음", @OA\JsonContent(ref="#/components/schemas/ErrorResponse")),
* @OA\Response(response=500, description="서버 에러", @OA\JsonContent(ref="#/components/schemas/ErrorResponse"))
* )
*/
public function fieldsUpdateOne() {}
/**
* @OA\Get(
* path="/api/v1/opt-groups",
* path="/api/v1/settings/options",
* summary="옵션 그룹 목록",
* description="해당 테넌트의 옵션 그룹 목록을 페이징으로 반환합니다.",
* tags={"Tenant.Option Groups"},
@@ -349,7 +191,7 @@ public function optGroupsIndex() {}
/**
* @OA\Post(
* path="/api/v1/opt-groups",
* path="/api/v1/settings/options",
* summary="옵션 그룹 생성",
* description="옵션 그룹을 생성합니다.",
* tags={"Tenant.Option Groups"},
@@ -371,7 +213,7 @@ public function optGroupsStore() {}
/**
* @OA\Get(
* path="/api/v1/opt-groups/{id}",
* path="/api/v1/settings/options/{id}",
* summary="옵션 그룹 단건 조회",
* tags={"Tenant.Option Groups"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
@@ -392,7 +234,7 @@ public function optGroupsShow() {}
/**
* @OA\Patch(
* path="/api/v1/opt-groups/{id}",
* path="/api/v1/settings/options/{id}",
* summary="옵션 그룹 수정",
* tags={"Tenant.Option Groups"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
@@ -415,7 +257,7 @@ public function optGroupsUpdate() {}
/**
* @OA\Delete(
* path="/api/v1/opt-groups/{id}",
* path="/api/v1/settings/options/{id}",
* summary="옵션 그룹 삭제",
* tags={"Tenant.Option Groups"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
@@ -436,7 +278,7 @@ public function optGroupsDestroy() {}
/**
* @OA\Get(
* path="/api/v1/opt-groups/{gid}/values",
* path="/api/v1/settings/options/{gid}/values",
* summary="옵션 값 목록",
* tags={"Tenant.Option Values"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
@@ -458,7 +300,7 @@ public function optionValuesIndex() {}
/**
* @OA\Post(
* path="/api/v1/opt-groups/{gid}/values",
* path="/api/v1/settings/options/{gid}/values",
* summary="옵션 값 생성",
* tags={"Tenant.Option Values"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
@@ -481,7 +323,7 @@ public function optionValuesStore() {}
/**
* @OA\Get(
* path="/api/v1/opt-groups/{gid}/values/{id}",
* path="/api/v1/settings/options/{gid}/values/{id}",
* summary="옵션 값 단건 조회",
* tags={"Tenant.Option Values"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
@@ -503,7 +345,7 @@ public function optionValuesShow() {}
/**
* @OA\Patch(
* path="/api/v1/opt-groups/{gid}/values/{id}",
* path="/api/v1/settings/options/{gid}/values/{id}",
* summary="옵션 값 수정",
* tags={"Tenant.Option Values"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
@@ -527,7 +369,7 @@ public function optionValuesUpdate() {}
/**
* @OA\Delete(
* path="/api/v1/opt-groups/{gid}/values/{id}",
* path="/api/v1/settings/options/{gid}/values/{id}",
* summary="옵션 값 삭제",
* tags={"Tenant.Option Values"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},
@@ -549,7 +391,7 @@ public function optionValuesDestroy() {}
/**
* @OA\Patch(
* path="/api/v1/opt-groups/{gid}/values/reorder",
* path="/api/v1/settings/options/{gid}/values/reorder",
* summary="옵션 값 정렬 순서 일괄 변경",
* tags={"Tenant.Option Values"},
* security={{"ApiKeyAuth": {}},{"BearerAuth": {}}},