normalizing options description syntax

Author: vordimous

.config/vale/styles/Vocab/Base/accept.txt

@@ -72,6 +72,7 @@ Conduktor
 config
 const
 CQRS
+crv
 cspell
 datagram
 EDAs
@@ -95,9 +96,12 @@ jwt
 Kafka
 Karapace
 kcat
+kty
 leader_only
 Lua
 lycheeverse
+maxLength
+minLength
 MQTT
 mvnw
 netcat

README.md

@@ -93,12 +93,8 @@ Pages in the reference section describe, as briefly as possible and in an orderl
     - `#### parent.child`
   - Arrays of objects have brackets `[]` only when describing child properties
     - `#### parentArray[].child`
-
-Table of Contents (ToC) anchor links are generated using the [Markdown All in One](https://markdown-all-in-one.github.io/docs/guide/table-of-contents.html#overview) extension with the `gitea` slug mode.
-
 - Required props have an escaped splat `\*` at the end of the header and ToC link
   - `### topLevelProp\*`
-  - `- [topLevelProp\*](#toplevelprop)`
 
 ````markdown
 # Title
@@ -201,3 +197,24 @@ Every page has an `Edit this page on GitHub` link at the bottom for you to check
 ## Copyright and license
 
 Copyright Aklivity, Inc. 2024, released under the [Apache 2.0 license](https://github.com/aklivity/zilla/blob/main/LICENSE).
+
+org.agrona.concurrent.AgentTerminationException: java.lang.NullPointerException: Cannot invoke "io.aklivity.zilla.runtime.binding.kafka.internal.types.KafkaEvaluation.ordinal()" because "evaluation" is null
+    at [email protected]/io.aklivity.zilla.runtime.engine.internal.registry.EngineWorker.doWork(EngineWorker.java:849)
+    at org.agrona.core/org.agrona.concurrent.AgentRunner.doWork(AgentRunner.java:304)
+    at org.agrona.core/org.agrona.concurrent.AgentRunner.workLoop(AgentRunner.java:296)
+    at org.agrona.core/org.agrona.concurrent.AgentRunner.run(AgentRunner.java:162)
+    at java.base/java.lang.Thread.run(Thread.java:1570)
+Caused by: java.lang.NullPointerException: Cannot invoke "io.aklivity.zilla.runtime.binding.kafka.internal.types.KafkaEvaluation.ordinal()" because "evaluation" is null
+    at [email protected]/io.aklivity.zilla.runtime.binding.kafka.internal.cache.KafkaCacheCursorFactory.asCondition(KafkaCacheCursorFactory.java:1163)
+    at [email protected]/io.aklivity.zilla.runtime.binding.kafka.internal.stream.KafkaCacheClientFetchFactory.newStream(KafkaCacheClientFetchFactory.java:242)
+    at [email protected]/io.aklivity.zilla.runtime.binding.kafka.internal.stream.KafkaCacheClientFactory.newStream(KafkaCacheClientFactory.java:149)
+    at [email protected]/io.aklivity.zilla.runtime.engine.internal.registry.EngineWorker.handleBeginInitial(EngineWorker.java:1584)
+    at [email protected]/io.aklivity.zilla.runtime.engine.internal.registry.EngineWorker.handleDefaultReadInitial(EngineWorker.java:1348)
+    at [email protected]/io.aklivity.zilla.runtime.engine.internal.registry.EngineWorker.handleReadInitial(EngineWorker.java:1288)
+    at [email protected]/io.aklivity.zilla.runtime.engine.internal.registry.EngineWorker.handleRead(EngineWorker.java:1235)
+    at [email protected]/io.aklivity.zilla.runtime.engine.internal.concurent.ManyToOneRingBuffer.read(ManyToOneRingBuffer.java:229)
+    at [email protected]/io.aklivity.zilla.runtime.engine.internal.registry.EngineWorker.doWork(EngineWorker.java:843)
+    ... 4 more
+    Suppressed: java.lang.Exception: [engine/data#1]        [0x010100000000b79d] streams=[consumeAt=0x00549a60 (0x0000000284549a60), produceAt=0x009f31d8 (0x00000002849f31d8)]
+            at [email protected]/io.aklivity.zilla.runtime.engine.internal.registry.EngineWorker.doWork(EngineWorker.java:847)
+            ... 4 more

src/reference/config/bindings/asyncapi/.partials/options.md

@@ -2,7 +2,7 @@
 
 > `object` as map of named `object` properties
 
-specs specific options
+The `specs` specific options.
 
 #### specs.catalog
 
@@ -68,7 +68,7 @@ Port number(s), including port number ranges.
 
 > `object`
 
-http specific options.
+The http specific options.
 
 #### http.authorization
 

src/reference/config/bindings/asyncapi/client.md

@@ -18,7 +18,7 @@ The asyncapi client binding creates composite of `kafka` or `mqtt` or `http`, an
 
 > `object`
 
-`client`-specific options.
+The `client` specific options.
 
 ```yaml
 specs:
@@ -37,7 +37,7 @@ specs:
 
 > `object`
 
-`kafka` binding specific options.
+The `kafka` binding specific options.
 
 #### kafka.topics
 
@@ -67,7 +67,7 @@ SASL credentials to use when connecting to `kafka` brokers.
 
 > `object`
 
-`mqtt-kafka` binding specific options.
+The `mqtt-kafka` binding specific options.
 
 #### mqtt-kafka.channels
 
@@ -117,7 +117,7 @@ messages: mqttMessages
 
 > `object`
 
-HTTP specific options.
+The HTTP specific options.
 
 #### http.authorization
 
@@ -139,7 +139,7 @@ authorization:
 
 > `object`
 
-MQTT specific options.
+The MQTT specific options.
 
 #### mqtt.authorization
 
@@ -161,7 +161,7 @@ authorization:
 
 > `object`
 
-TLS specific options.
+The TLS specific options.
 
 <!-- @include: ../.partials/options-tls.md -->
 

src/reference/config/bindings/asyncapi/proxy.md

@@ -18,7 +18,7 @@ The asyncapi proxy binding creates composite of `mqtt-kafka` binding with proxy
 
 > `object`
 
-`proxy`-specific options.
+The `proxy` specific options.
 
 ```yaml
 specs:
@@ -37,7 +37,7 @@ specs:
 
 > `object`
 
-`kafka` binding specific options.
+The `kafka` binding specific options.
 
 #### kafka.topics
 
@@ -67,7 +67,7 @@ SASL credentials to use when connecting to `kafka` brokers.
 
 > `object`
 
-`mqtt-kafka` binding specific options.
+The `mqtt-kafka` binding specific options.
 
 #### mqtt-kafka.channels
 
@@ -117,7 +117,7 @@ messages: mqttMessages
 
 > `object`
 
-HTTP specific options.
+The HTTP specific options.
 
 #### http.authorization
 
@@ -139,7 +139,7 @@ authorization:
 
 > `object`
 
-MQTT specific options.
+The MQTT specific options.
 
 #### mqtt.authorization
 
@@ -161,7 +161,7 @@ authorization:
 
 > `object`
 
-TLS specific options.
+The TLS specific options.
 
 <!-- @include: ../.partials/options-tls.md -->
 

src/reference/config/bindings/asyncapi/server.md

@@ -18,7 +18,7 @@ The asyncapi server binding creates composite of `tcp`, `tls`, and `mqtt` or `ht
 
 > `object`
 
-`server`-specific options.
+The `server` specific options.
 
 ```yaml
 specs:
@@ -37,7 +37,7 @@ specs:
 
 > `object`
 
-`kafka` binding specific options.
+The `kafka` binding specific options.
 
 #### kafka.topics
 
@@ -67,7 +67,7 @@ SASL credentials to use when connecting to `kafka` brokers.
 
 > `object`
 
-`mqtt-kafka` binding specific options.
+The `mqtt-kafka` binding specific options.
 
 #### mqtt-kafka.channels
 
@@ -117,7 +117,7 @@ messages: mqttMessages
 
 > `object`
 
-http specific options.
+The http specific options.
 
 #### http.authorization
 
@@ -139,7 +139,7 @@ authorization:
 
 > `object`
 
-MQTT specific options.
+The MQTT specific options.
 
 #### mqtt.authorization
 
@@ -161,7 +161,7 @@ authorization:
 
 > `object`
 
-`tls` specific options.
+The `tls` specific options.
 
 <!-- @include: ../.partials/options-tls.md -->
 

src/reference/config/bindings/filesystem/.partials/options.md

@@ -2,7 +2,7 @@
 
 > `object`
 
-`filesystem`-specific options for `filesystem` access.
+The `filesystem` specific options.
 
 ```yaml
 options:

src/reference/config/bindings/grpc-kafka/.partials/options.md

@@ -2,7 +2,7 @@
 
 > `object`
 
-`grpc-kafka`-specific options for adapting `grpc` request-response streams to `kafka` topic streams.
+The `grpc-kafka` specific options.
 
 ```yaml
 options:

src/reference/config/bindings/http-kafka/.partials/options.md

@@ -2,7 +2,7 @@
 
 > `object`
 
-`http-kafka`-specific options for adapting `http` request-response streams to `kafka` topic streams.
+`http-kafka`-specific options.
 
 ```yaml
 options:
@@ -18,7 +18,7 @@ options:
 
 > `object`
 
-HTTP request header used to specify the idempotency key when adapting `http` request-response streams to `kafka` topic streams.
+HTTP request header used to specify the idempotency key.
 
 #### idempotency.header\*
 
@@ -30,13 +30,13 @@ HTTP request header name for idempotency key.
 
 > `object`
 
-Kafka request message headers injected when adapting `http` request-response streams to `kafka` topic streams.
+Kafka request message headers injected.
 
 #### correlation.headers\*
 
 > `object`
 
-Kafka request message reply to and correlation id header names injected when adapting `http` request-response streams to `kafka` topic streams.
+Kafka request message reply to and correlation id header names injected.
 
 #### headers.reply-to
 

src/reference/config/bindings/http-kafka/proxy.md

@@ -4,7 +4,7 @@ shortTitle: proxy
 
 # http-kafka proxy
 
-The http-kafka proxy binding
+The http-kafka proxy binding for adapting `http` request-response streams to `kafka` topic streams.
 
 ```yaml {3}
 <!-- @include: ./.partials/proxy.yaml -->