Skip to content

Commit 1931a2a

Browse files
authored
Update README.md
add server variables information
1 parent 7ec4dbe commit 1931a2a

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ Options:
6363
| externalDocs.url | custom.documentation.externalDocumentation.url |
6464
| servers[].description | custom.documentation.servers.description |
6565
| servers[].url | custom.documentation.servers.url |
66+
| servers[].variables | custom.documentation.servers.variables |
6667
| tags[].name | custom.documentation.tags.name |
6768
| tags[].description | custom.documentation.tags.description |
6869
| tags[].externalDocs.url | custom.documentation.tags.externalDocumentation.url |
@@ -121,8 +122,15 @@ custom:
121122
url: https://google.com
122123
description: A link to google
123124
servers:
124-
url: https://example.com
125+
url: https://example.com:{port}/
125126
description: The server
127+
variables:
128+
port:
129+
enum:
130+
- 4000
131+
- 3000
132+
default: 3000
133+
description: The port the server operates on
126134
tags:
127135
- name: tag1
128136
description: this is a tag

0 commit comments

Comments
 (0)