All Classes and Interfaces
Class
Description
The value of
additionalProperties: a boolean, or a schema.The
apiOnlyTranscriberJ block: which subscribed contracts get a generated
class tree, and how.The API-Only TranscriberJ: a class tree derived from a subscribed contract, for
contract tests and stubs.
A channel of an AsyncAPI contract: an address messages travel over.
A message a channel carries, as an AsyncAPI bundle inlines it.
An operation of an AsyncAPI contract: an application sending or receiving on a
channel.
RFC 8785, the JSON Canonicalization Scheme, over the maps, lists and scalars a
YAML or JSON parser produces.
What a contract case tests: which response the contract declares for its request, and so
what a target must do before the request is sent.
The core classes of one contract, as the core emitter names them.
A schema component.
The value of a
const keyword.A schema's validation keywords.
A construct the model classifies wherever it occurs, so that its treatment in
generated code is reported rather than discovered.
One contract case, as an emitter is given it: the values the generated
ContractCase
of the base package holds, and the case's index in its operation's CASES.A bundled contract, in the terms code generation needs: its OpenAPI document,
and its AsyncAPI document where it has one, as one model.
A document that is not a bundled OpenAPI 3 contract the model can be built from.
What a generation worker derives the contract's model from.
Builds a
ContractModel from a bundled OpenAPI 3 contract.A request, as the generated
ContractRequest of the same name holds it: the path
template and the values that fill it kept apart, and no value encoded.One query parameter or header.
What every generation task of a contract derives its output from: the fetched documents, the
lockfile and the subscription's settings.
A
discriminator.A dialect of generated code: REST Docs descriptors, WireMock stubs, and the like.
What an emitter is given to write one contract's classes.
One emitter's configuration for one subscription: the
emitter('<id>') block.One occurrence of a classified construct.
The core's generation: the schema classes, operations, cases and the endpoint index.
What the task hands over.
Generates the core of one contract's class tree: the schema classes, the operations and the
invalid-request cases, and the endpoint index.
One core class, as the core emitter names it.
One emitter's generation, in the class loader the emitters were loaded into.
What the task hands over.
Generates one emitter's output for one contract, over the same model the core generates from:
its Java sources, its classpath resources and its files, each in a directory of its own.
One generation run: a contract in, a tree of Java sources out.
What
Generation.derive(java.nio.file.Path, java.nio.file.Path, java.lang.String, java.lang.String, com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings) works out once: the model, the class names, the cases and the core's
report, and the core's output, not yet written.A contract no classes can be generated from, with every reason why.
What a generation run could not do in full, and what the specification could do
about it: the end-of-run report D14 asks for.
A generated method that throws instead of doing its work.
A generated method that throws because no valid value could be generated for it:
none exists, this generator cannot find one, or it reaches a construct no rule
represents yet.
Something the specification could do better, and how.
A parameter no valid value is generated for yet.
The HTTP methods an OpenAPI path item can hold an operation for.
A library generated code needs.
One entry of a
content map.One operation: a method on a path.
What a generated class was generated from.
What an emitter writes, in the mode its options select: the plugin places each kind where it
belongs, and refuses a configuration that would put it anywhere else.
An operation or path-item parameter.
One entry of
paths.Where a component came from.
A
$ref written where a parameter, request body or response would be.Writes the one report of a subscription from the fragments its generation tasks wrote: the
text report, as one generation of the core and every emitter would have written it, and an
AsciiDoc report, a frame that summarises it and includes each task's AsciiDoc fragment.
An operation's request body.
One response of an operation.
The body of a response an operation declares, as an emitter is given it: the generated class
its contract cases name, and the valid bodies that class's
requiredBody() and
fullBody() return.One valid body: its text, or, when the core cannot build one, where and why -- what the
generated method throws instead.
A reusable component other than a schema: a response, parameter or request body.
A JSON Schema, as a bundled contract writes it.
How a project has asked for one contract's classes to be generated.
How the classes for one subscribed contract are generated.
What code generation does with a classified construct.
Adds missing
apiOnlyTranscriberJ DSL properties to a consumer's
build.gradle, using their real plugin defaults.Fails when the generated class tree was generated from another contract than the
one the lockfile names (D17): "these tests test the current contract", checked.