spec: is identify_by inherited through extends?

Open
#692 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
json, markdown, python

Research direction

Read ontology/ontology.md (especially “Identifiers” and the derived-subtype example), core-spec/spec.md, and ontology/ontology.json to decide how the rule should be expressed consistently. The issue recommends documenting that identify_by is not inherited and adding a validation warning, but these changes involve specification and implementation work; done means the inheritance rule and example are clear and the warning covers the described case.

Written by the indexing model from the issue text.

Description

needs-triage

ontology/ontology.md ("Identifiers") says identify_by "allows modelers to list the names of relationships that form the preferred identifier of a concept". Nothing in ontology.md, core-spec/spec.md, or ontology/ontology.json says whether a concept that extends another inherits the parent's identify_by, or must declare its own.

The reference implementation (now in apache/ossie-converters, ontology/src/ossie_ontology/converter/spec_to_ossie/converter.py, _populate_ontology) resolves the question one way without documenting it: it builds identify_by only from the concept's own identify_by list. A subtype that declares none — as Customer did in the first revision of #310 — resolves to an empty identifier even though it extends a concept with a preferred identifier and every one of its objects is identifiable by it.

Note the asymmetry: lookup_concept_relationship does walk extends when resolving a relationship name, so identify_by: [ nr ] on the subtype resolves to BusinessPartner.nr. The lookup inherits; the identifier list does not.

First raised by @jbonofre in the #310 review.

Proposal
  1. Document the rule. Recommended: identify_by is not inherited and must be declared on every entity type that is meant to be referenced. This matches the engine's behaviour today, and avoids ambiguity when a concept has more than one parent in extends.
  2. Add a validation warning when an entity type with a non-empty extends declares no identify_by and none of its parents' identifiers is restated — the silent empty identifier is what made #310's defect invisible until the engine ran.
  3. Update the Employee-style derived-subtype example in ontology.md to show the explicit declaration.
Dominant language
Python
Stars
2.7k
Forks
353
Avg merge
3d 19h
Merged PRs (30d)
86

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/ossie

All issues in apache/ossie

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.