Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: allow to define Schema Object in Server variables #597

Closed
wants to merge 1 commit into from
Closed

feat: allow to define Schema Object in Server variables #597

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 21 additions & 16 deletions spec/asyncapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,15 +437,20 @@ The following shows how variables can be used for a server configuration:
"protocol": "secure-mqtt",
"variables": {
"username": {
"default": "demo",
"description": "This value is assigned by the service provider, in this example `gigantic-server.com`"
"description": "This value is assigned by the service provider, in this example `gigantic-server.com`",
"schema": {
"type": "string",
"default": "demo"
}
},
"port": {
"enum": [
"8883",
"8884"
],
"default": "8883"
"schema": {
"enum": [
"8883",
"8884"
],
"default": "8883"
}
}
}
}
Expand All @@ -461,14 +466,16 @@ servers:
protocol: secure-mqtt
variables:
username:
# note! no enum here means it is an open value
default: demo
description: This value is assigned by the service provider, in this example `gigantic-server.com`
schema:
type: string
default: demo
port:
enum:
- '8883'
- '8884'
default: '8883'
schema:
enum:
- '8883'
- '8884'
default: '8883'
```


Expand All @@ -480,10 +487,8 @@ An object representing a Server Variable for server URL template substitution.

Field Name | Type | Description
---|:---:|---
<a name="serverVariableObjectEnum"></a>enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set.
<a name="serverVariableObjectDefault"></a>default | `string` | The default value to use for substitution, and to send, if an alternate value is _not_ supplied.
<a name="serverVariableObjectDescription"></a>description | `string` | An optional description for the server variable. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation.
<a name="serverVariableObjectExamples"></a>examples | [`string`] | An array of examples of the server variable.
<a name="serverVariableObjectSchema"></a>schema | [Schema Object](#schemaObject) \| [Reference Object](#referenceObject) | Definition of the server variable.

This object MAY be extended with [Specification Extensions](#specificationExtensions).

Expand Down