You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ossie.apache.org by "kayemkim (via GitHub)" <gi...@apache.org> on 2026/08/31 09:07:17 UTC

[PR] docs(spec): add ai_context to the Relationship node in spec.yaml [ossie]

kayemkim opened a new pull request, #350:
URL: https://github.com/apache/ossie/pull/350

   ## Summary
   
   `Relationship` was the only node where the two core-spec files disagreed on whether a field exists: the JSON schema's `$defs/Relationship` carries `ai_context`, and the spec.md property table lists it, but the `relationships:` block in `spec.yaml` omitted it. Every other node lists it in both files.
   
   This adds the property to the block, placed before `custom_extensions` with the comment style of the sibling nodes. `spec.yaml` still parses.
   
   ## Related Issues
   
   Fixes #340.
   
   ## Checklist
   
   ### Specification
   - [x] Spec changes are included in `core-spec/` and follow the existing structure
   - [x] Spec changes have been discussed on the mailing list or in a linked issue
   - [ ] Breaking changes to the spec are clearly called out in the summary
   
   ### Ontology
   - [ ] Ontology changes in `ontology/` are consistent with spec changes
   - [ ] New or modified terms are defined and documented
   
   ### Converters
   - [ ] Converter logic in `converters/` is updated to reflect spec or ontology changes
   - [ ] New converters include tests under the converter's test directory
   
   ### Validation
   - [ ] Validation rules in `validation/` are updated if the spec changed
   - [ ] New validation cases are covered by tests
   
   ### Documentation
   - [ ] `docs/` is updated to reflect any user-facing changes
   - [ ] New features or behaviors are documented with examples where appropriate
   - [ ] `CONTRIBUTING.md` is updated if the contribution process changed
   
   ### Examples
   - [ ] `examples/` are added or updated for any new spec constructs or converter support
   
   ### Tests
   - [ ] All existing tests pass (`pytest` / CI green)
   - [ ] New functionality is covered by tests
   
   ### Compliance
   - [ ] ASF license headers are present on all new source files
   - [x] No third-party dependencies are added without PMC/IPMC approval


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs(spec): add ai_context to the Relationship node in spec.yaml [ossie]

Posted by "kayemkim (via GitHub)" <gi...@apache.org>.
kayemkim commented on code in PR #350:
URL: https://github.com/apache/ossie/pull/350#discussion_r3909408778


##########
core-spec/spec.yaml:
##########
@@ -171,6 +171,10 @@ relationships:
     #   - [order_id, line_number]    # Composite key
     to_columns: []  # Array of column names
 
+    # Optional: Additional context for AI tools (e.g., synonyms, business context)
+    # Helps LLMs understand when and why the datasets should be joined
+    ai_context: string

Review Comment:
   Agreed. Pushed a change that documents the object form (instructions/synonyms/examples) in a comment above the field, the way primary_key and unique_keys show their alternate shapes. I kept the live value as `ai_context: string` to stay in line with the sibling nodes, since reworking the string-only notation across the file is what #141 tracks; or I can switch the live value to the nested form if you'd rather lead with it here.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs(spec): align spec.yaml ai_context with the schema at every node [ossie]

Posted by "kayemkim (via GitHub)" <gi...@apache.org>.
kayemkim commented on PR #350:
URL: https://github.com/apache/ossie/pull/350#issuecomment-5601766595

   I went back through the history on this, and the notation question already has an answer in the tracker. #141 proposes this exact form in its suggested resolution, khush-bhatia asked for it on #221 (spelling out instructions, synonyms and examples as a fixed set understates AIContext, which sets additionalProperties: true), and you agreed with it there. #221 has had changes requested since July 17 without being picked back up, so instead of asking you to choose between the two options I raised earlier, I have applied that form here:
   
       # Optional: Additional context for AI tools (e.g., custom prompts, instructions)
       # Can be either:
       #   - A free-form string, or
       #   - A structured object with optional keys:
       #       instructions: string  # how AI should use this entity
       #       synonyms:     []      # alternative names / terms
       #       examples:     []      # sample questions or use cases
       #     (additionalProperties: true, so vendors may add more keys)
       ai_context: {}  # see AIContext in ossie-schema.json
   
   The first commit puts the Relationship node in that form. The second extends it to semantic_model, datasets, fields and metrics, which all still read `ai_context: string`: fixing only Relationship would leave two notations for the same field in one file, and spec.md already documents string/object at all five nodes. That covers #141 as well. If you would rather keep this PR to the single node it started with, dropping the second commit does that.
   
   spec.yaml still parses, and $defs for all five nodes reference AIContext.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs(spec): align spec.yaml ai_context with the schema at every node [ossie]

Posted by "jbonofre (via GitHub)" <gi...@apache.org>.
jbonofre merged PR #350:
URL: https://github.com/apache/ossie/pull/350


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs(spec): add ai_context to the Relationship node in spec.yaml [ossie]

Posted by "jbonofre (via GitHub)" <gi...@apache.org>.
jbonofre commented on code in PR #350:
URL: https://github.com/apache/ossie/pull/350#discussion_r3904711719


##########
core-spec/spec.yaml:
##########
@@ -171,6 +171,10 @@ relationships:
     #   - [order_id, line_number]    # Composite key
     to_columns: []  # Array of column names
 
+    # Optional: Additional context for AI tools (e.g., synonyms, business context)
+    # Helps LLMs understand when and why the datasets should be joined
+    ai_context: string

Review Comment:
   The schema, `spec.md`, the Python models, and the TPC-DS example all treat relationship `ai_context` as string-or-object. This PR fixes "field is missing" and introduces "field has the wrong type" (corresponding to #141). 
   
   I think it's worth changing to reflect both forms before merge, since `spec.yaml` handles nested shapes elsewhere (`expressions`, `dimensions`).



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org