Coverage for faststream / specification / asyncapi / v3_0_0 / schema / servers.py: 82%

1from typing import Any (empty)

2 

3from pydantic import BaseModel (empty)

4 

5from faststream._internal._compat import PYDANTIC_V2 (empty)

6from faststream.specification.asyncapi.v2_6_0.schema import ServerVariable, Tag (empty)

7from faststream.specification.asyncapi.v2_6_0.schema.utils import Reference (empty)

8 

9SecurityRequirement = list[Reference] (empty)

10 

11 

12__all__ = ( (empty)

13 "Server", 

14 "ServerVariable", 

15) 

16 

17 

18class Server(BaseModel): (empty)

19 """A class to represent a server. 

20 

21 Attributes: 

22 host : host of the server 

23 pathname : pathname of the server 

24 protocol : protocol used by the server 

25 description : optional description of the server 

26 protocolVersion : optional version of the protocol used by the server 

27 tags : optional list of tags associated with the server 

28 security : optional security requirement for the server 

29 variables : optional dictionary of server variables 

30 

31 Note: 

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

33 

34 Configurations: 

35 If `PYDANTIC_V2` is True, the model configuration is set to allow extra attributes. 

36 Otherwise, the `Config` class is defined with the `extra` attribute set to "allow". 

37 

38 """ 

39 

40 host: str (empty)

41 pathname: str (empty)

42 protocol: str (empty)

43 description: str | None = None (empty)

44 protocolVersion: str | None = None (empty)

45 tags: list[Tag | dict[str, Any]] | None = None (empty)

46 security: SecurityRequirement | None = None (empty)

47 variables: dict[str, ServerVariable | Reference] | None = None (empty)

48 

49 if PYDANTIC_V2: 49 ↛ 54line 49 didn't jump to line 54 because the condition on line 49 was always true(empty)

50 model_config = {"extra": "allow"} (empty)

51 

52 else: 

53 

54 class Config: 

55 extra = "allow"