Repository navigation
docs(api-only-transcriberj): add a guide to hand-written contract tests - #27
Merged
Merged
Conversation
An overview, a tutorial and two assistant prompts for the contract tests the generator cannot write: where the generated tree stops, what is still there when a method degrades, how to write the missing part by hand from the generated pieces in the generated package, how to guard it so it breaks when the contract moves, and why a contract test needs one example per response the contract lists rather than one per invalid input. Every snippet is expanded from the worked example in the Library repository, and every command was run in it.
…d-written code owns prominent The overview, the tutorial and both prompts now state as a design decision that hand-written test code goes in the generated package, and that the package-private members it reaches are not a published API; and they list what no generated class holds -- the members of a degraded body, const values, constraints written inline in an inline branch -- and the duties that leaves the project.
Arc-E-Tect
added a commit
that referenced
this pull request
Sep 18, 2026
# [0.6.0](api-only-publisher-v0.5.0...api-only-publisher-v0.6.0) (2026-09-18) ### ✨ New and updated features * **api-only-transcriberj:** resolve descriptions through a project's ResourceBundle ([#21](#21)) ([46a61c6](46a61c6)), closes [#21](#21) ### 🐛 Bug Fixes * **api-only-transcriberj:** generate a oneOf body the way its branches allow ([#25](#25)) ([e1acbe0](e1acbe0)), closes [#25](#25) * Integrate refreshVersions plugin for dependency management ([#22](#22)) ([4f9b5b7](4f9b5b7)), closes [#22](#22) * **api-only-transcriberj:** resolve a description in the locale asked for, not the JVM's ([#23](#23)) ([705b86b](705b86b)), closes [#23](#23) ### 📝 Documentation * **api-only-transcriberj:** add a guide to description bundles ([#24](#24)) ([e4a6031](e4a6031)), closes [#24](#24) * **api-only-transcriberj:** add a guide to hand-written contract tests ([#27](#27)) ([e569da7](e569da7)), closes [#27](#27) [#26](#26) * add a reference on authoring a specification library, and keep versions current ([#28](#28)) ([b8bb842](b8bb842)), closes [#28](#28) * **api-only-transcriberj:** say where hand-written test code goes and what it owns ([#26](#26)) ([ca36e43](ca36e43)), closes [#26](#26) [#25](#25)
Owner
Author
|
🎉 This PR is included in version 0.6.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Arc-E-Tect
added a commit
that referenced
this pull request
Sep 18, 2026
## [0.3.4](api-only-transcriberj-v0.3.3...api-only-transcriberj-v0.3.4) (2026-09-18) ### 📝 Documentation * **api-only-transcriberj:** add a guide to hand-written contract tests ([#27](#27)) ([e569da7](e569da7)), closes [#27](#27) [#26](#26) * add a reference on authoring a specification library, and keep versions current ([#28](#28)) ([b8bb842](b8bb842)), closes [#28](#28) * **api-only-transcriberj:** say where hand-written test code goes and what it owns ([#26](#26)) ([ca36e43](ca36e43)), closes [#26](#26) [#25](#25) * **api-only-publisher:** update README version to 0.6.0 [skip ci] ([6d2bf92](6d2bf92))
Owner
Author
|
🎉 This PR is included in version 0.3.4 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Owner
Author
|
🎉 This PR is included in version 0.3.3 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
A guide in
docs/guides/hand-written-contract-tests/, with an overview, a tutorial, a Claude Code prompt and a Codex prompt, for the contract tests the TranscriberJ cannot generate.What it covers
ContractJsonamong them, are regenerated every build and are not a published API.oneOfwith inline branches plus a business-rule 422. The hand-written body sits next to the generated constants it draws on, and the assertions use the generated error-response descriptors.Verified
Also
docs/README.adoc: a row in the Guides table.