B2B REST API QA용 PR #879
B2B REST API QA용 PR #879
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @LimJiGyu, 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!
Summary of Changes
Hello team, gemini-code-assist here to provide a summary of this pull request. This PR, titled "B2B REST API QA용 PR", is described as a temporary PR created to facilitate QA for the B2B Public API opening by utilizing the API guide. The core change involves updating the script responsible for downloading API schemas to fetch them from a specific feature branch (feat/b2b-public-api) instead of the main branch. This allows the project consuming these schemas (likely the API guide) to work with the latest definitions from the ongoing B2B API development.
Highlights
- Temporary PR for B2B API QA: This pull request is explicitly marked as temporary and is intended to support the QA process for the upcoming B2B Public API.
- Update Schema Source Branch: The script used to download OpenAPI and GraphQL schemas has been modified to pull from the
feat/b2b-public-apibranch instead ofmain.
Changelog
- scripts/download-schema.ts
- Updated the source URL for downloading
openapi.ymlto point to thefeat/b2b-public-apibranch (line 126). - Updated the source URL for downloading
schema.graphqlto point to thefeat/b2b-public-apibranch (line 154).
- Updated the source URL for downloading
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.
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. ↩
|
There was a problem hiding this comment.
Code Review
This pull request updates the schema download script to fetch OpenAPI and GraphQL schemas from the feat/b2b-public-api branch. This change aligns with the stated objective of facilitating QA for the B2B Public API using an API guide from this specific feature branch. The modifications are clear and directly support this temporary purpose.
Summary of Findings
- Temporary Feature Branch URLs: The script has been updated to download API schemas from a specific feature branch (
feat/b2b-public-api). This is suitable for the temporary QA activities on that feature. However, these feature-specific URLs pose a risk if the changes are merged intomainor other long-lived branches, as the script would then point to a schema that might become outdated or be from a deleted branch. It's recommended to add reminders (e.g.,TODOcomments) to revert these URLs or make them configurable before such merges.
Merge Readiness
The changes in this PR are well-aligned with its temporary QA purpose. The primary concern is the hardcoding of feature-branch specific URLs in the schema download script. While acceptable for isolated QA on the feat/b2b-public-api branch, it's crucial to ensure these URLs are reverted to point to the main branch (or made configurable) before these script modifications are merged into main, develop, or any other long-lived or production-related branch. Addressing the points in the review comments, perhaps by adding TODO reminders, would be advisable.
As a reviewer, I am not authorized to approve pull requests. Please ensure this PR undergoes further review and receives approval from authorized team members before any merge action, keeping in mind the temporary nature of these URL changes and the potential impact if merged into permanent branches without adjustments.
| export async function downloadV2Openapi() { | ||
| const src = | ||
| "https://raw.githubusercontent.com/portone-io/public-api-service/main/schema/openapi.yml"; | ||
| "https://raw.githubusercontent.com/portone-io/public-api-service/feat/b2b-public-api/schema/openapi.yml"; |
There was a problem hiding this comment.
The src URL for the OpenAPI schema now points to the feat/b2b-public-api branch. While this is perfectly fine for QA activities specific to this feature branch, could you clarify the plan for this URL when these script changes are considered for merging into more permanent branches like main or develop?
Hardcoding feature branch URLs can lead to fetching outdated or incorrect schemas if the feature branch is later deleted or becomes stale. To mitigate this, would it be helpful to add a TODO comment here as a reminder to revert to the main branch URL or to make this URL configurable before any merge into a long-lived branch? For example:
// TODO(QA): Revert to 'main' branch URL or make configurable before merging to main/develop.
const src =
"https://raw.githubusercontent.com/portone-io/public-api-service/feat/b2b-public-api/schema/openapi.yml";| export async function downloadV2Graphql() { | ||
| const src = | ||
| "https://raw.githubusercontent.com/portone-io/public-api-service/main/schema/schema.graphql"; | ||
| "https://raw.githubusercontent.com/portone-io/public-api-service/feat/b2b-public-api/schema/schema.graphql"; |
There was a problem hiding this comment.
Similarly, the src URL for the GraphQL schema is also updated to point to the feat/b2b-public-api branch. The same considerations apply here as for the OpenAPI schema URL.
To ensure the script remains robust and fetches the correct schema in different contexts (e.g., after this QA phase or if merged into main), what's the strategy for managing this feature-specific URL? A TODO comment or a plan to revert/configure this URL would be beneficial to prevent accidental use of a feature-branch schema in production or main development lines.
[요약]
B2B Public API 오픈을 위한 QA 진행 중 API 가이드를 활용하기 위해 임시 PR을 생성합니다.