Repository navigation
docs: align API documentation with current behavior - #158
Merged
Merged
Conversation
jdaigneau5
approved these changes
Sep 23, 2026
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
Bring the public documentation and examples into line with the current API implementation. This PR changes no request handling, search matching, runtime configuration values, dependency versions, or response behavior.
Changes and Rationale
cp, use the lockfile throughnpm ci, explain the Node.js 24 baseline and conflicting upstream engine declaration, and distinguish the API's default port 3000 from Postman's port 4000.README.md,test/postman/README.mdisVulnerablerestriction to apply only when true.README.md,routes/swagger.js,api-docs/openapi.json/webSearchrequest/error documentationsort.propertywhensortis supplied, but the schema did not. Document that requirement and the existing HTTP 400 error-body schema without changing validation.routes/index.js,api-docs/openapi.json,README.mdREADME.md,config/default.jsonc,config/devel.jsonc,config/custom-environment-variables.jsonc/search, while readiness reports 503. The instructions previously treated these as interchangeable.test/postman/README.md.env.example,README.mdScope
/webSearchremains supported; no deprecation or removal is introduced..env.exampleloses only unused settings.