herd icon indicating copy to clipboard operation
herd copied to clipboard

Manage Format Lineage

Open nateiam opened this issue 7 years ago • 0 comments

As a Herd Publisher I want to register lineage at the Format level so I others can utilize this when performing monitoring or visualizing lineage

Each Format can point to one or more Formats that are upstream in their lineage. This is conceptually similar to the way BData parents are registered.

Formats lineage will be defined by a key that does not include version. The public interface will take in and return this version-less key.

Acceptance Criteria

  • A new Business Object Format Parents Put endpoint is added that takes a list of parent formats as an input:
    • List of Parent Formats is defined by Format Key without a version - Namespace, BDef Name, Usage, File Type
    • Return appropriate 40x error if any specified parent does not exist
    • The Format Parents Put updates the list of parents by replacing the entire list with the incoming list
    • The currently existing Business Object Format Format Put is not updated
  • New PUT endpoint permissions:
    • WRITE authorization is required on the Namespace of the Format being updated and READ authorization on all specified parents
  • You cannot delete a Format that is the parent in a lineage chain.
  • No check for parents that point to themselves - same as BData lineage, too difficult to track
  • Existing Format GET returns parent and children information
    • For each parent and child, return Format Key of Namespace, BDef Name, Usage, File Type

nateiam avatar May 13 '17 20:05 nateiam