Skip to content

chore(docs): close SI-1 through SI-5 issue specs and update EPIC #1938 - #1960

Merged
josecelano merged 2 commits into
torrust:developfrom
josecelano:1938-rest-api-contract-first-cleanup
Jun 29, 2026
Merged

chore(docs): close SI-1 through SI-5 issue specs and update EPIC #1938#1960
josecelano merged 2 commits into
torrust:developfrom
josecelano:1938-rest-api-contract-first-cleanup

Conversation

@josecelano

@josecelano josecelano commented Jun 29, 2026

Copy link
Copy Markdown
Member

Description

This PR cleans up the issue specs for EPIC #1938 (REST API Contract-First Migration) now that SI-1 through SI-5 have been implemented and closed.

Changes

  • Move closed specs: SI-1 through SI-5 moved from docs/issues/open/ to docs/issues/closed/
  • Update frontmatter: status, spec-path, closure dates for all moved specs
  • Fix stale references: all docs/issues/drafts/ references updated to point to docs/issues/open/1938-rest-api-contract-first-migration/EPIC.md
  • Update EPIC.md: status, context summary, sub-issue links, dependency removal tracking, progress log, success criteria
  • Add SI-7 spec (SI-7: Review tests and align v1 namespace across REST API packages #1959): for the remaining cleanup tasks (test relocation + v1 namespace alignment)

Related issues

@josecelano
chore(docs): close SI-1 through SI-5 issue specs and update EPIC torr…
a05d601 
…ust#1938

- Move closed issue specs from docs/issues/open/ to docs/issues/closed/
- Update frontmatter: status, spec-path, closure dates
- Fix stale 'docs/issues/drafts/' references in all affected specs
- Update EPIC.md: status, tables, sub-issue links, dependency tracking,
  progress log, success criteria to reflect completed migrations
- Fix 'drafts' reference in SI-6 spec
- Add SI-7 spec (torrust#1959) for post-migration code cleanup tasks
  (test relocation + v1 namespace alignment)
Copilot AI review requested due to automatic review settings June 29, 2026 18:38
@josecelano josecelano self-assigned this Jun 29, 2026
Copilot AI reviewed Jun 29, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the documentation issue-specs for EPIC #1938 (REST API contract-first migration) to reflect that SI-1 through SI-5 are closed, refreshes the EPIC tracking doc, and adds a new SI-7 spec for remaining cleanup work.

Changes:

  • Move SI-1 through SI-5 specs into docs/issues/closed/ and update their frontmatter + references.
  • Update the EPIC spec (#1938) to reflect completion status, closed sub-issues, and progress tracking.
  • Add SI-7 (#1959) spec and update SI-6 (#1944) spec to point at the EPIC’s current path.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/issues/open/1959-1938-si-7-review-tests-align-v1-namespace.md Adds SI-7 spec describing remaining test relocation + v1 namespace alignment work.
docs/issues/open/1944-1938-si-6-align-rest-api-client.md Updates stale EPIC reference from drafts to the current EPIC path.
docs/issues/open/1938-rest-api-contract-first-migration/EPIC.md Updates EPIC status/progress, marks SI-1..SI-5 closed, adds SI-7 tracking.
docs/issues/closed/1939-1938-si-1-migrate-health-check-context.md Marks SI-1 as closed and updates frontmatter/links.
docs/issues/closed/1940-1938-si-2-migrate-whitelist-context.md Marks SI-2 as closed and updates frontmatter/links.
docs/issues/closed/1941-1938-si-3-migrate-auth-key-context.md Marks SI-3 as closed and updates frontmatter/links.
docs/issues/closed/1942-1938-si-4-migrate-stats-context.md Marks SI-4 as closed and updates frontmatter/links + checklist status.
docs/issues/closed/1943-1938-si-5-deprecate-rest-api-core.md Marks SI-5 as closed and updates frontmatter/links.
Comments suppressed due to low confidence (5)

docs/issues/closed/1939-1938-si-1-migrate-health-check-context.md:10

  • The updated-reason frontmatter entry is indented, which makes it a nested key under last-updated-utc and invalid YAML. It should be a top-level key (no leading spaces). Also, frontmatter guidance uses status: done for closed issue specs (docs/issues/closed/1810-add-frontmatter-to-docs-markdown-files.md:125), so consider aligning this file’s status value.
    docs/issues/closed/1940-1938-si-2-migrate-whitelist-context.md:10
  • The updated-reason frontmatter entry is indented, which makes it a nested key under last-updated-utc and invalid YAML. It should be a top-level key (no leading spaces). Also, frontmatter guidance uses status: done for closed issue specs (docs/issues/closed/1810-add-frontmatter-to-docs-markdown-files.md:125), so consider aligning this file’s status value.
    docs/issues/closed/1941-1938-si-3-migrate-auth-key-context.md:10
  • The updated-reason frontmatter entry is indented, which makes it a nested key under last-updated-utc and invalid YAML. It should be a top-level key (no leading spaces). Also, frontmatter guidance uses status: done for closed issue specs (docs/issues/closed/1810-add-frontmatter-to-docs-markdown-files.md:125), so consider aligning this file’s status value.
    docs/issues/closed/1942-1938-si-4-migrate-stats-context.md:10
  • The updated-reason frontmatter entry is indented, which makes it a nested key under last-updated-utc and invalid YAML. It should be a top-level key (no leading spaces). Also, frontmatter guidance uses status: done for closed issue specs (docs/issues/closed/1810-add-frontmatter-to-docs-markdown-files.md:125), so consider aligning this file’s status value.
    docs/issues/closed/1943-1938-si-5-deprecate-rest-api-core.md:10
  • The updated-reason frontmatter entry is indented, which makes it a nested key under last-updated-utc and invalid YAML. It should be a top-level key (no leading spaces). Also, frontmatter guidance uses status: done for closed issue specs (docs/issues/closed/1810-add-frontmatter-to-docs-markdown-files.md:125), so consider aligning this file’s status value.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/issues/open/1938-rest-api-contract-first-migration/EPIC.md
Migrate all remaining REST API contexts (`health_check`, `whitelist`, `auth_key`, `stats`) from direct tracker-internal wiring to the contract-first layered architecture (protocol → application → runtime-adapter → axum transport), following the pattern validated by [SI-33 (#1930)](../../open/1930-1669-si-33-rest-api-contract-first-architecture.md) PoC.

## Why This Is Needed
All context migrations are **complete** (SI-1 through SI-5 closed). The only remaining open item is SI-6 (`ApiClient` high-level typed client).
@josecelano
fix(docs): correct YAML frontmatter in closed SI specs
7808d7e 
- Change status from 'completed' to 'done' per project convention
- Unindent 'updated-reason' to make it a top-level YAML key
@josecelano

josecelano commented Jun 29, 2026

Copy link
Copy Markdown
Member Author

ACK 7808d7e

@josecelano
josecelano merged commit ae3223a into torrust:develop Jun 29, 2026
1 check passed
@josecelano josecelano mentioned this pull request Jul 15, 2026
Merged
josecelano added a commit that referenced this pull request Jul 15, 2026
@josecelano
Merge #1984: chore(issues): archive 10 closed issue specs from docs/i…
9cdb3a7 
…ssues/open to docs/issues/closed

174904d chore(ci): point to ADR instead of closed issue spec in deployment-packages.yaml (Jose Celano)
2e2178f docs(skill): document branch-already-exists edge case in cleanup-completed-issues skill (Jose Celano)
1bfd306 chore(issues): archive closed issue specs #1447, #1459, #1505, #1926, #1938, #1944, #1959, #1964, #1965, #1969 to docs/issues/closed (Jose Celano)

Pull request description:

  Archives the following 10 issue specs that are closed on GitHub, moving them from `docs/issues/open/` to `docs/issues/closed/`:

  | Issue | Title | PR |
  |-------|-------|-----|
  | #1447 | Change logging threshold for connection ID error to WARNING | #1975 |
  | #1459 | Docker Security Overhaul | #1958 |
  | #1505 | Optimize peer IP list from swarm (implementation rejected) | #1949 |
  | #1926 | Define package versioning strategy | #1961 |
  | #1938 | REST API Contract-First Migration EPIC | #1960 (SI-1→5) |
  | #1944 | SI-6: Align REST API client | #1968 |
  | #1959 | SI-7: Review tests, align v1 namespace | #1963 |
  | #1964 | Rename number-of-downloads BTreeMap type alias | #1972 |
  | #1965 | SI-34: Consolidate duplicate HTTP types | #1974 |
  | #1969 | SI-8: Eliminate unwraps from REST API client | #1973 |

  ### Changes Made

  - All 10 specs verified `CLOSED` on GitHub with merged PRs
  - Files/directories moved via `git mv` to `docs/issues/closed/`
  - Frontmatter updated: `status: done`, `spec-path` → closed path, `last-updated-utc: 2026-07-15`
  - Workflow checkpoints updated and progress log entries added
  - Supplementary files in multi-file directories updated with new paths
  - Parent EPIC specs (#1669, #1938) updated: subissue status, spec paths, and table references
  - Fixed stale references in `.github/workflows/deployment-packages.yaml`, `docs/adrs/`, and `docs/issues/closed/` files
  - Pre-commit and pre-push hooks passed (linter, tests, doc-tests, nightly checks)

ACKs for top commit:
  josecelano:
    ACK 174904d

Tree-SHA512: c7e38354bb5898fc5125a0b68fd61a02ca273689593638eb3b955b9176038ef82c40fc98b0a2f722eb18d8d429d2f2dbb6f205eee3061211ab9906c5be46942b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

@josecelano josecelano

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@josecelano