You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ossie.apache.org by "utkarshparekh (via GitHub)" <gi...@apache.org> on 2026/07/14 05:10:43 UTC
Re: [I] core-spec/spec.yaml declares `ai_context: string` but the JSON schema + canonical example use a structured object [ossie]
utkarshparekh commented on issue #141:
URL: https://github.com/apache/ossie/issues/141#issuecomment-4965605519
Hi @epeyman, @onkardahale, and @khush-bhatia
I’m interested in preparing a focused PR for this issue, but I’d like to confirm ownership and scope before starting.
First, are either @epeyman or @onkardahale currently working on a PR? I don’t want to duplicate anyone’s work.
I compared the current representations and understand the intended behavior as follows:
- `core-spec/osi-schema.json` defines `AIContext` as either a free-form string or a structured object.
- The structured object supports `instructions`, `synonyms`, and `examples`, while allowing additional properties.
- `core-spec/spec.md` and the Python models already represent this union correctly.
- This applies to five locations: semantic models, datasets, relationships, fields, and metrics.
- `core-spec/spec.yaml` currently says `ai_context: string` in four locations and omits `ai_context` from the relationship section.
If the issue is available, my proposed minimal scope is:
1. Update the four existing `ai_context` entries in `core-spec/spec.yaml` to describe both supported forms.
2. Add the missing optional `ai_context` entry to the relationship section.
3. Leave `osi-schema.json`, `spec.md`, Python models, examples, and converters unchanged because their behavior is already correct.
4. Keep the version at `0.2.0.dev0`, since this clarifies existing behavior rather than changing the specification.
5. Validate that `spec.yaml` still parses and that both string and structured forms continue to validate against `osi-schema.json`.
For the placeholder notation, I suggest using:
```yaml
# Optional: Additional context for AI tools.
# Either a free-form string or a structured object with optional
# instructions, synonyms, examples, and additional properties.
ai_context: string/object # See AIContext in osi-schema.json
--
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