Skip to content

Get Venues Op

griddy / nfl / models / requests / get_venues_op**

get_venues_op

Classes

GetVenuesRequestTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_venues_op.GetVenuesRequestTypedDict[GetVenuesRequestTypedDict]

              

              click griddy.nfl.models.requests.get_venues_op.GetVenuesRequestTypedDict href "" "griddy.nfl.models.requests.get_venues_op.GetVenuesRequestTypedDict"
            
Attributes
season instance-attribute
season: int

Season year

limit instance-attribute
limit: NotRequired[int]

Maximum number of venues to return

GetVenuesRequest

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_venues_op.GetVenuesRequest[GetVenuesRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_venues_op.GetVenuesRequest
                


              click griddy.nfl.models.requests.get_venues_op.GetVenuesRequest href "" "griddy.nfl.models.requests.get_venues_op.GetVenuesRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
            
Attributes
season instance-attribute
season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

limit class-attribute instance-attribute
limit: Annotated[
    Optional[int],
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = 20

Maximum number of venues to return