Repository navigation
docs(examples): add a description bundles example for the API-Only TranscriberJ - #89
Merged
Merged
Conversation
…anscriberJ One orders contract, built by the Publisher, with a nested object, an array and an error schema; a partial English and a partial Dutch bundle; and tests that render both languages from one generated tree, follow the language a run asks for, list what is not covered, and fail on keys the contract no longer describes. A workflow of its own builds it on every change to it.
Owner
Author
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Owner
Author
|
🎉 This PR is included in version 1.0.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Owner
Author
|
🎉 This PR is included in version 0.2.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Owner
Author
|
🎉 This PR is included in version 1.0.2 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Owner
Author
|
🎉 This PR is included in version 1.0.1 🎉 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
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 small, complete project under
examples/api-only-transcriberj/description-bundlesthat documents one contract in English and Dutch from one generated class tree, with descriptions from aResourceBundle.What is in it
orderscontract, built by the Publisher (0.5.0) in the example itself:OrderV1with a nestedcustomer.addressand an array oflines, andProblemV1, an error with an array oferrors.generateDocs = trueanddescriptionBundle = 'docs.Descriptions', and the REST Docs emitter 0.1.1.DescriptionsTest, 7 tests:-PdocsLocale, English by default);missing()anduntranslated()list what is not covered;example-api-only-transcriberj-description-bundles-build.yml, which runs./gradlew teston every change to the example.Verified
./gradlew testand./gradlew test -PdocsLocale=nlpass, both on a JVM with an English default locale and on one with a Dutch default.The tutorial that walks through this example is in the API repository, under
docs/guides/description-bundles/.Findings, not addressed here
spring-rules-build.ymllists the path ofsingle-module-springbut never builds it.<Class>Docs.fields()) have noLocaleoverload. Rendering several languages in one run means settingapionly.descriptions.localebetween calls.