Skip to content

Commit

Permalink
fix: links and tls options ref
Browse files Browse the repository at this point in the history
  • Loading branch information
vordimous committed Aug 30, 2024
1 parent 50ac3b7 commit c1533d1
Show file tree
Hide file tree
Showing 10 changed files with 46 additions and 115 deletions.
54 changes: 0 additions & 54 deletions src/reference/config/bindings/asyncapi/.partials/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,57 +105,3 @@ Named header value pattern with `{credentials}`, e.g. `"Bearer` `{credentials}"`
> `object` as map of named: `string` properties

Named query parameter value pattern with `{credentials}`.

#### options.tls

> `object`

`tls` specific options.

#### tls.version

> `string`

Protocol version.

#### tls.keys

> `array` of `string`

A list of reference names for the Vault key.

#### tls.trust

> `array` of `string`

A list of reference names for the Vault certificate.

#### tls.signers

> `array` of `string`

A list of reference names for the Vault signer certificate.

#### tls.trustcacerts

> `boolean`

Trust CA certificates. This property will be considered set to `true` when [tls.trust](#tls-trust) is `null`.

#### tls.sni

> `array` of `string`

A list of the Server Name Indications.

#### tls.alpn

> `array` of `string`

Application protocols.

#### tls.mutual

> `enum` [ `required`, `requested`, `none` ] | Default: `none`

Mutual authentication.
8 changes: 8 additions & 0 deletions src/reference/config/bindings/asyncapi/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,5 +157,13 @@ authorization:

<!-- @include: ../.partials/options-mqtt-auth.md -->

#### options.tls

> `object`

`tls` specific options.

<!-- @include: ../.partials/options-tls.md -->

<!-- @include: ./.partials/routes.md -->
<!-- @include: ../.partials/telemetry.md -->
8 changes: 8 additions & 0 deletions src/reference/config/bindings/asyncapi/proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,14 @@ authorization:

<!-- @include: ../.partials/options-mqtt-auth.md -->

#### options.tls

> `object`

`tls` specific options.

<!-- @include: ../.partials/options-tls.md -->

<!-- @include: ./.partials/routes.md -->
#### routes[].exit

Expand Down
8 changes: 8 additions & 0 deletions src/reference/config/bindings/asyncapi/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,14 @@ authorization:

<!-- @include: ../.partials/options-mqtt-auth.md -->

#### options.tls

> `object`

`tls` specific options.

<!-- @include: ../.partials/options-tls.md -->

<!-- @include: ./.partials/routes.md -->
<!-- @include: ../.partials/exit.md -->
#### routes[].exit
Expand Down
10 changes: 5 additions & 5 deletions src/reference/config/bindings/http/.partials/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Enforce validation for the request content.

> `enum` [ `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.
A schema or type to validate the request content. Refer to the individual [model](../../../models) docs for type specific implementation.

#### requests[].content-type

Expand Down Expand Up @@ -41,7 +41,7 @@ Enforce validation for path

> `enum` [ `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.
A schema or type to validate the path content. Refer to the individual [model](../../../models) docs for type specific implementation.

#### params.query

Expand All @@ -53,7 +53,7 @@ Enforce validation for query

> `enum` [ `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.
A schema or type to validate the query content. Refer to the individual [model](../../../models) docs for type specific implementation.

#### requests[].path

Expand All @@ -74,7 +74,7 @@ Enforce validation for the response content.

> `enum` [ `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.
A schema or type to validate the response content. Refer to the individual [model](../../../models) docs for type specific implementation.
<!-- markdownlint-enable MD024 -->

#### responses[].content-type
Expand All @@ -98,7 +98,7 @@ headers:
> `enum` [ `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.
A schema or type to validate the headers content. Refer to the individual [model](../../../models) docs for type specific implementation.

#### responses[].status

Expand Down
54 changes: 0 additions & 54 deletions src/reference/config/bindings/openapi/.partials/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,57 +111,3 @@ Hostname or IP address.
> `integer`, `string`, `array`

Port number(s), including port number ranges.

#### options.tls

> `object`

`tls` specific options.

#### tls.version

> `string`

Protocol version.

#### tls.keys

> `array` of `string`

A list of reference names for the Vault key.

#### tls.trust

> `array` of `string`

A list of reference names for the Vault certificate.

#### tls.signers

> `array` of `string`

A list of reference names for the Vault signer certificate.

#### tls.trustcacerts

> `boolean`

Trust CA certificates. This property will be considered set to `true` when [tls.trust](#tls-trust) is `null`.

#### tls.sni

> `array` of `string`

A list of the Server Name Indications.

#### tls.alpn

> `array` of `string`

Application protocols.

#### tls.mutual

> `enum` [ `required`, `requested`, `none` ] | Default: `none`

Mutual authentication.
8 changes: 8 additions & 0 deletions src/reference/config/bindings/openapi/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,13 @@ The openapi client binding
## Configuration (\* required)
<!-- @include: ./.partials/options.md -->
#### options.tls
> `object`

`tls` specific options.

<!-- @include: ../.partials/options-tls.md -->
<!-- @include: ../.partials/vault.md -->
<!-- @include: ../.partials/telemetry.md -->
7 changes: 7 additions & 0 deletions src/reference/config/bindings/openapi/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,12 @@ The openapi server binding
<!-- @include: ../.partials/vault.md -->
<!-- @include: ./.partials/options.md -->
#### options.tls
> `object`

`tls` specific options.

<!-- @include: ../.partials/options-tls.md -->
<!-- @include: ../.partials/exit.md -->
<!-- @include: ../.partials/telemetry.md -->
2 changes: 1 addition & 1 deletion src/reference/config/bindings/sse/.partials/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Enforce validation for the request content.

> `enum` [ `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.
A schema or type to validate the request content. Refer to the individual [model](../../../models) docs for type specific implementation.
2 changes: 1 addition & 1 deletion src/reference/config/bindings/tls/.partials/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ A list of reference names for the Vault signer certificate.

> `boolean`

Trust CA certificates. This property will be considered set to `true` when [tls.trust](#tls-trust) is `null`.
Trust CA certificates. This property will be considered set to `true` when [options.trust](#options-trust) is `null`.

#### options.sni

Expand Down

0 comments on commit c1533d1

Please sign in to comment.