Skip to content

Commit 1c558e8

Browse files
committed
3.1.1: port the undisputed parts of #2140
1 parent 4b4df2f commit 1c558e8

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

versions/3.1.1.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ The following shows how variables can be used for a server configuration:
518518
"variables": {
519519
"username": {
520520
"default": "demo",
521-
"description": "this value is assigned by the service provider, in this example `gigantic-server.com`"
521+
"description": "A user-specific subdomain. Use `demo` for a free sandbox environment."
522522
},
523523
"port": {
524524
"enum": ["8443", "443"],
@@ -541,7 +541,7 @@ servers:
541541
username:
542542
# note! no enum here means it is an open value
543543
default: demo
544-
description: this value is assigned by the service provider, in this example `gigantic-server.com`
544+
description: A user-specific subdomain. Use `demo` for a free sandbox environment.
545545
port:
546546
enum:
547547
- '8443'
@@ -561,7 +561,7 @@ An object representing a Server Variable for server URL template substitution.
561561
| Field Name | Type | Description |
562562
| ---- | :----: | ---- |
563563
| <a name="server-variable-enum"></a>enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. |
564-
| <a name="server-variable-default"></a>default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schema-object) treatment of default values, because in those cases parameter values are optional. If the [`enum`](#server-variable-enum) is defined, the value MUST exist in the enum's values. |
564+
| <a name="server-variable-default"></a>default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. If the [`enum`](#server-variable-enum) is defined, the value MUST exist in the enum's values. Note that this behavior is different from the [Schema Object](#schema-object)'s `default` keyword, which documents the receiver's behavior rather than inserting the value into the data. |
565565
| <a name="server-variable-description"></a>description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. |
566566

567567
This object MAY be extended with [Specification Extensions](#specification-extensions).

0 commit comments

Comments
 (0)