judobase.schemas.Judoka

pydantic model judobase.schemas.Judoka

Represents the data about a judoka.

Show JSON schema

{
   "title": "Judoka",
   "description": "Represents the data about a judoka.",
   "type": "object",
   "properties": {
      "family_name": {
         "description": "The family name (surname) of the judoka.",
         "title": "Family Name",
         "type": "string"
      },
      "middle_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The middle name of the judoka, if available.",
         "title": "Middle Name"
      },
      "given_name": {
         "description": "The given name (first name) of the judoka.",
         "title": "Given Name",
         "type": "string"
      },
      "family_name_local": {
         "description": "The local representation of the family name.",
         "title": "Local Family Name",
         "type": "string"
      },
      "middle_name_local": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The local representation of the middle name.",
         "title": "Local Middle Name"
      },
      "given_name_local": {
         "description": "The local representation of the given name.",
         "title": "Local Given Name",
         "type": "string"
      },
      "short_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A short or abbreviated name for the judoka.",
         "title": "Short Name"
      },
      "gender": {
         "description": "The gender of the judoka.",
         "title": "Gender",
         "type": "string"
      },
      "folder": {
         "description": "The folder where the judoka's data or images are stored.",
         "title": "Folder",
         "type": "string"
      },
      "picture_filename": {
         "description": "The filename of the judoka's picture.",
         "title": "Picture Filename",
         "type": "string"
      },
      "ftechique": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A field representing a specific technique associated with the judoka. (Verify field name if necessary.)",
         "title": "Ftechique"
      },
      "side": {
         "description": "The side (e.g., left or right) that the judoka uses.",
         "title": "Side",
         "type": "string"
      },
      "coach": {
         "description": "The coach of the judoka.",
         "title": "Coach",
         "type": "string"
      },
      "best_result": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The best competition result achieved by the judoka.",
         "title": "Best Result"
      },
      "height": {
         "description": "The height of the judoka.",
         "title": "Height",
         "type": "string"
      },
      "birth_date": {
         "description": "The birth date of the judoka.",
         "format": "date-time",
         "title": "Birth Date",
         "type": "string"
      },
      "country": {
         "description": "The country the judoka represents.",
         "title": "Country",
         "type": "string"
      },
      "id_country": {
         "description": "The identifier for the judoka's country.",
         "title": "Country ID",
         "type": "string"
      },
      "country_short": {
         "description": "The short code for the judoka's country.",
         "title": "Country Short Code",
         "type": "string"
      },
      "file_flag": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A flag indicating file status, if applicable.",
         "title": "File Flag"
      },
      "club": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The club the judoka is affiliated with.",
         "title": "Club"
      },
      "belt": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The belt rank of the judoka.",
         "title": "Belt"
      },
      "youtube_links": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Links to YouTube videos related to the judoka.",
         "title": "YouTube Links"
      },
      "status": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The current status of the judoka.",
         "title": "Status"
      },
      "archived": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Indicates whether the judoka's record is archived.",
         "title": "Archived"
      },
      "categories": {
         "description": "List of competition categories the judoka participates in.",
         "items": {
            "type": "string"
         },
         "title": "Categories",
         "type": "array"
      },
      "dob_year": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The year the judoka was born.",
         "title": "Year of Birth"
      },
      "age": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The age of the judoka.",
         "title": "Age"
      },
      "death_age": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The age at which the judoka passed away, if applicable.",
         "title": "Death Age"
      },
      "personal_picture": {
         "description": "URL or path to the judoka's personal picture.",
         "title": "Personal Picture",
         "type": "string"
      }
   },
   "required": [
      "family_name",
      "given_name",
      "family_name_local",
      "given_name_local",
      "gender",
      "folder",
      "picture_filename",
      "side",
      "coach",
      "height",
      "birth_date",
      "country",
      "id_country",
      "country_short",
      "categories",
      "personal_picture"
   ]
}

Fields:

• age (str | None)

• archived (str | None)

• belt (str | None)

• best_result (str | None)

• birth_date (datetime.datetime)

• categories (list[str])

• club (str | None)

• coach (str)

• country (str)

• country_short (str)

• death_age (str | None)

• dob_year (str | None)

• family_name (str)

• family_name_local (str)

• file_flag (str | None)

• folder (str)

• ftechique (str | None)

• gender (str)

• given_name (str)

• given_name_local (str)

• height (str)

• id_country (str)

• middle_name (str | None)

• middle_name_local (str | None)

• personal_picture (str)

• picture_filename (str)

• short_name (str | None)

• side (str)

• status (str | None)

• youtube_links (str | None)

Validators:

• parse_birth_date » birth_date

field age: str | None = None

The age of the judoka.

field archived: str | None = None

Indicates whether the judoka’s record is archived.

field belt: str | None = None

The belt rank of the judoka.

field best_result: str | None = None

The best competition result achieved by the judoka.

field birth_date: datetime [Required]

The birth date of the judoka.

Validated by:

• parse_birth_date

field categories: list[str] [Required]

List of competition categories the judoka participates in.

field club: str | None = None

The club the judoka is affiliated with.

field coach: str [Required]

The coach of the judoka.

field country: str [Required]

The country the judoka represents.

field country_short: str [Required]

The short code for the judoka’s country.

field death_age: str | None = None

The age at which the judoka passed away, if applicable.

field dob_year: str | None = None

The year the judoka was born.

field family_name: str [Required]

The family name (surname) of the judoka.

field family_name_local: str [Required]

The local representation of the family name.

field file_flag: str | None = None

A flag indicating file status, if applicable.

field folder: str [Required]

The folder where the judoka’s data or images are stored.

field ftechique: str | None = None

A field representing a specific technique associated with the judoka. (Verify field name if necessary.)

field gender: str [Required]

The gender of the judoka.

field given_name: str [Required]

The given name (first name) of the judoka.

field given_name_local: str [Required]

The local representation of the given name.

field height: str [Required]

The height of the judoka.

field id_country: str [Required]

The identifier for the judoka’s country.

field middle_name: str | None = None

The middle name of the judoka, if available.

field middle_name_local: str | None = None

The local representation of the middle name.

field personal_picture: str [Required]

URL or path to the judoka’s personal picture.

field picture_filename: str [Required]

The filename of the judoka’s picture.

field short_name: str | None = None

A short or abbreviated name for the judoka.

field side: str [Required]

The side (e.g., left or right) that the judoka uses.

field status: str | None = None

The current status of the judoka.

field youtube_links: str | None = None

Links to YouTube videos related to the judoka.

validator parse_birth_date  »  birth_date

Ensures the birth_date field is set to UTC timezone.