Author

pydantic model Author[source]

Metadata for an author.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

__init__ uses __pydantic_self__ instead of the more common self for the first arg to allow self as a field name.

Show JSON schema

{
   "title": "Author",
   "description": "Metadata for an author.",
   "type": "object",
   "properties": {
      "name": {
         "description": "The full name of the researcher",
         "title": "Name",
         "type": "string"
      },
      "orcid": {
         "description": "The Open Researcher and Contributor Identifier (ORCiD) provides researchers with an open, unambiguous identifier for connecting various digital assets (e.g., publications, reviews) across the semantic web. An account can be made in seconds at https://orcid.org.",
         "title": "Open Researcher and Contributor Identifier",
         "type": "string"
      },
      "email": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The email address specific to the researcher.",
         "title": "Email address"
      },
      "github": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The GitHub handle enables contacting the researcher on GitHub: the *de facto* version control in the computer sciences and life sciences.",
         "title": "GitHub handle"
      }
   },
   "required": [
      "name",
      "orcid"
   ]
}

Fields:

orcid (str)

field orcid: str [Required]

This field is redefined on top of Attributable to make it required. Otherwise, it has the same semantics.

The Open Researcher and Contributor Identifier (ORCiD) provides researchers with an open, unambiguous identifier for connecting various digital assets (e.g., publications, reviews) across the semantic web. An account can be made in seconds at https://orcid.org.