2.1.1. Code documentation for the CEDAR utilities

The CEDAR client will provide all the links the the CEDAR API functionality such as get, post and updates on templates, template elements, folders, instances ect …

class client.ClientBase

The base class for all client classes .. warning:: Do not use

Parameters:db (StorageEngine) – the storage engine

class client.FullSemDiffClient

Resolves the two given networks and compares their semantic values based on bound context files

on_get(req, resp)

Process the get request

Parameters:

• req – the user request
• resp – the server response

class client.InstanceValidatorClient

Validates a given instance against a given schema

on_get(req, resp)

Process the get request

Parameters:

• req – the user request
• resp – the server response

class client.MergeEntitiesClient

Resolves a network from given URL and validates each schema

on_get(req, resp)

Process the get request

Parameters:

• req – the user request
• resp – the server response

class client.NetworkCompilerClient

Resolves all references and sub references for a given schema URL

on_get(req, resp)

Process the get request

Parameters:

• req – the user request
• resp – the server response

class client.NetworkValidatorClient

Resolves a network from given URL and validates each schema

on_get(req, resp)

Process the get request

Parameters:

• req – the user request
• resp – the server response

class client.Schema2ContextClient

Fully resolves a schema set from a given URL and creates the context template for each given ontology

on_get(req, resp)

Process the get request

Parameters:

• req – the user request
• resp – the server response

class client.SchemaValidatorClient

Validates a schema with the jsonschema library

on_get(req, resp)

Process the get request

Parameters:

• req – the user request
• resp – the server response

client.create_client()

Simple function that instantiates the app and creates the bridge to the API

Returns:the falcon app

client.max_body(limit)

Simple function to limit the size of the request

Parameters:limit (int) – the maxiùum size of the request Returns:

---

The schema2cedar classes will help you transform your JSON schemas draft 04 into compatible CEDAR schemas

class schema2cedar.Schema2CedarBase

The base converter class

Warning

This class should not be used! Use its children for converting to cedar template and template elements

static json_pretty_dump(json_object, output_file)

Dump a given json in the given file

Parameters:

• json_object (dict) – the input JSON to dump
• output_file (TextIOWrapper) – the file to dump the JSON to

Returns:

the dumping result

Return type:

string

static set_context()

Set the base context for a given template

Returns:the base context

static set_prop_context(schema)

Set the required context for the properties attribute of the given schema

Parameters:schema – an input JSON schema Returns:the properties context required by CEDAR

static set_properties_base_item()

Set the base properties required by CEDAR

Returns:the base property dictionary

static set_property_context()

Set the base context for a given template

Returns:the base context

static set_required_item(schema)

Set the required items that a CEDAR schema needs for a given schema

Parameters:schema – the input schema Returns:the dictionary of required items

static set_stripped_properties(schema)

Set the properties of a given schema

Parameters:schema – the input schema Returns:a dictionary of properties

static set_sub_context(schema)

Set the context required by CEDAR for each individual attribute/field for a given schema

Parameters:schema – the input schema Returns:the dictionary of required context for each field

static set_template_element_property_minimals(sub_context, schema)

Set the minimal elements of the properties attributes of a given schema and its sub-context

Parameters:

• sub_context – the schema sub-context
• schema – the input schema

Returns:

(dict) a dictionary of the required properties for CEDAR conversion

class schema2cedar.Schema2CedarTemplate

Schema 2 Template Converter, this is the one you want to use if you want to convert a schema into a template

convert_template(input_json_schema)

Method to convert a given schema into a CEDAR template

Parameters:input_json_schema – the input JSON schema Returns:the schema converted into a template

class schema2cedar.Schema2CedarTemplateElement

Schema to TemplateElement converter.

Warning

Should only be used to convert schemas to template element. If you want to convert a schema to a template, use Schema2CedarTemplate (it will automatically create nested template elements for you)

convert_template_element(input_json_schema, **kwargs)

Method to convert a given schema into a CEDAR template element

Parameters:

• input_json_schema – the input schema
• kwargs – optional parameter to provide the field name referencing that schema

Returns:

the schema converted to a CEDAR template element

find_sub_specs(schema, sub_spec_container)

Inspect a given schema to find and load its schemas dependencies

Parameters:

• schema – the input schema
• sub_spec_container – a container that will hold the dependencies

Return sub_spec_container:  

the filled container with the schema dependencies

load_sub_spec(path_to_load, parent_schema, field_key)

Load the given sub schema into memory

Parameters:

• path_to_load – path to the sub schema
• parent_schema – the parent schema that this sub-schema is referenced from
• field_key – the parent schema field name that this sub-schema is referenced from

Returns:

the string containing the loaded JSON schema