Skip to content

docs: document LibreSign error handling conventions - #122

Merged
vitormattos merged 2 commits into
mainfrom
docs/error-handling-convention-8117
Oct 27, 2026
Merged

vitormattos merged 2 commits into
mainfrom
docs/error-handling-convention-8117

Conversation

@vitormattos

Copy link
Copy Markdown
Member

Refs LibreSign/libresign#8117

Summary

  • Document the error-handling convention in a short Developer Manual page: exception types, semantic codes, explicit HTTP statuses, and the legacy fallback.
  • Record existing signing frontend contracts that must survive incremental migrations.
  • Explain when tests should assert exception types, codes, messages, and final HTTP/OCS responses.
  • Link the page from the architecture map and Developer Manual navigation.

Validation

  • Reviewed the 71-line reStructuredText page for structure and line length.
  • Verified the commit's cryptographic signature and matching DCO sign-off.
  • Sphinx was not installed in the local execution environment; the repository's Documentation workflow will validate the build with warnings treated as errors.

Scope

Documentation only. No application changes, blanket removal of message assertions, or migration of legacy status codes.

Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
@vitormattos
vitormattos merged commit 90f8d64 into main Oct 27, 2026
2 checks passed
@vitormattos
vitormattos deleted the docs/error-handling-convention-8117 branch October 27, 2026 02:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant