docs: promote chain endpoint release in CHANGELOG — weekly documentation audit 2026-08-18 - #97
Draft
krakenhavoc wants to merge 1 commit into
Draft
docs: promote chain endpoint release in CHANGELOG — weekly documentation audit 2026-08-18#97krakenhavoc wants to merge 1 commit into
krakenhavoc wants to merge 1 commit into
Conversation
…_REFERENCE Carries forward the gap from #93 (opened 2026-07-14, never merged). Also fixes a stale chainPem field description and adds the missing GET /certs/tls/:id/chain entry to API_REFERENCE.md, previously undocumented despite every sibling /certs/tls/:id/* route being covered. No PRs merged or opened in this repo in the past week.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Weekly Documentation Audit — 2026-08-18
No PRs were merged or opened in
KrakenKey/appbetween 2026-08-11 and 2026-08-18, so no new documentation gaps were introduced this week. This edition carries forward the still-unmerged fix from #93 (itself carried from #90, #89, #88, #87, #86, #85):docs/CHANGELOG.mdstill listsGET /certs/tls/:id/chain(PR #79, merged 2026-05-14) under[Unreleased]rather than a dated release, five weeks after the prior audit first flagged it.Documentation gap
docs/CHANGELOG.md— the chain endpoint has sat under[Unreleased]since it merged on 2026-05-14. While re-verifying that entry against the current controller/service code, this audit also found the CHANGELOG's field description was stale (chainPemis a DB column, not a response field — the actual response is{ leafCert, intermediates, fullChainPem }).backend/docs/API_REFERENCE.md— new finding this week:GET /certs/tls/:id/chainwas entirely undocumented here, despite every sibling/certs/tls/:id/*route being covered.Changes made
docs/CHANGELOG.md: promoted the chain endpoint to a dated## [2026-05-28] — Certificate Chainrelease and corrected the response-shape description.backend/docs/API_REFERENCE.md: added a### GET /certs/tls/:id/chainentry with the response shape, placed afterGET /certs/tls/:id/details.New docs needed
None else this week.
Suggested version bump
No git tags exist in this repo yet; the CHANGELOG's dated-release headers are the versioning mechanism in use. Suggest tagging
v0.4.0onmainto cover the certificate-chain feature, per #90's prior (still unapplied) recommendation.