Add ability to resolve OpenAPI schema references during component generation

[riyaa14]

Description

This PR fixes meshery/meshery#14117

Notes for Reviewers

Implementation Details

1. Generate() is a common function used by both Artifact Hub and GitHub to Generate Component Definition from a single CRD. Thus, resolving schemas here would be ideal.
2. GetResolvedManifest already implemented was re-used for this purpose, it resolves $ref fields that refer to standard OpenAPI component schema paths (e.g., #/components/schemas/...); external or non-standard references are not handled.

Test
Tested with a test CRD containing schema references using mesheryctl registry generate - Link to Test CRD

Before

After

Signed commits

• [*] Yes, I signed my commits.

[gemini-code-assist]

Hello @riyaa14, 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

This pull request addresses issue #14117 by adding the ability to resolve OpenAPI schema references during component generation. The changes modify the Generate function in generator.go and GenerateFromOpenAPI function in openapi_generator.go to resolve $ref fields in OpenAPI schemas. It reuses the existing GetResolvedManifest function to resolve these references, focusing on standard OpenAPI component schema paths. External or non-standard references are not handled. The PR also renames the getResolvedManifest function to GetResolvedManifest and exports it.

Highlights

• Schema Resolution: Implements OpenAPI schema reference resolution during component generation using GetResolvedManifest.
• Function Modification: Modifies Generate in generator.go (lines 64, 72) and GenerateFromOpenAPI in openapi_generator.go (line 27) to utilize the schema resolution.
• Function Rename: Renames getResolvedManifest to GetResolvedManifest in openapi_generator.go (line 177) and exports it.

Changelog

• utils/component/generator.go
  • Modified the Generate function to resolve OpenAPI schema references using GetResolvedManifest before converting the resource to CUE format. (lines 64, 72)
  • Added error handling for cases where no schemas are found, defaulting to the original resource.
• utils/component/openapi_generator.go
  • Modified the GenerateFromOpenAPI function to use GetResolvedManifest for resolving schema references. (line 27)
  • Renamed getResolvedManifest to GetResolvedManifest and exported it. (line 177)

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 reference so deep,
In schemas where secrets sleep,
Resolved with a call,
Components stand tall,
From chaos, order to keep.

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 introduces the ability to resolve OpenAPI schema references during component generation, which addresses issue #14117. The changes involve modifying the Generate function in generator.go and renaming/exporting getResolvedManifest to GetResolvedManifest in openapi_generator.go. The implementation reuses the existing GetResolvedManifest function to resolve $ref fields in OpenAPI schemas. Overall, the changes seem well-structured and address the intended issue.

Summary of Findings

• Error Handling: The code handles the ErrNoSchemasFound error, but it might be beneficial to log or provide a more informative message when this error occurs, as it could indicate a problem with the input resource.
• Function Naming: The function getResolvedManifest was renamed to GetResolvedManifest and exported. This is good for reusability, but ensure that the function is used consistently across the codebase.

Merge Readiness

The pull request appears to be well-structured and addresses the intended issue. However, it's recommended to address the error handling suggestion to provide more informative messages when ErrNoSchemasFound occurs. I am unable to directly approve this pull request, and users should have others review and approve this code before merging. Given the medium severity issue, I recommend that the pull request not be merged until it is addressed.