Skip to content

docs(api-only-transcriberj-restdocs): describe the emitter as released #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Arc-E-Tect merged 1 commit into from
Sep 18, 2026
Merged

docs(api-only-transcriberj-restdocs): describe the emitter as released #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions api-only-transcriberj-restdocs/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

The Spring REST Docs emitter of the https://github.com/Arc-E-Tect/SoftwareEngineeringDoneRight-API/tree/main/api-only-transcriberj[API-Only TranscriberJ ↗]: for every class the TranscriberJ generates from an API contract, a companion holding its REST Docs field descriptors and snippets.

Not released yet.

// tag::root[]
== Artifact Coordinates

Expand All @@ -25,7 +23,8 @@ Not released yet.
|Requirement |Version
|Java |21+
|Gradle |9.x
|API-Only TranscriberJ |the version this emitter was built against, `0.0.0` until both are released
|API-Only TranscriberJ |`0.3.0` or newer: it is built against `0.3.0`, and the examples use it with `0.3.3`.
Until the TranscriberJ's `1.0.0`, a release may change the emitter interface; its changelog says when.
|Spring REST Docs |4.x, in the project's test source sets
|===

Expand All @@ -36,7 +35,7 @@ Add it to the TranscriberJ's emitter configuration:
[source,groovy]
----
dependencies {
transcriberjEmitters 'com.arc-e-tect:api-only-transcriberj-restdocs:<version>'
transcriberjEmitters 'com.arc-e-tect:api-only-transcriberj-restdocs:0.1.1'
}
----

Expand Down
Loading