adorsys / adorsys/status-list-server

Update compliance matrix in docs/compliance_matrix.md to reflect current server implementation

Đang mở
#523 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation enhancement
Ngôn ngữ chính
Rust
Star
22
Fork
5
Merge trung bình
2 ngày 11 giờ
Pull request đã merge (30 ngày)
47

Mô tả

## Objective

Conduct a thorough audit of `docs/compliance_matrix.md` and update all entries, compliance statuses, implementation notes, and issue references to accurately reflect the current state of the server.

## Context

`docs/compliance_matrix.md` provides the authoritative compliance tracking against the IETF OAuth Token Status List specification. However, several entries have drifted from the codebase:
- Entry 17 still states: *"Current code gzips unconditionally for both JWT and CWT responses, regardless of the client's Accept-Encoding"*, whereas content negotiation for `Accept-Encoding: gzip` on JWT responses and uncompressed CWTs is already implemented.
- References to historic tracking issues (e.g., #152, #136) point to outdated or closed tickets rather than active Sprint EPICs.
- Recent spec alignment changes (such as CBOR Tag 18 for CWT, strict bit-width checks, historical `?time=` handling, empty list ZLIB compression, and rate limiting) need verification and accurate cross-referencing.

## Deliverables

- [ ] Audit all 20+ requirement rows in `docs/compliance_matrix.md` against current handler code in `src/server/handlers/status_list/`.
- [ ] Correct out-of-date descriptions (including gzip negotiation, CWT tag 18, and query parameter handling).
- [ ] Update tracking issue numbers in the table to link to current active sub-issues and Sprint EPICs.
- [ ] Ensure all references to RFCs, IETF draft versions, and wire formats match current implementations.
- [ ] Validate markdown formatting and link integrity with `markdownlint-cli2`.

## Acceptance Criteria

- [ ] Every status in `docs/compliance_matrix.md` accurately describes the current codebase behavior.
- [ ] No stale claims of non-compliance exist for features that have already been resolved.
- [ ] `npx markdownlint-cli2 docs/compliance_matrix.md` passes without lint errors.

## References

- Sub-EPIC: #504 (Sprint 4: Documentation Architecture, Contributor Onboarding & Quality Governance)
- Baseline EPIC: #141 (Status List Server Hardening & Production Readiness)
- Specification: https://datatracker.ietf.org/doc/draft-ietf-oauth-status-list/

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.