feat: add schema merge script #391
Conversation
|
Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, you can find updates in the #github-notifications channel in the community Slack. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @yash37158, I'm Gemini Code Assist1! 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!
I've added a new script to automate the merging and filtering of OpenAPI specifications. This script streamlines the process of generating comprehensive OpenAPI documents for both cloud and Meshery-specific contexts, ensuring consistency with existing schema generation patterns.
Highlights
- New Schema Merge Script: I've introduced scripts/merge-openapi-specs.sh, a new bash script designed to automate the aggregation and filtering of OpenAPI specifications.
- OpenAPI Specification Merging: The script utilizes @redocly/cli to join various individual OpenAPI YAML files, including base cloud schemas and different versions of construct schemas (v1beta1, v1alpha2), into a single schemas/merged_openapi.yml.
- Tag-based Schema Filtering: Following the merge, the script employs scripts/filterOpenapiByTag.js to generate two specialized OpenAPI files: schemas/cloud_openapi.yml (filtered by the 'cloud' tag) and schemas/meshery_openapi.yml (filtered by the 'meshery' tag), aligning with existing schema generation logic.
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 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 or fill out our survey 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.
Footnotes
-
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. ↩
Signed-off-by: yash37158 <[email protected]>
This reverts commit 7136cea. Signed-off-by: yash37158 <[email protected]>
Signed-off-by: yash37158 <[email protected]>
There was a problem hiding this comment.
Code Review
This pull request introduces a new script, scripts/merge-openapi-specs.sh, to merge OpenAPI specifications. The script is well-structured, using set -euo pipefail and proper error handling. My main concern is that the logic in this new script appears to be a duplication of the logic already present in generate-golang.sh (lines 93-109). Introducing duplicate code can lead to maintenance challenges, as changes will need to be applied in multiple places. I would strongly recommend refactoring generate-golang.sh to call this new script to avoid this duplication. I've also added a few specific comments to improve the script's code quality and maintainability.
|
|
||
| merged_construct="merged-openapi.yml" | ||
| v1beta1="schemas/constructs/v1beta1" | ||
| v1alpha1="schemas/constructs/v1alpha1" |
There was a problem hiding this comment.
The variable v1alpha1 is defined but never used in the script. To improve code clarity and maintainability, it's best to remove this unused variable.
| npx --yes @redocly/cli join schemas/base_cloud.yml \ | ||
| "${v1beta1}/pattern/${merged_construct}" \ | ||
| "${v1beta1}/component/${merged_construct}" \ | ||
| "${v1beta1}/model/${merged_construct}" \ | ||
| "${v1beta1}/subscription/${merged_construct}" \ | ||
| "${v1beta1}/plan/${merged_construct}" \ | ||
| "${v1beta1}/feature/${merged_construct}" \ | ||
| "${v1beta1}/workspace/${merged_construct}" \ | ||
| "${v1beta1}/environment/${merged_construct}" \ | ||
| "${v1alpha2}/catalog/${merged_construct}" \ | ||
| "${v1beta1}/evaluation/${merged_construct}" \ | ||
| "${v1beta1}/user/${merged_construct}" \ | ||
| "${v1beta1}/academy/${merged_construct}" \ |
There was a problem hiding this comment.
This list of files to merge is quite long and hardcoded. For better readability and maintainability, you could consider defining these files in a bash array and then expanding the array in the npx command. This would make the list easier to manage in the future.
| exit 1 | ||
| } | ||
|
|
||
| echo -e "${GREEN}✅ All done!${NC}" No newline at end of file |
There was a problem hiding this comment.
The script is missing a newline character at the end of the file. POSIX standards recommend that text files end with a newline character. This can prevent issues with some tools that process text files.
| echo -e "${GREEN}✅ All done!${NC}" | |
| echo -e "${GREEN}✅ All done!${NC}" | |
1 participant
Notes for Reviewers
This PR fixes #350
Signed commits