395 lines
29 KiB
Markdown
395 lines
29 KiB
Markdown
<!--
|
||
GENERATED BY KRI AGENT HARNESS. DO NOT EDIT DIRECTLY.
|
||
Project: ksif-manage-back
|
||
Schema version: 1
|
||
Edit the source fragments or repository .agent files, then recompose.
|
||
-->
|
||
|
||
# KRI Development Base Instructions
|
||
|
||
This document defines the shared working rules for KRI development repositories.
|
||
Keep project-specific facts and commands in the project profile and project rules.
|
||
|
||
## Instruction Resolution
|
||
|
||
Apply repository instructions in this order:
|
||
|
||
1. Base rules
|
||
2. Project-type rules
|
||
3. Technology-stack rules
|
||
4. Shared consumer contracts
|
||
5. Project-specific rules
|
||
6. The explicitly approved task scope
|
||
|
||
Later and more specific instructions may override earlier general instructions only within their stated scope.
|
||
|
||
- Apply a shared consumer contract only when `.agent/profile.yml` declares it.
|
||
- Do not silently resolve a material instruction conflict. Report the conflicting rules and request a decision before changing files.
|
||
- Rules involving destructive actions, credentials, external systems, production, deployment, databases, or Git publication require explicit authorization even when a later rule is less restrictive.
|
||
|
||
## Communication
|
||
|
||
- Respond to the user in Korean unless the user requests another language.
|
||
- Keep code identifiers, commands, paths, protocol names, and external API terms in their original form.
|
||
- Follow the repository's existing language conventions for code comments and user-facing messages.
|
||
- Lead with the result or decision, then provide only the detail needed to verify it.
|
||
- Do not create or retain a full session transcript.
|
||
|
||
## Work Authorization
|
||
|
||
- The default workflow is discussion first and explicit execution approval second.
|
||
- During discussion, perform only read-only investigation needed to understand the task and propose a concrete plan, unless the user prohibits inspection.
|
||
- Read-only investigation may include file inspection, code search, encoding checks, `git status`, `git diff`, `git log`, and sanitized official-documentation lookup.
|
||
- Before execution approval, do not edit files, install dependencies, run builds or tests, start services, connect to databases, or change local or external state.
|
||
- Before requesting approval, describe the intended scope, affected areas, validation plan, and material risks.
|
||
- Treat approval as limited to the presented scope. Pause and discuss again if the work materially expands.
|
||
- If the user explicitly requests immediate execution without prior discussion, the discussion gate may be skipped for the stated scope.
|
||
- Fast-track authorization does not implicitly authorize protected operations such as destructive commands, production changes, deployments, database mutations, Git publication, or external messages.
|
||
|
||
## Local Development Environment
|
||
|
||
- Primary OS: Windows 11.
|
||
- Primary shell: PowerShell.
|
||
- Use Git Bash only when the repository already depends on Bash or POSIX shell behavior.
|
||
- Prefer repository-provided wrappers and scripts over globally installed commands.
|
||
- Do not assume that GNU utilities, WSL, Docker, or a Unix-compatible shell are available unless the project profile confirms them.
|
||
- Detect Java, Node.js, .NET, Python, package-manager, and database-tool versions from repository configuration.
|
||
- Do not install or modify global toolchains as part of a project task.
|
||
|
||
Preferred human-facing tools:
|
||
|
||
- Classic ASP: Visual Studio Code
|
||
- Java and Spring Boot: IntelliJ IDEA
|
||
- C# and .NET: JetBrains Rider
|
||
- JavaScript, TypeScript, and Next.js: JetBrains WebStorm
|
||
- Python: JetBrains PyCharm
|
||
- Microsoft SQL Server: SQL Server Management Studio
|
||
- Other databases: JetBrains DataGrip
|
||
|
||
- These preferences do not authorize launching or controlling a GUI application.
|
||
- Prefer IDE-independent commands that can also run in CI.
|
||
- Do not modify global IDE settings.
|
||
- Do not create or modify `.idea`, `.vscode`, workspace, or run-configuration files unless the approved task requires it.
|
||
- Preserve existing shared IDE configuration when it is already tracked.
|
||
|
||
## PowerShell and Path Safety
|
||
|
||
- Quote paths containing spaces, brackets, parentheses, Korean characters, or PowerShell metacharacters.
|
||
- Prefer `-LiteralPath` when operating on an exact filesystem path.
|
||
- Use project-relative paths in committed configuration and documentation. Do not commit machine-specific paths such as `D:\_____Dev\...`.
|
||
- Do not pass filesystem targets between PowerShell, `cmd.exe`, and Bash for destructive or recursive operations.
|
||
- Keep a filesystem operation within one shell from target resolution through execution.
|
||
- Before a recursive delete or move, resolve and verify every absolute target.
|
||
- Never use a drive root, workspace root, user profile, unresolved variable, wildcard, or broad glob as a recursive delete target.
|
||
- Prefer recoverable operations when practical.
|
||
|
||
## Change Discipline
|
||
|
||
- Preserve all existing user changes, including uncommitted and untracked work.
|
||
- Keep changes minimal but complete for the approved objective.
|
||
- Avoid unrelated cleanup, formatting, renaming, dependency upgrades, and architectural refactoring.
|
||
- Do not overwrite or revert unrelated changes.
|
||
- Stop and report when the requested change overlaps existing work in a way that cannot be handled safely.
|
||
- Prefer changing an authoritative source over editing generated output.
|
||
- Treat files marked as generated as read-only unless regeneration is part of the approved plan.
|
||
- Do not edit vendored dependencies, build outputs, caches, or generated clients unless explicitly required.
|
||
- Do not regenerate a broad set of files for a narrow change without first explaining the expected output scope.
|
||
|
||
## Text Encoding and Korean Content Safety
|
||
|
||
- Treat the existing file encoding, BOM state, and line-ending style as part of the file's contract.
|
||
- Preserve Korean comments, user-facing messages, error messages, identifiers, and documentation exactly unless the task explicitly requires changing them.
|
||
- Do not assume that garbled terminal output means the file itself is corrupted. Verify bytes and encoding before modifying suspicious text.
|
||
- Before editing an existing text file, determine its current encoding and BOM state when repository configuration does not already guarantee them.
|
||
- Do not convert encoding, add or remove a BOM, or normalize line endings as a side effect of an unrelated change.
|
||
- Avoid whole-file rewrites for small changes.
|
||
- Do not rewrite source files through `Get-Content | Set-Content`, `Out-File`, shell redirection, or another method whose encoding behavior is implicit.
|
||
- Do not use a patching or formatting tool on a non-UTF-8 file unless it is known to preserve that file's encoding.
|
||
- Treat a console display problem and an on-disk encoding problem as separate issues.
|
||
- After editing Korean text, inspect the diff for replacement characters (`<60>`), mojibake, unexpected escapes, BOM changes, and unrelated line-ending changes.
|
||
- Run `.agent/tools/check-encoding.ps1` when it is available and the change touches Korean text or a non-default encoding.
|
||
- If encoding cannot be identified confidently, stop before writing and report the affected file and evidence.
|
||
- For a new text file, follow repository configuration. If no rule exists, use UTF-8 without BOM.
|
||
|
||
## Git Safety
|
||
|
||
- Use `git status`, `git diff`, and `git log` for read-only investigation.
|
||
- Do not run `commit`, `push`, `pull`, `fetch`, `merge`, `rebase`, `reset`, `checkout`, `switch`, `stash`, `clean`, `tag`, or force operations unless that specific operation is explicitly approved.
|
||
- Source-edit approval does not include commit or push approval.
|
||
- Never amend an existing commit unless explicitly requested.
|
||
- Before an approved commit, show the intended files, validation results, and proposed commit message.
|
||
- Never push directly to a protected branch unless the user names the target branch and explicitly authorizes the push.
|
||
|
||
## Dependencies and External Actions
|
||
|
||
- Use the package manager, lockfile, and toolchain already selected by the repository.
|
||
- Do not install global packages.
|
||
- Do not add, remove, or upgrade a dependency unless it was included in the approved plan.
|
||
- Pause for approval if an unplanned dependency becomes necessary.
|
||
- Keep lockfiles synchronized with approved dependency changes.
|
||
- Do not deploy, publish packages, create releases, send messages or email, call business APIs, or modify external services unless explicitly requested.
|
||
- Never upload proprietary source code, internal documents, credentials, customer data, or database contents to an external service.
|
||
- Remove secrets and unnecessary internal identifiers from external search queries.
|
||
|
||
## Database Safety
|
||
|
||
- Treat writing or reviewing SQL as source code separately from executing SQL against a database.
|
||
- SQL files, migrations, schema proposals, and query drafts may be created within an approved source-change scope.
|
||
- Do not connect to a shared, staging, or production database without explicit authorization for that environment.
|
||
- Read-only queries against a non-local database also require authorization because results may contain sensitive data.
|
||
- Do not execute DDL, DML, stored procedures, migrations, administrative commands, or data-correction scripts against a non-disposable database without separate authorization for the exact target and operation.
|
||
- Source-change approval does not authorize migration execution.
|
||
- Use a disposable local or test database for approved validation only after verifying its identity and disposable nature.
|
||
- Never place credentials, connection strings, or sensitive query results in source files, logs, generated documents, or chat output.
|
||
|
||
## Secrets and Sensitive Data
|
||
|
||
- Never add credentials, tokens, passwords, private keys, connection strings, session identifiers, or production data to source control.
|
||
- Read sensitive files only when the approved task requires it and no safer source exists.
|
||
- Prefer inspecting configuration keys and schemas without displaying secret values.
|
||
- Never echo secrets into terminal output, chat responses, logs, diffs, generated documents, test fixtures, or screenshots.
|
||
- Redact sensitive values when reporting errors or command output.
|
||
- If a possible secret is discovered, do not repeat it. Report only its location, type, and recommended containment action.
|
||
- Do not rotate, revoke, copy, or otherwise modify credentials unless that exact action is explicitly authorized.
|
||
|
||
## Validation
|
||
|
||
- Discover supported build, test, lint, type-check, and formatting commands from repository files and project instructions. Do not invent commands.
|
||
- Include intended validation in the discussion-phase plan.
|
||
- After approved changes, run the narrowest relevant validation first, then broader checks when appropriate.
|
||
- Limit formatting to files within the approved scope.
|
||
- Do not run tests that require a shared database, production service, paid external API, or sensitive data unless separately authorized.
|
||
- Do not claim that a check passed unless it was executed successfully.
|
||
- If a check cannot be run, state the exact reason.
|
||
- Distinguish a current-change failure from a pre-existing failure or an undetermined failure.
|
||
- Do not fix unrelated failures without expanding the approved scope.
|
||
- Inspect the worktree after validation for unexpected generated files, formatting churn, encoding changes, or lockfile changes.
|
||
|
||
## Artifacts and Session Records
|
||
|
||
- Do not create full-session transcripts, automatic HTML copies, analysis reports, or extra documentation unless explicitly requested.
|
||
- Store durable information in the repository's existing documentation structure.
|
||
- Do not place generated reports or temporary analysis files in the repository root.
|
||
- Remove task-specific temporary files created by the current task after validation when removal is safe.
|
||
|
||
## Completion Report
|
||
|
||
When implementation is complete, report in Korean:
|
||
|
||
- what changed and why;
|
||
- the main affected files or components;
|
||
- validation commands actually executed and their results;
|
||
- checks not executed and the reason;
|
||
- remaining risks, assumptions, or follow-up work;
|
||
- database, deployment, dependency, encoding, and compatibility impact when applicable.
|
||
|
||
- Do not report completion while required validation is failing or known encoding corruption is unresolved.
|
||
- Keep the report concise and do not include a full session transcript.
|
||
|
||
## Requested Project Rules
|
||
|
||
- Treat the approved requirements, acceptance criteria, and recorded decisions as the primary scope boundary.
|
||
- Do not infer a requirement solely from a file name, folder date, or apparently newer document.
|
||
- When requirements conflict, report the exact sources and request a decision.
|
||
- Preserve original customer, partner, and planning documents as read-only evidence unless document editing is explicitly approved.
|
||
- Summarize durable implementation requirements inside the repository rather than relying only on files outside the repository.
|
||
- Do not expand the deliverable with speculative features, infrastructure, or architectural changes.
|
||
- Record material assumptions and unresolved decisions in the project-specific rules or existing project documentation.
|
||
- Define observable acceptance criteria before implementation.
|
||
- Treat separately managed Frontend and Backend repositories as independent deliverables with a coordinated contract.
|
||
- Protect customer, partner, survey, and field data as sensitive information.
|
||
- Keep handoff, operation, configuration, and validation instructions usable by the requesting team.
|
||
- Report deviations from the requested scope and obtain approval before proceeding.
|
||
|
||
## Java and Spring Boot
|
||
|
||
- Treat the configured JDK, Spring Boot, Gradle, plugin, dependency, and package versions as authoritative.
|
||
- Use the repository's Gradle Wrapper. Do not substitute a machine-global Gradle installation.
|
||
- Preserve the established package layout and controller, application/service, domain, and persistence boundaries.
|
||
- Keep controllers thin, place business rules in the established service/domain layer, and prefer constructor injection.
|
||
- Apply request and configuration validation at boundaries and preserve the project's exception and response conventions.
|
||
- Make transaction boundaries explicit and narrow; do not add broad transactions to hide lifecycle or query problems.
|
||
- Preserve authentication, authorization, auditing, logging, and secret-management conventions.
|
||
- Do not edit generated QueryDSL or other generated sources. Change their source definitions and regenerate only when the repository workflow requires it.
|
||
- Use the approved KriCommon contract when the project profile includes it; do not duplicate shared backend behavior locally.
|
||
- Run the narrowest relevant Gradle compile, test, static-analysis, and build tasks.
|
||
|
||
## MySQL
|
||
|
||
- Use MySQL syntax and behavior only for data sources whose declared engine is `mysql`.
|
||
- Preserve the configured version, schema, character set, collation, time zone, naming, migration, and access conventions.
|
||
- Parameterize values. Do not build SQL by concatenating untrusted input.
|
||
- Consider indexes and execution plans for changed filters, joins, ordering, grouping, and pagination without guessing from small data sets.
|
||
- Preserve transaction, locking, null, date/time, decimal, and generated-key semantics.
|
||
- Do not introduce MSSQL or other dialect syntax into MySQL paths.
|
||
- A source-code change approval authorizes SQL analysis and migration drafting only. Execute DDL, DML, procedures, or migrations only with separate explicit approval and the declared data-source access level.
|
||
|
||
## KriCommon Consumer Contract
|
||
|
||
### Dependency and API Boundary
|
||
|
||
- Consume KriCommon as `com.kri.common:starter:<approved-version>` using the consumer repository's established Gradle dependency and version-management conventions.
|
||
- Import service-facing APIs from `com.kri.common.feature.*`. Treat `com.kri.common.runtime.*` as internal and do not bind application code to it unless no public API exists and the exception is explicitly documented.
|
||
- Include the matching Spring starter for any optional Web, Security, JPA, Redis, AOP, or Swagger integration the service enables; KriCommon intentionally declares many integrations as compile-only.
|
||
- Prefer the shared feature or an approved extension point over duplicating authentication, HTTP, error, enum, Excel, Redis, JSON, date/time, JPA, or utility behavior locally.
|
||
|
||
### Configuration and Overrides
|
||
|
||
- KriCommon configuration uses only `kri.*`. Established groups include `kri.auth.jwt`, `kri.auth.apikey`, `kri.security`, `kri.swagger`, `kri.web`, `kri.web.mdc`, `kri.http.bypass`, `kri.redis`, `kri.scheduling`, and `kri.error.expose`.
|
||
- Read the version-matched README and configuration-property classes before setting a property; do not infer a property name or default from an older service.
|
||
- Supply production JWT secrets, API keys, credentials, allowlists, and service URLs through the consumer's approved secret and configuration system. Never rely on library example or default secrets in production.
|
||
- Preserve consumer override points. KriCommon's default security chain is created only when the consumer does not provide one, and overridable beans should remain explicit.
|
||
- Adding a path to API-key allowed paths scopes where API-key authentication is attempted; it does not make the path public or grant authorization.
|
||
|
||
### Major Optional Capabilities
|
||
|
||
- JWT and API-key authentication integrate with Spring Security. API-key JPA preload requires Spring Data JPA; a consumer-provided claims provider can be used without JPA.
|
||
- Common Web may register error handling, tracing/MDC, request-user resolution, enum conversion, and CORS behavior. Check for overlap before defining consumer-local equivalents.
|
||
- Swagger support requires springdoc and defines the shared Bearer/API-key schemes and grouped paths.
|
||
- Redis and scheduling are opt-in through their `kri.*.enabled` settings and matching runtime dependencies.
|
||
- HTTP bypass targets are server-configured. Never accept an arbitrary full target URL from a frontend; retain allowed-path checks and do not forward hop-by-hop headers.
|
||
- The external API client returns response bodies as documented, while bypass responses preserve raw bytes and target `Content-Type`.
|
||
- `ExternalApiClient` multipart requests generate their own boundary and ignore a caller-supplied `Content-Type`. Multipart headers and `formField` values use UTF-8, while file bodies preserve the supplied bytes.
|
||
- Multipart filenames, including non-ASCII names, are sent unchanged in the quoted `filename` parameter as raw UTF-8. No ASCII fallback or `filename*` parameter is added; CR/LF rejection and quote/backslash escaping still apply.
|
||
- `JsonUtil` requires the consumer's explicit `ObjectMapper`; shared date/time helpers define KST as `Asia/Seoul` and also expose UTC semantics.
|
||
|
||
### Project Instruction Budget
|
||
|
||
- Keep `.agent/project.md` at or below 9 KiB (9,216 bytes) as the normal target. Do not delete material rules merely to meet the budget; move schema details, query or procedure inventories, API examples, and migration history to linked project documentation, and keep concise read-routing instructions here.
|
||
|
||
### Upgrade and Verification
|
||
|
||
- Review KriCommon release notes, README changes, configuration defaults, auto-configuration conditions, and affected public APIs before upgrading.
|
||
- Commit dependency-lock or resolved-version changes according to the consumer repository's policy.
|
||
- Run the consumer's focused compile and tests after an upgrade, including application-context startup tests when auto-configuration or security behavior is affected.
|
||
- Do not modify KriCommon or another consumer repository unless it is explicitly included in the approved task scope.
|
||
|
||
# KSIF Manage Backend
|
||
|
||
## Generated Spring Boot Repository Rules
|
||
|
||
- This backend application was generated by `@kri/create-spring-app` with Java 17 and Spring Boot 3.5.7.
|
||
- Consume KriCommon through `com.kri.common:starter:beta.1.6.4`; do not change that approved version or duplicate shared behavior without explicit approval.
|
||
- The selected primary database is `mysql`. Preserve its configured dialect, driver, transaction, schema, and migration conventions.
|
||
- Keep controllers thin and preserve the generated service, DTO, persistence, configuration, QueryDSL, JDBC, and optional MyBatis boundaries.
|
||
- `AGENTS.md` and `CLAUDE.md` are central-harness generated outputs. Never edit them directly; update `.agent/profile.yml` or `.agent/project.md` and recompose.
|
||
- After every `.agent/project.md` change, run `cd "D:\_____Dev\_________AgentHarnessBase"`, then `.\scripts\agent-harness.ps1 compose --project ksif-manage-back` and `.\scripts\agent-harness.ps1 verify --project ksif-manage-back` to keep the generated agent documents current and verified.
|
||
- Use the repository Gradle Wrapper and run `.\gradlew.bat compileJava` followed by focused tests for relevant changes.
|
||
|
||
## Project Rules
|
||
|
||
### Data Sources
|
||
- Internal DB: JPA
|
||
- External survey DB: MyBatis
|
||
- No physical FK constraints.
|
||
|
||
### Roles
|
||
- `1001`, `2001`: Admin with the same capabilities for the current scope.
|
||
- `3001`: Center
|
||
- Center users are restricted to their own `center_cd`.
|
||
- Resolve a Center user's `center_cd` from the internal user record when it is not present in the shared request-user claims.
|
||
- `center_cd = 0` is the project-wide code for the real aggregate `t_center` row named `전체`; do not synthesize this row in application code.
|
||
|
||
### Reports
|
||
Progress:
|
||
- Calculated in real time from the external survey DB.
|
||
- Never use `t_report_final_data`.
|
||
- Backend calculates 7-point and 100-point scores.
|
||
- The backend owns the MyBatis Mapper interface, DTO contract, SQL, service call, and response assembly. The approved external survey source is fixed to `PKEY = '2605040_A'`, excludes `SURVEY_TYPE = 'TEST'`, and requires `Status = 10`.
|
||
- Use only `ReportHeaderType.CURRENT` headers. A nonblank `kon_qid` maps to `$.{prefix}.{kon_qid}`, where `prefix` is the substring before `_`, or the full value when `_` is absent.
|
||
- Header `1001` is a special composite score with no `kon_qid`; calculate it in the external survey SQL and return it through the same metric contract.
|
||
- The source variables used by the `1001` formula are assumed to be non-null values in the `1..7` range. Do not add null or range conditions to that special calculation.
|
||
|
||
Final:
|
||
- Read pre-calculated values from `t_report_final_data`.
|
||
- Do not recalculate during normal requests.
|
||
- Admin imports final data through an Excel upload.
|
||
- Upsert only the Centers represented by uploaded rows and retain all other Centers' existing final data.
|
||
- Store `completeCount` in `t_center.center_final_sample`.
|
||
- Treat blank cells and `-` as absent values and delete the matching existing `t_report_final_data` value for that uploaded Center.
|
||
- Excel columns are `centerCd`, `completeCount`, followed by `report_header_id` values used as column headers.
|
||
- Use only `ReportHeaderType.FINAL` headers for Final responses and Excel validation.
|
||
- Validate every header ID, Center code, row shape, and value before applying the workbook atomically.
|
||
|
||
Header hierarchy:
|
||
`report_header_group → variable_group → variable_name → report_header_label`
|
||
|
||
- Order by `report_header_order`.
|
||
- 7-point/100-point share one logical header.
|
||
- Report endpoints are not paginated.
|
||
- The initial and currently supported report filter is optional `centerCd`; keep the request boundary extensible for future filters.
|
||
- For Progress, Admin requests with absent `centerCd` or `centerCd = 0` return the aggregate row followed by all Centers. A specific Admin `centerCd` returns only that Center. Center users receive only their own Center.
|
||
- For Final, Admin requests with absent `centerCd` or `centerCd = 0` return the aggregate row followed by all Centers. A specific Admin `centerCd` returns the aggregate row followed by that Center. Center users receive the aggregate row followed by their own Center.
|
||
- Return `headers` and `content`. Each content row contains `centerCd`, `centerName`, `targetCount`, `completeCount`, and ordered `values`.
|
||
- For the aggregate `centerCd = 0` row, calculate counts at query time instead of using the stored aggregate-row values. `targetCount` is the sum of `center_quota` across all nonzero Centers. Progress `completeCount` is the external survey query's aggregate count, while Final `completeCount` is the sum of `center_final_sample` across all nonzero Centers.
|
||
- Each value contains `headerId`, nullable `value7`, and nullable `value100`.
|
||
- Progress returns the available 7-point and 100-point values from MyBatis. Final returns `value7 = null` and the stored final value as `value100`.
|
||
|
||
### Notice / Popup
|
||
- 0 center mappings = all Centers.
|
||
- 1+ mappings = mapped Centers only.
|
||
- Use soft delete where provided.
|
||
- Store Center-level view history separately in `t_notice_view` and `t_popup_view`; target mapping tables describe visibility only.
|
||
- Record a Notice or Popup view for the current Center without changing its target mappings.
|
||
- A viewed active Popup remains eligible for subsequent responses; view history is informational and does not suppress it.
|
||
- Popup periods are entered and stored with minute precision. Active lookup uses `start_dt <= now` and `end_dt > now - 1 minute`, so the selected start minute begins normally and the selected end minute remains active through its final second.
|
||
- Notice and Popup bodies contain Tiptap HTML. Store and return the HTML unchanged and do not add a backend HTML-sanitizer dependency for the current scope.
|
||
- Admin roles create, update, and delete Notices and Popups. Center users may read only content visible to their own Center.
|
||
|
||
### Q&A
|
||
- Question 1 : Answer 0..1.
|
||
- On first Center-user answer view, set:
|
||
`is_view_answer`, `view_user`, `view_dt`.
|
||
- Center users may access only their own Center's questions.
|
||
- A Center may not update or delete a Question while it has an active Answer.
|
||
- Admin roles may create, update, and delete an Answer only until a Center user has viewed it.
|
||
- Once `is_view_answer = 1`, the Answer may no longer be updated or deleted.
|
||
- Use soft delete for Questions and Answers where provided.
|
||
|
||
### Files
|
||
- Max 5 files.
|
||
- Max 5 MB each.
|
||
- Reject `.exe`.
|
||
- Separate storage locations:
|
||
`notice`, `qna-question`, `qna-answer`.
|
||
|
||
### Pagination
|
||
- Use KriCommon `PageResponseDto` for Notice, Q&A Question, and Admin Popup lists.
|
||
- Default to `page = 0`, `size = 20`, ordered by registration date descending.
|
||
- Apply role, Center, target, and soft-delete filters in the database query before pagination.
|
||
- Their `POST .../search` bodies extend the shared page request with optional `searchKeyword` and `targetCenterCds`. Match `searchKeyword` against the row ID, title, or registration user with OR-connected contains searches. Match `targetCenterCds` with IN semantics; always include rows targeting all Centers (`0` for Q&A and no target mappings for Notice/Popup). Null or empty filters apply no additional restriction.
|
||
- Q&A Question list sorting additionally accepts virtual fields `answerDt` and `viewDt`. Sort `answerDt` by the active Answer's `reg_dt` and `viewDt` by the active Answer's `view_dt`, using a left join so Questions without an Answer or Answer view remain in the page result.
|
||
- Report endpoints do not use pagination.
|
||
|
||
### Excel
|
||
- Do not implement backend Excel-download endpoints.
|
||
- The frontend will export the current screen query/filter result after the backend APIs are complete.
|
||
- Final Report Excel upload remains a backend Admin capability as defined in the Reports rules.
|
||
|
||
### API Boundaries
|
||
- Authentication is already implemented and is outside the current API-development scope.
|
||
- Provide screen-oriented endpoints for Progress Report, Final Report, Notice, Q&A Question/Answer, menu exposure, and Popup management.
|
||
- Keep controllers thin and enforce role and Center access again in the service layer.
|
||
- Store registration, modification, deletion, answer-view, notice-view, and popup-view timestamps as KST `LocalDateTime` values according to the existing project convention.
|
||
|
||
### System Event Logs
|
||
- Controllers write a system event log after each successful create, update, delete, or upload operation.
|
||
- Event codes use the hundreds digit for the major category, tens digit for the minor category, and ones digit for the action.
|
||
- Action digits are `1 = insert`, `2 = update`, `3 = delete`, and `4 = upload`.
|
||
- Major categories are `2xx = Report`, `3xx = Notice`, `4xx = Q&A`, `5xx = Popup`, and `6xx = Menu`.
|
||
- Q&A minor categories are `41x = Question` and `42x = Answer`.
|
||
- Log resource identifiers and aggregate counts; do not log HTML bodies or uploaded file contents.
|
||
|
||
### Report Code Enums
|
||
- Manage `report_header_type` as `ReportHeaderType implements CodeEnum<Short>` with `1 = CURRENT`, `2 = FINAL`.
|
||
- Persist `ReportHeaderType` through an explicit JPA code converter so the existing `smallint` schema remains unchanged.
|
||
- `report_value_type`, `round_point`, and `kon_deny_value` have been removed from `t_report_header`.
|
||
- `report_value_type` and `round_point` have also been removed from the report API header response; `kon_deny_value` was not exposed by the API.
|
||
|
||
### Do Not Assume
|
||
Ask before implementing undefined:
|
||
- future differences between Admin `1001` / `2001`
|
||
- report filters beyond `centerCd`
|
||
- progress-report scoring formulas and external survey SQL
|
||
- behavior that is not present in the approved API and screen contracts
|