Skip to content

Commit

Permalink
update descriptions and tags
Browse files Browse the repository at this point in the history
  • Loading branch information
vordimous committed Sep 18, 2024
1 parent 89ba7bc commit dc8153a
Show file tree
Hide file tree
Showing 62 changed files with 105 additions and 88 deletions.
2 changes: 1 addition & 1 deletion src/reference/config/bindings/amqp/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `amqp`-specific routes for adapting HTTP request-response streams to Kafka topic streams.
Conditional `amqp` specific routes.

```yaml
routes:
Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/amqp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: amqp
category:
- Binding
tag:
- Server
- amqp
- server
---

# amqp Binding
Expand Down
4 changes: 0 additions & 4 deletions src/reference/config/bindings/amqp/server.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
---
shortTitle: server
category:
- Binding
tag:
- Server
---

# amqp server
Expand Down
6 changes: 3 additions & 3 deletions src/reference/config/bindings/asyncapi/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `asyncapi`-specific routes for adapting streams.
Conditional `asyncapi` specific routes.

```yaml
routes:
Expand Down Expand Up @@ -69,10 +69,10 @@ with:

> `string`

AsyncAPI spec identifier that the route exits with to the next binding
AsyncAPI spec identifier that the route exits with to the next binding.

#### with.operation-id

> `string`

AsyncAPI OperationId that the route exits with to the next binding
AsyncAPI OperationId that the route exits with to the next binding.
7 changes: 4 additions & 3 deletions src/reference/config/bindings/asyncapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ shortTitle: asyncapi
category:
- Binding
tag:
- Server
- Proxy
- Client
- asyncapi
- client
- proxy
- server
---

# asyncapi Binding
Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/echo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: echo
category:
- Binding
tag:
- Server
- echo
- server
---

# echo Binding
Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/fan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: fan
category:
- Binding
tag:
- Server
- fan
- server
---

# fan Binding
Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/filesystem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: filesystem
category:
- Binding
tag:
- Server
- filesystem
- server
---

# filesystem Binding
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `grpc-kafka`-specific routes for adapting `grpc` request-response streams to `kafka` topic streams.
Conditional `grpc-kafka` specific routes.

```yaml
routes:
Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/grpc-kafka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: grpc-kafka
category:
- Binding
tag:
- Proxy
- grpc-kafka
- proxy
---

# grpc-kafka Binding
Expand Down
2 changes: 1 addition & 1 deletion src/reference/config/bindings/grpc/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

> `array` of `object`
Conditional `grpc`-specific routes.
Conditional `grpc` specific routes.

```yaml
routes:
Expand Down
6 changes: 3 additions & 3 deletions src/reference/config/bindings/grpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ dir:
collapsible: false
link: true
shortTitle: grpc

category:
- Binding
tag:
- Server
- Client
- grpc
- server
- client
---

# grpc Binding
Expand Down
4 changes: 0 additions & 4 deletions src/reference/config/bindings/grpc/client.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
---
shortTitle: client
category:
- Binding
tag:
- Client
---

# grpc client
Expand Down
5 changes: 0 additions & 5 deletions src/reference/config/bindings/grpc/server.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
---
shortTitle: server

category:
- Binding
tag:
- Server
---

# grpc server
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `http-kafka`-specific routes for adapting `http` data streams into `filesystem` data streams.
Conditional `http-kafka` specific routes.

```yaml
routes:
Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/http-filesystem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: http-filesystem
category:
- Binding
tag:
- Proxy
- http-filesystem
- proxy
---

# http-filesystem Binding
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `object`
`http-kafka`-specific options.
`http-kafka` specific options.

```yaml
options:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `http-kafka`-specific routes for adapting `http` request-response streams to `kafka` topic streams.
Conditional `http-kafka` specific routes.

Correlated Request-Response route:

Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/http-kafka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: http-kafka
category:
- Binding
tag:
- Proxy
- http-kafka
- proxy
---

# http-kafka Binding
Expand Down
2 changes: 1 addition & 1 deletion src/reference/config/bindings/http/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `http`-specific routes.
Conditional `http` specific routes.

```yaml
routes:
Expand Down
4 changes: 3 additions & 1 deletion src/reference/config/bindings/http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ shortTitle: http
category:
- Binding
tag:
- Server
- http
- server
- client
---

# http Binding
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `kafka-grpc`-specific routes for adapting `kafka` topic streams to `grpc` request-response streams.
Conditional `kafka-grpc` specific routes.

```yaml
routes:
Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/kafka-grpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: kafka-grpc
category:
- Binding
tag:
- Remote Server
- kafka-grpc
- remote_server
---

# kafka-grpc Binding
Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/kafka-proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ icon: aky-zilla-plus
category:
- Binding
tag:
- Proxy
- kafka-proxy
- proxy
---

# kafka-proxy Binding
Expand Down
2 changes: 1 addition & 1 deletion src/reference/config/bindings/kafka/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `kafka`-specific routes.
Conditional `kafka` specific routes.

#### routes[].guarded

Expand Down
5 changes: 4 additions & 1 deletion src/reference/config/bindings/kafka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ shortTitle: kafka
category:
- Binding
tag:
- Server
- kafka
- cache_client
- cache_server
- client
---

# kafka Binding
Expand Down
4 changes: 2 additions & 2 deletions src/reference/config/bindings/kafka/cache_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ shortTitle: cache_client

# kafka cache_client

The kafka cache_client binding
The kafka cache_client binding supports filtering by `kafka` message key, headers or a combination of key and headers.

```yaml {3}
<!-- @include: ./.partials/cache_client.yaml -->
Expand All @@ -16,7 +16,7 @@ The kafka cache_client binding
> `object`

The `kafka` specific options.
The `cache_client` specific options.

```yaml
options:
Expand Down
2 changes: 1 addition & 1 deletion src/reference/config/bindings/kafka/cache_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ shortTitle: cache_server

# kafka cache_server

The kafka cache_server binding
The kafka cache_server binding supports proactive `fetch` of messages to keep the cache fresh in preparation for new consumers. This is enabled by configuring a list of `bootstrap` topics for the binding.

```yaml {3}
<!-- @include: ./.partials/cache_server.yaml -->
Expand Down
2 changes: 1 addition & 1 deletion src/reference/config/bindings/kafka/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ shortTitle: client

# kafka client

The kafka client binding
The kafka client binding receives inbound application streams and encodes each as a network stream via `kafka` request-response protocol.

```yaml {3}
<!-- @include: ./.partials/client.yaml -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `mqtt-kafka`-specific routes when adapting `mqtt` topic streams to `kafka` topic streams.
Conditional `mqtt-kafka` specific routes.

```yaml
routes:
Expand Down
3 changes: 2 additions & 1 deletion src/reference/config/bindings/mqtt-kafka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: mqtt-kafka
category:
- Binding
tag:
- Proxy
- mqtt-kafka
- proxy
---

# mqtt-kafka Binding
Expand Down
2 changes: 1 addition & 1 deletion src/reference/config/bindings/mqtt-kafka/proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ shortTitle: proxy

# mqtt-kafka proxy

The mqtt-kafka proxy binding for configuring the `kafka` topics that the proxy will use to route mqtt messages and session states; and define server reference of the MQTT server in Zilla.
The mqtt-kafka proxy binding for adapting `mqtt` topic streams to `kafka` topic streams. By configuring the Kafka topics that the proxy will use to route mqtt messages and session states an `mqtt` `server` binding can allow clients to connect and proxy MQTT messages onto Kafka topics.

```yaml {3}
<!-- @include: ./.partials/proxy.yaml -->
Expand Down
2 changes: 1 addition & 1 deletion src/reference/config/bindings/mqtt/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `mqtt`-specific routes.
Conditional `mqtt` specific routes.

#### routes[].guarded

Expand Down
4 changes: 3 additions & 1 deletion src/reference/config/bindings/mqtt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ shortTitle: mqtt
category:
- Binding
tag:
- Server
- mqtt
- server
- client
---

# mqtt Binding
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> `array` of `object`
Conditional `openapi-asyncapi`-specific routes for adapting `openapi` operations to `asyncapi` operations.
Conditional `openapi-asyncapi` specific routes.

#### routes[].guarded

Expand Down Expand Up @@ -64,10 +64,10 @@ with:

> `string`

AsyncAPI spec identifier that the route exits with to the next binding
AsyncAPI spec identifier that the route exits with to the next binding.

#### with.operation-id

> `string`

AsyncAPI OperationId that the route exits with to the next binding
AsyncAPI OperationId that the route exits with to the next binding.
3 changes: 2 additions & 1 deletion src/reference/config/bindings/openapi-asyncapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ shortTitle: openapi-asyncapi
category:
- Binding
tag:
- Proxy
- openapi-asyncapi
- proxy
---

# openapi-asyncapi Binding
Expand Down
Loading

0 comments on commit dc8153a

Please sign in to comment.