Miscellaneous

Pydantic model esgvoc.api.search.Item

Bases: BaseModel

An item from the universe or a project (data descriptor, collection or term).

Show JSON schema

{
   "title": "Item",
   "description": "An item from the universe or a project (data descriptor, collection or term).",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      },
      "kind": {
         "$ref": "#/$defs/ItemKind"
      },
      "parent_id": {
         "title": "Parent Id",
         "type": "string"
      }
   },
   "$defs": {
      "ItemKind": {
         "enum": [
            "data_descriptor",
            "collection",
            "term"
         ],
         "title": "ItemKind",
         "type": "string"
      }
   },
   "required": [
      "id",
      "kind",
      "parent_id"
   ]
}

field id: str [Required]

The id of the item.

field kind: ItemKind [Required]

The kind of the item.

field parent_id: str [Required]

The id of the parent of the item.

class esgvoc.api.search.ItemKind(*values)

Bases: Enum

COLLECTION = 'collection'

Corresponds to a collection

DATA_DESCRIPTOR = 'data_descriptor'

Corresponds to a data descriptor

TERM = 'term'

Corresponds to a term

class esgvoc.core.db.models.mixins.TermKind(*values)

Bases: Enum

The kinds of term.

COMPOSITE = 'composite'

Term composed of terms.

MIXED = 'mixed'

To be defined.

PATTERN = 'pattern'

Regex based terms

PLAIN = 'plain'

End written term.

exception esgvoc.core.exceptions.EsgvocDbError

Bases: EsgvocException

Represents errors relative to data base management.

exception esgvoc.core.exceptions.EsgvocException

Bases: Exception

Class base of all ESGVOC errors.

exception esgvoc.core.exceptions.EsgvocNotFoundError

Bases: EsgvocException

Represents the not found errors.

exception esgvoc.core.exceptions.EsgvocNotImplementedError

Bases: EsgvocException

Represents not implemented errors.

exception esgvoc.core.exceptions.EsgvocValueError

Bases: EsgvocException

Represents value errors.