Person

pydantic model technote.config.Person

Model for describing a person related to the technote.

Parameters:

data (Any) –

Show JSON schema

{
   "title": "Person",
   "description": "Model for describing a person related to the technote.",
   "type": "object",
   "properties": {
      "name": {
         "$ref": "#/definitions/PersonName"
      },
      "internal_id": {
         "title": "Internal Id",
         "description": "An internal identifier for the person.",
         "type": "string"
      },
      "orcid": {
         "title": "Orcid",
         "description": "The ORCiD of the person (https://orcid.org).",
         "minLength": 1,
         "maxLength": 2083,
         "format": "uri",
         "type": "string"
      },
      "affiliations": {
         "title": "Affiliations",
         "description": "The person's affiliations.",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Organization"
         }
      },
      "email": {
         "title": "Email",
         "description": "Contact email associated with the person.",
         "type": "string",
         "format": "email"
      }
   },
   "required": [
      "name"
   ],
   "definitions": {
      "PersonName": {
         "title": "PersonName",
         "description": "A person's name.",
         "type": "object",
         "properties": {
            "family_names": {
               "title": "Family Names",
               "description": "The person's family name (last name in western culture).",
               "type": "string"
            },
            "given_names": {
               "title": "Given Names",
               "description": "The person's given name (first name in western culture).",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "description": "The person's name, an alternative to specifying surname and given names.",
               "type": "string"
            }
         }
      },
      "Organization": {
         "title": "Organization",
         "description": "Model for describing an organization (often as an affiliation).",
         "type": "object",
         "properties": {
            "internal_id": {
               "title": "Internal Id",
               "description": "A user-specific identifier for an organization.",
               "type": "string"
            },
            "ror": {
               "title": "Ror",
               "description": "The ROR (ror.org) identifier of the institution.",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "description": "The display name of the institution.",
               "type": "string"
            },
            "address": {
               "title": "Address",
               "description": "The address of the institution.",
               "type": "string"
            },
            "url": {
               "title": "Url",
               "description": "The homepage of the institution.",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            }
         }
      }
   }
}

Fields:

• affiliations (Optional[List[technote.config.Organization]])

• email (Optional[pydantic.networks.EmailStr])

• internal_id (Optional[str])

• name (technote.config.PersonName)

• orcid (Optional[technote.metadata.orcid.Orcid])

field affiliations: Optional[List[Organization]] [Optional]

The person’s affiliations.

field email: Optional[EmailStr] = None

Contact email associated with the person.

Constraints:

• type = string

• format = email

field internal_id: Optional[str] = None

An internal identifier for the person.

field name: PersonName [Required]

field orcid: Optional[Orcid] = None

The ORCiD of the person (https://orcid.org).

Constraints:

• minLength = 1

• maxLength = 2083

• format = uri