server package:openapi3
An object representing a Server.
A server object to be used by the target operation.
An array of Server Objects, which provide connectivity information to
a target server. If the servers property is not provided, or is an
empty array, the default value would be a
Server object with a
url value of
/.
An alternative server array to service this operation. If an
alternative server object is specified at the
PathItem Object
or Root level, it will be overridden by this value.
An alternative server array to service all operations in this path.
An optional string describing the host designated by the URL.
CommonMark syntax MAY be used for rich text representation.
A URL to the target host. This URL supports Server Variables and MAY
be relative, to indicate that the host location is relative to the
location where the OpenAPI document is being served. Variable
substitutions will be made when a variable is named in
{brackets}.
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 treatment of default values, because in those
cases parameter values are optional. If the
_serverVariableEnum
is defined, the value SHOULD exist in the enum's values.
An optional description for the server variable.
CommonMark
syntax MAY be used for rich text representation.
An enumeration of string values to be used if the substitution options
are from a limited set. The array SHOULD NOT be empty.
A map between a variable name and its value. The value is used for
substitution in the server's URL template.