Miscellaneous

Miscellaneous#

Pydantic model esgvoc.api.search.Item[source]#

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][source]#

The id of the item.

field kind: ItemKind [Required][source]#

The kind of the item.

field parent_id: str [Required][source]#

The id of the parent of the item.

Pydantic model esgvoc.api.search.MatchingTerm[source]#

Bases: BaseModel

Place holder for a term that matches a value (term validation).

Show JSON schema
{
   "title": "MatchingTerm",
   "description": "Place holder for a term that matches a value (term validation).",
   "type": "object",
   "properties": {
      "project_id": {
         "title": "Project Id",
         "type": "string"
      },
      "collection_id": {
         "title": "Collection Id",
         "type": "string"
      },
      "term_id": {
         "title": "Term Id",
         "type": "string"
      }
   },
   "required": [
      "project_id",
      "collection_id",
      "term_id"
   ]
}

field collection_id: str [Required][source]#

The collection id to which the term belongs.

field project_id: str [Required][source]#

The project id to which the term belongs.

field term_id: str [Required][source]#

The term id.

class esgvoc.api.search.ItemKind(*values)[source]#

Bases: Enum

COLLECTION = 'collection'[source]#

Corresponds to a collection

DATA_DESCRIPTOR = 'data_descriptor'[source]#

Corresponds to a data descriptor

TERM = 'term'[source]#

Corresponds to a term

class esgvoc.core.db.models.mixins.TermKind(*values)[source]#

Bases: Enum

The kinds of term.

COMPOSITE = 'composite'[source]#

Term composed of terms.

MIXED = 'mixed'[source]#

To be defined.

PATTERN = 'pattern'[source]#

Regex based terms

PLAIN = 'plain'[source]#

End written term.

exception esgvoc.core.exceptions.EsgvocDbError[source]#

Bases: EsgvocException

Represents errors relative to data base management.

exception esgvoc.core.exceptions.EsgvocException[source]#

Bases: Exception

Class base of all ESGVOC errors.

exception esgvoc.core.exceptions.EsgvocNotFoundError[source]#

Bases: EsgvocException

Represents the not found errors.

exception esgvoc.core.exceptions.EsgvocNotImplementedError[source]#

Bases: EsgvocException

Represents not implemented errors.

exception esgvoc.core.exceptions.EsgvocValueError[source]#

Bases: EsgvocException

Represents value errors.

Contents