Organization

pydantic model technote.sources.tomlsettings.Organization

Model for describing an organization (often as an affiliation).

Parameters:

data (Any)

Show JSON schema
{
   "title": "Organization",
   "description": "Model for describing an organization (often as an affiliation).",
   "type": "object",
   "properties": {
      "internal_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A user-specific identifier for an organization.",
         "title": "Internal Id"
      },
      "ror": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ROR (ror.org) identifier of the institution.",
         "title": "Ror"
      },
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The display name of the institution.",
         "title": "Name"
      },
      "address": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The address of the institution.",
         "title": "Address"
      },
      "url": {
         "anyOf": [
            {
               "format": "uri",
               "maxLength": 2083,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The homepage of the institution.",
         "title": "Url"
      }
   }
}

Fields:
Validators:
field address: str | None = None

The address of the institution.

Validated by:
field internal_id: str | None = None

A user-specific identifier for an organization.

Validated by:
field name: str | None = None

The display name of the institution.

Validated by:
field ror: HttpUrl | None = None

The ROR (ror.org) identifier of the institution.

Validated by:
field url: HttpUrl | None = None

The homepage of the institution.

Validated by:
validator check_well_defined  »  all fields

Ensure that at least the internal ID, ROR, or name are provided.

Return type:

Self

validator clean_whitespace  »  name
Parameters:

v (str | None)

Return type:

str | None

validator validate_ror  »  ror

Ensure that ror is a valid ROR identifier.

Parameters:

v (Optional[Url])

Return type:

Optional[Url]