GitHubUserModel

pydantic model safir.github.models.GitHubUserModel

A Pydantic model for the user field found in GitHub API resources.

This contains brief (public) info about a user.

Parameters:

data (Any)

Show JSON schema
{
   "title": "GitHubUserModel",
   "description": "A Pydantic model for the ``user`` field found in GitHub API resources.\n\nThis contains brief (public) info about a user.",
   "type": "object",
   "properties": {
      "login": {
         "description": "GitHub username.",
         "title": "Login name",
         "type": "string"
      },
      "html_url": {
         "description": "Homepage for the user on GitHub.",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "Profile URL",
         "type": "string"
      },
      "url": {
         "description": "URL for the user's resource in the GitHub API.",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "API URL",
         "type": "string"
      },
      "avatar_url": {
         "description": "URL to the user's avatar.",
         "format": "uri",
         "maxLength": 2083,
         "minLength": 1,
         "title": "Avatar image URL",
         "type": "string"
      }
   },
   "required": [
      "login",
      "html_url",
      "url",
      "avatar_url"
   ]
}

Fields:
field avatar_url: HttpUrl [Required]

URL to the user’s avatar.

Constraints:

  • max_length = 2083

  • allowed_schemes = [‘http’, ‘https’]

field html_url: HttpUrl [Required]

Homepage for the user on GitHub.

Constraints:

  • max_length = 2083

  • allowed_schemes = [‘http’, ‘https’]

field login: str [Required]

GitHub username.

field url: HttpUrl [Required]

URL for the user’s resource in the GitHub API.

Constraints:

  • max_length = 2083

  • allowed_schemes = [‘http’, ‘https’]