Skip to end of metadata
Go to start of metadata
This page describes the OOI metadata model and its implementation and generation

Summary

The official OOI metadata model documentation is placed here.

Implementation

OOI resource and object types and their attributes are defined in YML interface specification files. This files have all data definitions in them including documentation comments. In detail, this includes:

  • Object or resource type name
  • Object or resource type documentation string
  • Attribute name
  • Attribute type (one of string, integer, decimal number, boolean, NIL value, list/array, associative array/dict/map, nested object)
  • Attribute default value
  • Attribute documentation string
  • Attribute framework decorator hints

Some resource and object types are user relevant, others are system internal only and others are to be ignored (because they are part of examples, demos or retired code). Within user relevant resource and object types, some attributes are system internal only. Every resource and object type can have system internal attributes and these can be added as needed to enable system operations. These system internal attributes are not subject to the OOI metadata model.

Metadata Model Maintenance

The official OOI process is documented here.

YML files can be updated using the code pull request mechanism. Updates to OOI metadata model controlled attributes need ECR approval.

Generation

Object Model Export from YML to CSV

Look for the generated file "interface/object_model.csv"

Paste into this Excel document to compute a report or filter

References

See Also:

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.