docs(api): register missing doc endpoints (/doc/list, /doc/search, /doc/update) - #827
Merged
Merged
Conversation
…oc/update) The auto-generated api-reference.md (via docgen) omitted three document endpoints that exist in handlers.rs: - POST /doc/list (DocListParams) - POST /doc/search (DocSearchRequest) - POST /doc/update (DocUpdateRequest) Discovered while validating corin's uteke_client call sites against the uteke server route registry — corin calls these, but they were absent from the reference doc, making the doc appear incomplete/stale. Added the three Endpoint entries to api_registry.rs and regenerated docs/api-reference.md via 'cargo run -p docgen'.
🔍 Cora AI Code Review✅ No issues found. Code looks good! Review powered by cora-cli · BYOK · MIT |
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.
Summary
The auto-generated
docs/api-reference.md(viacargo run -p docgen) omitted three document endpoints that do exist inhandlers.rs:POST /doc/list(DocListParams)POST /doc/search(DocSearchRequest)POST /doc/update(DocUpdateRequest)Why it matters
Discovered while validating corin (codecoradev/corin)
uteke_client.rscall sites against the uteke server route registry. Corin calls these three endpoints, but they were absent from the reference doc — making the doc appear incomplete/stale and causing downstream consumers to wrongly assume the endpoints are missing or deprecated.Changes
crates/uteke-server/src/api_registry.rs— added 3Endpointentries to the Documents section (logical order: create → get → list → search → update → move → delete → mem-refs).docs/api-reference.md— regenerated viacargo run -p docgen.Validation
cargo fmt --all -- --check✅cargo clippy -p uteke-server -p docgen -- -D warnings✅cora reviewpre-commit hook ✅Diff of handler routes vs registry paths confirmed these were the only 3 gaps.