Repository navigation
Spec 016 T018-T020: the API description, generated from the contract - #707
Closed
adamjohnwright wants to merge 1 commit into
Closed
adamjohnwright wants to merge 1 commit into
adamjohnwright wants to merge 1 commit into
Conversation
tools/contract/generate.ts (ts-json-schema-generator 2.9.0) writes projects/contract/openapi.json, an OpenAPI 3.1 document of every route the content service serves: the twelve search routes the contract's route table (projects/contract/routes.ts) describes, with their answers, and the 78 others marked not yet. The search entry is oneOf its six kinds; a Java long is int64. generate.spec.ts holds the table to the registry and the committed file to what the generator writes; each shown failing. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Author
|
Replaced by 708: path variables declared, clashing names refused, the counts corrected. |
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.
Spec 016 User Story 4: an OpenAPI description generated from the contract, not maintained by hand. Java's own description lists most answers as a generic object.
projects/contract/routes.ts: the route table, the interfaceRoutes. It maps each"METHOD /path", as the service's registry has it, to its 200 answer: twelve search routes for now.tools/contract/generate.ts(ts-json-schema-generator 2.9.0, a dev dependency) writesprojects/contract/openapi.json:x-contract: "not yet";oneOfits six kinds (research R4: no single tag tells them apart), and a Java long isinteger/int64;GroupedResult_SearchEntry);tools/contract/generate.spec.ts:tools/load.spec.tsgainscontract. The generated file is in.prettierignore, since the up-to-date check holds it instead.Lock: it gains the generator,
commander,safe-stable-stringifyand a hoistedglob. With the hoisting, one transitive copy ofbrace-expansiongoes from 5.0.9 to 5.0.12, within its range. Pushed withLOCKFILE_BUMP=1.Preflight passes. The first push's smoke run had three diagram tests time out while other container builds loaded the machine; they pass on their own (9/9) and in this push.
🤖 Generated with Claude Code