Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
662 changes: 642 additions & 20 deletions .check-schema/zilla-schema.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,24 @@ Topic name.

#### topics[].key

> `enum` [ `avro`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ], `object`
> `enum` [ `avro`, `boolean`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ], `object`

Enforce validation for key

#### key.model\*

> `enum` [ `avro`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ]
> `enum` [ `avro`, `boolean`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ]

A schema or type to validate the topic's key. Refer to the individual [model](../../models/) docs for type specific implementation.

#### topics[].value

> `enum` [ `avro`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ], `object`
> `enum` [ `avro`, `boolean`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ], `object`

Enforce validation for value

#### value.model\*

> `enum` [ `avro`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ]
> `enum` [ `avro`, `boolean`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ]

A schema or type to validate the topic's value. Refer to the individual [model](../../models/) docs for type specific implementation.
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Supports dynamic parameter substitution using the following pattern:

- `${guarded['jwt'].identity}` – Substitutes a guarded identity value.

#### with.reply-to\*
#### with.reply-to

> `string`

Expand Down
25 changes: 4 additions & 21 deletions src/reference/config/bindings/grpc/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,13 @@ The grpc server binding adapts `http` request-response streams to `grpc` request

## Configuration (\* required)

### catalog
### options

> `object` as map of named `array`
> `object`

To map defined catalog for schema retrieval based on catalog specific parameters.

```yaml
catalog:
my_catalog:
- subject: http
```

#### catalog[].subject\*

> `string`

Unique identifier for schema categorization in the catalog.

#### catalog[].version

> `string` | Default: `latest`

Specific iteration or version of a registered schema in the defined catalog.
The `server` specific options.

<!-- @include: ../.partials/cataloged.md -->
<!-- @include: ./.partials/options.md -->
<!-- @include: ../.partials/exit.md -->
<!-- @include: ./.partials/routes.md -->
Expand Down
12 changes: 12 additions & 0 deletions src/reference/config/bindings/http-filesystem/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ routes:
- path: /{path}
```

#### when[].method

> `enum` [ `GET`, `PUT`, `POST`, `DELETE`, `HEAD` ]

HTTP method

#### when[].path

> `string`
Expand Down Expand Up @@ -69,3 +75,9 @@ Filesystem parameters used when adapting `http` data streams into `filesystem` d
> `string`

Topic name, optionally referencing path parameter such as `${params.path}`.

#### with.directory\*

> `string`

Optionally referencing path parameter such as `${params.directory}`.
10 changes: 7 additions & 3 deletions src/reference/config/bindings/http-kafka/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,7 @@ routes:
- read:items
```

##### Dynamic guarded routes

Dynamic guarded routes allow roles to be evaluated at runtime based on the incoming HTTP request.
**Dynamic guarded routes**: Allow roles to be evaluated at runtime based on the incoming HTTP request.

```yaml
routes:
Expand Down Expand Up @@ -308,6 +306,12 @@ Kafka message headers, with values optionally referencing path parameter.

Kafka reply-to topic name.

#### with.correlation-id

> `string`

Correlation-Id Kafka Header.

#### with.async

> `object` as map of named `string` properties
Expand Down
22 changes: 11 additions & 11 deletions src/reference/config/bindings/http/.partials/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Options to configure typed validations for request fields.

#### requests[].content

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ], `object`
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ], `object`

Enforce validation for the request content.

#### content.model\*

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ]
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ]

A schema or type to validate the request content. Refer to the individual [model](../../../models/) docs for type specific implementation.

Expand All @@ -25,7 +25,7 @@ Content type of the HTTP request.

#### requests[].headers

> `object` as map of named `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties
> `object` as map of named `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties

Enforce validation for request headers.

Expand All @@ -43,25 +43,25 @@ Query parameters of the HTTP request.

#### params.path

> `object` as map of named `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties
> `object` as map of named `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties

Enforce validation for path

#### path.model\*

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ]
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ]

A schema or type to validate the path content. Refer to the individual [model](../../../models/) docs for type specific implementation.

#### params.query

> `object` as map of named `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties
> `object` as map of named `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties

Enforce validation for query

#### query.model\*

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ]
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ]

A schema or type to validate the query content. Refer to the individual [model](../../../models/) docs for type specific implementation.

Expand All @@ -79,14 +79,14 @@ Options to configure typed validations for response fields.

#### responses[].content

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ], `object`
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ], `object`

Enforce validation for the response content.

<!-- markdownlint-disable MD024 -->
#### content.model\*

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ]
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ]

A schema or type to validate the response content. Refer to the individual [model](../../../models/) docs for type specific implementation.
<!-- markdownlint-enable MD024 -->
Expand All @@ -99,7 +99,7 @@ Content type of the HTTP response.

#### responses[].headers

> `object` as map of named `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties
> `object` as map of named `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties

Enforce validation for response headers.

Expand All @@ -112,7 +112,7 @@ headers:

#### headers.model\*

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ]
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ]

A schema or type to validate the headers content. Refer to the individual [model](../../../models/) docs for type specific implementation.

Expand Down
4 changes: 1 addition & 3 deletions src/reference/config/bindings/http/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@ routes:
- read:items
```

##### Dynamic guarded routes

Dynamic guarded routes allow roles to be evaluated at runtime based on the incoming HTTP request.
**Dynamic guarded routes**: Allow roles to be evaluated at runtime based on the incoming HTTP request.

```yaml
routes:
Expand Down
4 changes: 2 additions & 2 deletions src/reference/config/bindings/mqtt-kafka/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Array of MQTT topic filters matching topic names for publish.

#### publish[].topic

> `string`
> `string` | Pattern: `^(\\/?([\\w{}\\.-]*|\\+)(\\/((?![-_])[\\w{}\\.-]*|\\+))*(\\/#)?|#|\\/|\\$SYS(\\/((?![-_])[\\w{}\\.-]*|\\+))*(\\/#)?)$`

MQTT topic filter pattern.

Expand All @@ -77,7 +77,7 @@ Array of MQTT topic filters matching topic names for subscribe.

#### subscribe[].topic

> `string`
> `string` | Pattern: `^(\\/?([\\w{}\\.-]*|\\+)(\\/((?![-_])[\\w{}\\.-]*|\\+))*(\\/#)?|#|\\/|\\$SYS(\\/((?![-_])[\\w{}\\.-]*|\\+))*(\\/#)?)$`

MQTT topic filter pattern.

Expand Down
8 changes: 4 additions & 4 deletions src/reference/config/bindings/mqtt/.partials/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ Array of MQTT topic configs for publish capability.

#### publish[].topic

> `string`
> `string` | Pattern: `^(\\/?([\\w{}\\.-]*|\\+)(\\/((?![-_])[\\w{}\\.-]*|\\+))*(\\/#)?|#|\\/|\\$SYS(\\/((?![-_])[\\w{}\\.-]*|\\+))*(\\/#)?)$`

The MQTT topic to match on that supports standard MQTT wildcards `/+/`, `/#`.

Also, supports embedded parameters (e.g., `{id}`) for dynamic topic matching.

#### publish[].params

> `object` as map of named `string`
> `object` as map of named `string` properties | Pattern: `^[a-zA-Z0-9{}\\[\\]\\.\\$']*$`

Enforce validation of topic embedded parameters.

Expand All @@ -87,15 +87,15 @@ Array of MQTT topic configs for subscribe capability.

#### subscribe[].topic

> `string`
> `string` | Pattern: `^(\\/?([\\w{}\\.-]*|\\+)(\\/((?![-_])[\\w{}\\.-]*|\\+))*(\\/#)?|#|\\/|\\$SYS(\\/((?![-_])[\\w{}\\.-]*|\\+))*(\\/#)?)$`

The MQTT topic to match on that supports standard MQTT wildcards `/+/`, `/#`.

Also, supports embedded parameters (e.g., `{id}`) for dynamic topic matching.

#### subscribe[].params

> `object` as map of named `string`
> `object` as map of named `string` properties | Pattern: `^[a-zA-Z0-9{}\\[\\]\\.\\$']*$`

Enforce validation of topic embedded parameters.

Expand Down
8 changes: 4 additions & 4 deletions src/reference/config/bindings/mqtt/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,19 +68,19 @@ Topic name.

#### topics[].content

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ], `object`
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ], `object`

Enforce validation for content

#### content.model\*

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ]
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ]

A schema or type to validate the request content. Refer to the individual [model](../../models/) docs for type specific implementation.

#### topics[].user-properties

> `object` as map of named `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties
> `object` as map of named `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ], `object` as map of named `object` properties

Enforce validation for user provided properties.

Expand All @@ -93,7 +93,7 @@ user-properties:

#### user-properties.model\*

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ]
> `enum` [ `boolean`, `double`, `float`, `int32`, `int64`, `json`, `string` ]

A schema or type to validate the user-properties content. Refer to the individual [model](../../models/) docs for type specific implementation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### catalog\*
### catalog

> `object` as map of named `array`

Expand Down
1 change: 1 addition & 0 deletions src/reference/config/bindings/pgsql-kafka/proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ The pgsql-kafka proxy binding for adapting `pgsql` request-response streams to `
```yaml
exit: pgsql_tcp_client
```
<!-- @include: ../.partials/telemetry.md -->
1 change: 1 addition & 0 deletions src/reference/config/bindings/pgsql/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ The pgsql `client` binding receives inbound application streams and route throug
```yaml
exit: pgsql_tcp_client
```
<!-- @include: ../.partials/telemetry.md -->
1 change: 1 addition & 0 deletions src/reference/config/bindings/pgsql/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ The pgsql server binding receives inbound network stream, producing higher level
```yaml
exit: risingwave_proxy
```
<!-- @include: ../.partials/telemetry.md -->
16 changes: 8 additions & 8 deletions src/reference/config/bindings/risingwave/.partials/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ options:

#### options.udf

> `object` as map of named `array`
> `array` of `object`

Define UDF server

##### udf[].server

> `string`
> `string` | Pattern: `^([a-zA-Z0-9\\\\.-]+)(:(\\\\{[a-zA-Z_]+\\\\}|[0-9]+))?$`

UDF Server location

##### udf[].language

> `string` | Default: `java`
> `enum` [ `java`, `python` ] | Default: `java`

UDF language

Expand All @@ -48,23 +48,23 @@ Kafka properties and message formatting

> `object`

###### kafka.properties.bootstrap.server
###### properties.bootstrap.server

> `string`

Kafka bootstrap server

##### kafka.format

> `object`
> `enum` [ `avro`, `boolean`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ], `object`

###### kafka.format.model
###### format.model\*

> `enum` [ `double`, `float`, `int32`, `int64`, `json`, `string` ]
> `enum` [ `avro`, `boolean`, `double`, `float`, `int32`, `int64`, `json`, `protobuf`, `string` ]

A schema or type to validate the request content. Refer to the individual [model](../../../models/) docs for type specific implementation.

##### kafka.format.catalog\*
##### catalog

> `object` as map of named `array`

Expand Down
Loading
Loading