View facet info with BDef Search results

[nateiam]

As a Big Data Developer I want to see how a set of BDef are classified so I can better understand the BDef in the set

Acceptance Criteria

• In BDef Search endpoint, new optional parameter that allows user to specify they want Facet data with response
• In BDef Search endpoint, required FacetFields parameter if Facet is specified. Only supported FacetFields at this time are TagType and Tag.
  • User can supply TagType, Tag, or both. If Tag is provided, facet value and count is returned for each Tag. Same for TagType. If both are provided, the facets are not returned with a hierarchy.
• If user specifies Facets, Bdef Search response includes facet data:
  • Includes list of all unique FacetField values for all BDef in the result set (eg list of all TagTypes and/or Tags)
  • For each FacetField value, includes a count of how many BDef in the result set are associated with that value
  • Changes to response should be additive and backward compatible
  • The values and counts should be based on the actual associations, not considering any additional parts of the hierarchy in the case of TagType

Example to illustrate counts If you have a list of related data entities that are tagged as follows:

• 1 tagged as A
• 3 tagged as B (child of A)
• 5 tagged as C (child of A)

Then the counts in the faced should read as:

• TagType1 = A (1), B = (3), C = (5) NOT
• TagType1 = A (9), B = (3), C = (5)

This shows how the faceting counts reflect the actual tagging, not the hierarchical inheritance of tagging.