Skip to content

Server

faststream.asyncapi.schema.servers.Server #

Bases: BaseModel

A class to represent a server.

Note

The attributes description, protocolVersion, tags, security, variables, and bindings are all optional.

Configurations

If PYDANTIC_V2 is True, the model configuration is set to allow extra attributes. Otherwise, the Config class is defined with the extra attribute set to "allow".

Note

The above docstring is autogenerated by docstring-gen library (https://docstring-gen.airt.ai)

bindings class-attribute instance-attribute #

bindings: Optional[Union[ServerBinding, Reference]] = None

description class-attribute instance-attribute #

description: Optional[str] = None

model_config class-attribute instance-attribute #

model_config = {'extra': 'allow'}

protocol instance-attribute #

protocol: str

protocolVersion class-attribute instance-attribute #

protocolVersion: Optional[str] = None

security class-attribute instance-attribute #

security: Optional[SecurityRequirement] = None

tags class-attribute instance-attribute #

tags: Optional[
    List[Union[Tag, TagDict, Dict[str, Any]]]
] = None

url instance-attribute #

url: str

variables class-attribute instance-attribute #

variables: Optional[
    Dict[str, Union[ServerVariable, Reference]]
] = None

Config #

extra class-attribute instance-attribute #

extra = 'allow'
Last update: 2023-11-13