V1 REST API 문서에서 누락된 description들이 정상적으로 보여지도록 수정

[SonnySon17]

요약

V1 REST API 문서에서 x-portone-description이 표시되지 않던 문제를 해결했습니다.

문제

• OpenAPI 스키마에 x-portone-name과 x-portone-description 필드가 정의되어 있음
• 웹페이지에서 x-portone-name은 표시되지만 x-portone-description은 표시되지 않음
• 원인: 스키마 다운로드 시 x-portone-description을 HTML로 변환했는데, 프론트엔드에서 마크다운 파서로 처리하려고 해서 렌더링 실패

해결 방법

1. 스키마 다운로드 로직 수정

• scripts/download-schema.ts에서 x-portone-description을 HTML로 변환하지 않고 원본 텍스트 그대로 유지
• 프론트엔드에서 마크다운으로 렌더링할 수 있도록 수정

2. 스키마 파일 업데이트

• V1 OpenAPI 스키마 재다운로드
• x-portone-description이 이제 일반 텍스트 형식으로 저장됨

테스트

• 로컬에서 x-portone-description 정상 표시 확인

As-Is

To-Be

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
developers	Ready	Preview	Comment	Nov 20, 2025 6:02am

[gemini-code-assist]

Summary of Changes

Hello @SonnySon17, 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!

이 PR은 V1 REST API 문서에서 x-portone-description 필드가 올바르게 렌더링되지 않던 문제를 해결합니다. 스키마 다운로드 과정에서 해당 필드가 HTML로 변환되어 프론트엔드의 마크다운 파서와 충돌하는 문제를 수정하여, 이제 x-portone-description이 의도한 대로 표시될 것입니다.

Highlights

• API 문서 표시 문제 해결: V1 REST API 문서에서 x-portone-description 속성이 정상적으로 표시되지 않던 문제를 해결했습니다.
• 원인 분석: 문제의 원인은 스키마 다운로드 시 x-portone-description이 HTML로 변환되었으나, 프론트엔드에서는 이를 마크다운으로 처리하려 했기 때문입니다.
• 스키마 다운로드 로직 수정: scripts/download-schema.ts 파일에서 x-portone-description 속성을 HTML로 변환하지 않고 원본 텍스트 그대로 유지하도록 수정했습니다.
• 스키마 파일 업데이트: V1 OpenAPI 스키마를 재다운로드하여 x-portone-description이 일반 텍스트 형식으로 저장되도록 업데이트했습니다.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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

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

V1 REST API 문서에서 x-portone-description 프로퍼티가 올바르게 표시되지 않던 문제를 해결하기 위한 변경 사항을 확인했습니다. scripts/download-schema.ts 파일에서 x-portone-description 프로퍼티에 대해 GFM 렌더링을 건너뛰도록 조건을 추가하여, 프론트엔드에서 마크다운으로 정상 처리될 수 있도록 수정한 점이 좋습니다. 변경된 코드는 명확하며, 설명된 문제를 정확히 해결합니다. 좋은 수정입니다.

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud