ApplicationSchema

faststream.specification.asyncapi.v3_0_0.schema.ApplicationSchema

Bases: BaseApplicationSchema

A class to represent an application schema.

ATTRIBUTE	DESCRIPTION
asyncapi	version of the async API
id	optional ID
defaultContentType	optional default content type
info	information about the schema
servers	optional dictionary of servers
channels	dictionary of channels
components	optional components of the schema

title property

title

info instance-attribute

info

asyncapi class-attribute instance-attribute

asyncapi = '3.0.0'

id class-attribute instance-attribute

id = None

defaultContentType class-attribute instance-attribute

defaultContentType = None

servers class-attribute instance-attribute

servers = None

channels class-attribute instance-attribute

channels = Field(default_factory=dict)

operations class-attribute instance-attribute

operations = Field(default_factory=dict)

components class-attribute instance-attribute

components = None

to_jsonable

to_jsonable()

Convert the schema to a JSON-serializable object.

Source code in faststream/specification/base/schema.py

def to_jsonable(self) -> Any:
    """Convert the schema to a JSON-serializable object."""
    return model_to_jsonable(
        self,
        by_alias=True,
        exclude_none=True,
    )

to_json

to_json()

Convert the schema to a JSON string.

Source code in faststream/specification/base/schema.py

def to_json(self) -> str:
    """Convert the schema to a JSON string."""
    return model_to_json(
        self,
        by_alias=True,
        exclude_none=True,
    )

to_yaml

to_yaml()

Convert the schema to a YAML string.

Source code in faststream/specification/base/schema.py

def to_yaml(self) -> str:
    """Convert the schema to a YAML string."""
    from io import StringIO

    import yaml

    io = StringIO(initial_value="", newline="\n")
    yaml.dump(self.to_jsonable(), io, sort_keys=False)
    return io.getvalue()