Skip to content

[Docs] Document Sprint 3: archive behavior, issue filters, API contract updates #128

@mpaulosky

Description

@mpaulosky

Summary

Document the Sprint 3 changes — archive behavior, issue filter/search semantics, and any API contract changes — so that future contributors understand these features without reading the code.

Sections to Write / Update

1. docs/features/issues.md (update)

  • Document the filter/search params now supported by GET /api/v1/issues
    • page, pageSize, searchTerm, statusName, categoryName
  • Clarify that CreateIssueCommand and UpdateIssueCommand accept all fields (Title, Description, CategoryId, StatusId)
  • Note: comments are fetched filtered by issueId — not a full-collection load

2. docs/features/categories.md (update or create)

  • Document DELETE /api/v1/categories/{id} (Admin-only)
  • Explain soft-delete / archive behavior: Archived=true, ArchivedBy, ArchivedOn
  • Explain that archived categories do not appear in issue creation forms

3. docs/features/statuses.md (update or create)

  • Same as categories — document DELETE /api/v1/statuses/{id}
  • Explain soft-delete behavior

4. docs/architecture/api-contracts.md (update if exists)

  • Reflect any new query params or request body fields added in Sprint 3

5. CHANGELOG.md (update)

  • Add Sprint 3 entries under the appropriate version section:
    • Fixed: IssuesPage filter wiring
    • Fixed: CreateIssue / UpdateIssue command field mapping
    • Fixed: IssueDetail comment performance
    • Added: Category archive (API + UI)
    • Added: Status archive (API + UI)

Acceptance Criteria

  • All new API endpoints are documented with method, path, auth requirement, params, and response
  • Archive behavior explained in plain language for Categories and Statuses
  • CHANGELOG updated with all Sprint 3 changes
  • Docs written so a new contributor can understand the feature without reading source

Depends On

All Sprint 3 implementation issues (#116#127)

Metadata

Metadata

Assignees

No one assigned

    Labels

    go:yesReady to implementpriority:p2Next sprintrelease:backlogNot yet targetedsprint-3Sprint 3 — Full CRUD UI + ArchivesquadSquad triage inbox — Lead will assign to a membersquad:frodoAssigned to Frodo (Tech Writer)squad:legolasAssigned to Legolas (Frontend Dev)type:docsDocumentation work

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions