Files
annotations/_docs/02_document/components/01_annotations-rest/description.md
T
Oleksandr Bezdieniezhnykh 03f879206e docs+src: complete Steps 1-3 outcomes + auth re-sync baseline
This commit captures everything produced during autodev existing-code
Steps 1 (Document), 2 (Architecture Baseline Scan), and 3 (Test Spec),
together with the targeted auth + CORS re-sync triggered on 2026-05-14
when codebase drift was detected at Step 4 entry. None of this work was
previously committed.

Step 1 (Document) — 50+ _docs/02_document/ files: problem, solution,
architecture, system flows, glossary, module-layout, per-component
specs (01..06), modules, deployment, diagrams, data model, FINAL
report, verification log, discovery.

Step 2 (Architecture Baseline) — architecture_compliance_baseline.md.
Verdict PASS_WITH_WARNINGS (0 Critical, 0 High, 1 Medium, 2 Low). No
High/Critical findings; auto-chained to Step 3 per existing-code flow.

Step 3 (Test Spec) — _docs/02_document/tests/* (67 scenarios across
blackbox, security, resilience, resource-limit, performance), plus
e2e/docker-compose.test.yml, e2e/seed/run.sh, scripts/run-tests.sh,
scripts/run-performance-tests.sh. Coverage 88% over the active scope
(40 of 45 items covered, 6 RB-deferred, 5 documented-as-uncovered).

Targeted auth + CORS re-sync — replaces the deleted in-house token
issuer with a JWKS-verifier model. AuthController and TokenService
removed; JwtExtensions switched from HS256 symmetric to ES256 over
admin's JWKS. ConfigurationResolver and CorsConfigurationValidator
added under src/Infrastructure/. ADR-002 and ADR-006 retired; SEC-01,
SEC-02, SEC-03 marked Closed. One new testability risk recorded in
architecture.md Open Risks Section 6 (JWKS HTTPS gating).

Source changes:
- src/Auth/JwtExtensions.cs (modified) — ES256, JWKS, alg pinning
- src/Program.cs (modified) — DI wiring for ConfigurationResolver
  and CorsConfigurationValidator
- src/Controllers/AuthController.cs (deleted) — no in-service issuance
- src/Services/TokenService.cs (deleted) — same
- src/Infrastructure/ConfigurationResolver.cs (new)
- src/Infrastructure/CorsConfigurationValidator.cs (new)
- .env.example (new) — required env var documentation
- .gitignore (updated)

Cross-repo coordination: _docs/cross-repo/flights_h1_h2_h3_change_spec
captures the change-spec for downstream services that consumed the now
deleted /auth endpoints.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-14 20:19:05 +03:00

2.1 KiB
Raw Blame History

Annotations (REST & files)

1. High-Level Overview

Purpose: HTTP API for annotation CRUD, status, listing, and serving annotation image / thumbnail bytes — the surface described in suite/_docs/01_annotations.md §16 (excluding the SSE stream).

Architectural pattern: Layered API — controller → application service → database + filesystem.

Upstream dependencies: Platform (DB, auth, paths), Media (annotation create may reference existing MediaId).

Downstream consumers: Annotator UI, Detections pipeline (HTTP POST annotations), Dataset (read-only overlap on entities).

2. Internal interfaces

Primary application API: AnnotationService — create/update/status/delete/query/get-by-id; uses PathResolver, AppDataConnection, hashing, label files, thumbnails, and triggers real-time publish (calls into AnnotationEventService) and queue enqueue (via failsafe path — see component 02).

Controller: AnnotationsControllerREST and file routes; the GET …/events SSE action is specified and operated from the Annotations realtime & sync component (same source file, split responsibility for docs).

Representative HTTP

Area Routes (policy ANN)
CRUD POST/PUT/PATCH/DELETE/GET under /annotations
Files GET /annotations/{id}/thumbnail, GET /annotations/{id}/image

3. External API specification

See 01_annotations.md §16; confirm drift notes in 00_discovery.md (JWT user id, FlightId vs suite missionId).

4. Data access patterns

Heavy use of annotations, detection, media joins for list filters; writes cascade detections on update.

5. Implementation notes

  • Annotation id from image hash when bytes provided; else copy from existing media path.
  • TimeSpan persisted as ticks on Annotation.

6. Dependency graph (relative to other components)

Imports from: Platform, Media (logical). Consumed by: Dataset (read), UI, external Detections service.

7. Modules included

annotations-service (module doc); shared file AnnotationsController.cs with component 02 for SSE action only.