ft3.template.pkg.obj module

Template objects.

class Pet(class_as_dict: dict[str | string[StringType], Any] | None = None, /, **kwargs: Any)

Bases: Object

Pet of a pet.

pet_with_pet_id: Field[str]

The unique identifier of the parent pet.

id_: Field[str]

Unique identifier for the [sub] pet.

Fields called ‘id’ (including underscore variations) are special, they will automatically be combined with their class name to form a clear object id.

In thise case: petId.

name: Field[str]

Name of the [sub] pet.

type_: Field[str]

Type of [sub] pet. Allowed values: 'Cat', 'Dog'.

in_: Field[str]

Locations in which the [sub] pet can be.

is_tail_wagging: Field[bool]

Whether the [sub] pet’s tail is currently wagging.

enumerations: lib.t.ClassVar[dict[str, tuple[typ.Primitive, ...]]] = {'in_': ('inside', 'outside', 'timeout'), 'type_': ('cat', 'dog')}

fields: lib.t.ClassVar[typ.FieldsTuple] = ('id_', 'in_', 'is_tail_wagging', 'name', 'pet_with_pet_id', 'type_')

hash_fields: lib.t.ClassVar[typ.FieldsTuple] = ('id_', 'pet_with_pet_id')

class PetWithPet(class_as_dict: dict[str | string[StringType], Any] | None = None, /, **kwargs: Any)

Bases: Object

A simple pet that makes for a good example.

• This python docstring will be parsed as the default description for its corresponding RESTful resource.

• It will always be parsed as the description / docstring for the Pet object itself in all auto-generated documentation.

• It will be rendered in markdown.

id_: Field[str]

Unique identifier for the pet.

Fields called ‘id’ (including underscore variations) are special, they will automatically be combined with their class name to form a clear object id.

In this case: petWithPetId.

enumerations: lib.t.ClassVar[dict[str, tuple[typ.Primitive, ...]]] = {'in_': ('inside', 'outside', 'timeout'), 'type_': ('cat', 'dog')}

fields: lib.t.ClassVar[typ.FieldsTuple] = ('human', 'id_', 'in_', 'is_tail_wagging', 'name', 'pets', 'type_')

hash_fields: lib.t.ClassVar[typ.FieldsTuple] = ('id_',)

name: Field[str]

Name of the pet.

type_: Field[str]

Type of pet. Allowed values: 'Cat', 'Dog'.

in_: Field[str]

Locations in which the pet can be.

is_tail_wagging: Field[bool]

Whether the pet’s tail is currently wagging.

pets: Field[list[Pet]]

The pet(s) of a pet.

human: Field[Human]

Sometimes pets also own humans.