metadata.api.views package¶

Subpackages¶

metadata.api.views.systems package

Submodules¶

metadata.api.views.defaulting module¶

class metadata.api.views.defaulting.CrudType(value)¶

Bases: Enum

An enumeration.

CREATE = 1¶

DELETE = 4¶

OTHER = 5¶

READ = 2¶

UPDATE = 3¶

class metadata.api.views.defaulting.DefaultUsecase(name, crud_types, model, attributes)¶

Bases: object

Parameters:

name (str)
crud_types (List[CrudType])
model (Dict[str, Any])
attributes (List[ModelAttribute])

class metadata.api.views.defaulting.ModelAttribute(name, type, derived, enum)¶

Bases: object

Parameters:

name (str)
type (str)
derived (bool)
enum (str | None)

metadata.api.views.defaulting.build_data(default_use_case_objects)¶

Return type:: Dict[str, Any]
Parameters:: default_use_case_objects (List[DefaultUsecase])

metadata.api.views.defaulting.build_data_categories(default_use_case_objects)¶

Return type:: List[Dict[str, Any]]
Parameters:: default_use_case_objects (List[DefaultUsecase])

metadata.api.views.defaulting.build_data_pages(sections)¶

Return type:: List[Dict[str, Any]]
Parameters:: sections (List[Dict[str, Any]])

metadata.api.views.defaulting.build_data_section_attributes(use_case)¶

Return type:: List[Dict[str, Any]]
Parameters:: use_case (DefaultUsecase)

metadata.api.views.defaulting.build_data_section_operations(use_case)¶

Return type:: Dict[str, Any]
Parameters:: use_case (DefaultUsecase)

metadata.api.views.defaulting.build_data_sections(default_use_case_objects)¶

Return type:: List[Dict[str, Any]]
Parameters:: default_use_case_objects (List[DefaultUsecase])

metadata.api.views.defaulting.build_data_styling()¶

Return type:: Dict[str, Any]

metadata.api.views.defaulting.create_default_interface(system, actor)¶

Return type:

ReadInterface

Parameters:

system (System)
actor (Classifier)

metadata.api.views.defaulting.get_class_acted_on(system, use_case_name)¶

Return type:

str

Parameters:

system (System)
use_case_name (str)

metadata.api.views.defaulting.get_class_attributes(class_id)¶

Return type:: List[ModelAttribute]
Parameters:: class_id (str)

metadata.api.views.defaulting.get_crud_type(use_case_name)¶

Return type:: CrudType
Parameters:: use_case_name (str)

metadata.api.views.defaulting.get_default_interface_data(system, actor)¶

Return type:

str

Parameters:

system (System)
actor (Classifier)

metadata.api.views.defaulting.get_default_use_cases(system, relevant_use_cases)¶

Return type:

List[DefaultUsecase]

Parameters:

system (System)
relevant_use_cases (List[Classifier])

metadata.api.views.defaulting.get_directly_linked_use_cases(system, actor)¶

Return type:

List[Classifier]

Parameters:

system (System)
actor (Classifier)

metadata.api.views.defaulting.get_extended_use_cases(system, use_cases)¶

Return type:

List[Classifier]

Parameters:

system (System)
use_cases (List[Classifier])

metadata.api.views.interfaces module¶

metadata.api.views.projects module¶

metadata.api.views.releases module¶

Module contents¶

metadata.api.views.create_default_interface(system, actor)¶

Return type:

ReadInterface

Parameters:

system (System)
actor (Classifier)