Add documentation & HTTP status FormNotFoundError now 404 - #69
Merged
Conversation
…ithub.io Add exception FormNotFoundError for when a form is not found, and return 404 instead of 500
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #69 +/- ##
==========================================
+ Coverage 91.82% 94.52% +2.70%
==========================================
Files 33 33
Lines 697 731 +34
Branches 71 71
==========================================
+ Hits 640 691 +51
+ Misses 52 31 -21
- Partials 5 9 +4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Mark90
marked this pull request as ready for review
August 6, 2026 14:00
anieuwland
approved these changes
Aug 6, 2026
eenblam
self-requested a review
August 6, 2026 16:20
eenblam
previously approved these changes
Aug 6, 2026
eenblam
left a comment
There was a problem hiding this comment.
I haven't had time to exercise this locally today, but it looks good! I left some comments with suggestions and questions, but I don't see any of them as blocking.
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
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.
Summary
Add documentation to the project and make it work as a subproject of https://github.com/workfloworchestrator/workfloworchestrator.github.io.
Initial documentation generated with Claude Code followed by lots of redactions.
Code blocks in the markdown documentation consist of normal
pythonblocks followed bypycon(Python Console) blocks which demonstrate assertions on previous code blocks, and which are validated through a unit test / pre-commit hook.Code changes
FormNotFoundErrorinstead ofFormExceptionFormPage.meta__now a default ClassVar (no impact on schema or serialization) and documentedform_error_handlerreworked and added handling ofFormNotFoundError(404 now instead of 500)Screenshots
Intro page
Usage
Examples
Reference page
Search (project name prefix is a CSS hack, see monorepo PR )
Neat unexpected side-effect (might be a bit hard to see): mkdocs is now able link from orchestrator-core's reference docs to a type in pydantic-forms that it uses