Skip to content

Commit d1ba364

Browse files
authored
Merge pull request #4062 from ralfhandl/3.0.4-rework-pr-#2140
3.0.4: port the undisputed parts of #2140
2 parents 0056446 + eb6eefc commit d1ba364

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

versions/3.0.4.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ The following shows how variables can be used for a server configuration:
445445
"variables": {
446446
"username": {
447447
"default": "demo",
448-
"description": "this value is assigned by the service provider, in this example `gigantic-server.com`"
448+
"description": "A user-specific subdomain. Use `demo` for a free sandbox environment."
449449
},
450450
"port": {
451451
"enum": ["8443", "443"],
@@ -468,7 +468,7 @@ servers:
468468
username:
469469
# note! no enum here means it is an open value
470470
default: demo
471-
description: this value is assigned by the service provider, in this example `gigantic-server.com`
471+
description: A user-specific subdomain. Use `demo` for a free sandbox environment.
472472
port:
473473
enum:
474474
- '8443'
@@ -488,7 +488,7 @@ An object representing a Server Variable for server URL template substitution.
488488
| Field Name | Type | Description |
489489
| ---- | :----: | ---- |
490490
| <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 SHOULD NOT be empty. |
491-
| <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 SHOULD exist in the enum's values. |
491+
| <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 SHOULD 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. |
492492
| <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. |
493493

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

0 commit comments

Comments
 (0)