replace complete reference to model with trimmed identifier

[mrmerlin320]

Notes for Reviewers

This PR fixes #

Signed commits

• Yes, I signed my commits.

[gemini-code-assist]

Hello @mrmerlin320, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello! Gemini here, providing a summary of this pull request.

This PR aims to refine the representation of Model within the codebase and schemas. Specifically, it replaces the use of the full ModelDefinition struct with a more lightweight ModelIdentifier struct/schema in places where only identification is needed, rather than the complete model details. This change promotes better separation of concerns and potentially improves performance by avoiding unnecessary data loading.

Highlights

• New ModelIdentifier Type: A new Go struct ModelIdentifier and its corresponding OpenAPI schema have been introduced to represent a trimmed-down version of a model, containing only essential identification fields (Name, Version, PlatformVersion).
• Refactored Component Definition: The Model field within the ComponentDefinition struct in Go has been updated to use the new ModelIdentifier type instead of the full ModelDefinition.
• Schema Simplification: JSON and OpenAPI schemas for Component and Relationship have been updated to reference the new ModelIdentifier schema, removing verbose inline definitions of the full model where only the identifier is required.
• Clarified Versioning: Comments and schema descriptions related to version fields in the model.go file and associated schemas have been updated to clearly distinguish between the 'Version of the model definition' and the 'Version of the platform for which the model is intended'.

Changelog

Click here to see the changelog

• models/v1beta1/component/component.go
  • Changed the type of the Model field in ComponentDefinition from model.ModelDefinition to model.ModelIdentifier (Line 127).
  • Updated the comment for the Model field to reflect it's now an identifier (Line 126).
• models/v1beta1/model/model.go
  • Added a type alias PlatformVersion for string (Line 65).
  • Updated the comment for the Version field in the Model struct to clarify it's the platform version (Line 157).
  • Updated the comment for the Version field in the ModelDefinition struct to clarify it's the model definition version (Line 169).
  • Updated the comment for the nested Version field within the Model struct in ModelDefinition to clarify it's the platform version (Line 208).
  • Added a new struct ModelIdentifier with PlatformVersion, Name, and Version fields (Lines 260-268).
• schemas/constructs/v1alpha3/relationship.json
  • Replaced the inline definition of the 'model' property with a $ref to the new ModelIdentifier schema (Lines 59-63).
• schemas/constructs/v1beta1/component/component.json
  • Updated the $ref for the 'model' property from ../model/model.json to ../model/openapi.yml#/components/schemas/ModelIdentifier (Line 68).
  • Changed the x-go-type for the 'model' property to model.ModelIdentifier (Line 69).
  • Removed the detailed description for the 'model' property (Line 74).
• schemas/constructs/v1beta1/component/merged-openapi.yml
  • Updated the x-go-type for the 'model' property to model.ModelIdentifier (Line 98).
  • Removed the detailed inline properties for the 'model' property (Lines 113-924).
  • Added a $ref to the ModelIdentifier schema definition (Line 106).
  • Added description and required fields for the 'model' property (Lines 107-111).
• schemas/constructs/v1beta1/model/merged-openapi.yml
  • Added the ModelIdentifier schema definition (Lines 179-218).
  • Added the PlatformVersion schema definition (Lines 220-231).
  • Updated the version property within the Model schema to reference PlatformVersion (Line 241).
  • Added definitions for name and version (Lines 261-279).
  • Updated the version property within ModelDefinition to reference the new version definition (Line 318).
  • Updated the name property within ModelDefinition to reference the new name definition (Line 337).
  • Updated the version property within the nested Model struct in ModelDefinition to reference PlatformVersion (Line 1037).
• schemas/constructs/v1beta1/model/model.json
  • Added definitions section for name and version (Lines 8-26).
  • Updated the version property to use $ref to the new version definition (Line 50).
  • Updated the name property to use $ref to the new name definition (Line 58).

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

A model, full and grand,
Was trimmed by skillful hand.
An identifier, neat and small,
Now answers duty's call.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request replaces complete model references with trimmed identifiers, enhancing maintainability and data efficiency. The introduction of PlatformVersion clarifies versioning. However, there are critical issues with JSON/YAML serialization tags that need to be addressed.

Summary of Findings

• JSON/YAML Tag Collision in ModelIdentifier: The PlatformVersion and Version fields in the ModelIdentifier Go struct are both tagged as json:"version" and yaml:"version". This is a critical issue causing serialization/deserialization conflicts. The tags for PlatformVersion need to be changed to be unique (e.g., platform_version or platformVersion).
• OpenAPI Schema Inconsistency for ModelIdentifier: The OpenAPI schemas defining or using ModelIdentifier (e.g., in model/merged-openapi.yml and component/merged-openapi.yml) have a field (often named platform_version in YAML) that is incorrectly tagged to produce json:"version". This conflicts with the model definition's version field and must be updated to align with the corrected Go struct tags, using a unique JSON key like platform_version or platformVersion.

Merge Readiness

This pull request is not ready to be merged due to a critical issue with JSON/YAML tag collisions in the ModelIdentifier struct and related schema inconsistencies. These issues must be addressed to ensure correct serialization and deserialization. Once these are resolved, the PR will be in much better shape. As an AI reviewer, I am not authorized to approve pull requests; please ensure further review and approval from team members before merging.

[n2h9]

Hey hello 😇 !

I think we should aim to have reference to json schema as much as we can and not to openapi.
Maybe this lays good on frontend, but f.e. backend struggle to handle this.
is it possible to achieve same result with referencing json schema definition, inside model/model.json or in separate schema file. ?