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:

• address (str | None)

• internal_id (str | None)

• name (str | None)

• ror (pydantic_core._pydantic_core.Url | None)

• url (pydantic_core._pydantic_core.Url | None)

Validators:

• check_well_defined » all fields

• clean_whitespace » name

• validate_ror » ror

field address: str | None = None

The address of the institution.

Validated by:

• check_well_defined

field internal_id: str | None = None

A user-specific identifier for an organization.

Validated by:

• check_well_defined

field name: str | None = None

The display name of the institution.

Validated by:

• check_well_defined

• clean_whitespace

field ror: HttpUrl | None = None

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

Validated by:

• check_well_defined

• validate_ror

field url: HttpUrl | None = None

The homepage of the institution.

Validated by:

• check_well_defined

validator check_well_defined  »  all fields

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

validator clean_whitespace  »  name

Return type:

Optional[str]

Parameters:

v (Optional[str]) –

validator validate_ror  »  ror

Ensure that ror is a valid ROR identifier. :rtype: Optional[Url]

Parameters:

v (Optional[Url]) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.