Azure / Azure/azure-sdk-tools

Swagger APIView - Add a comment on swagger PR when there is a new comment on APIView

Open
#5,375 3 comments 0 reactions 0 assignees View on GitHub
APIView Central-EngSys Swagger
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

Swagger API review is generated automatically from pull request. We should add a comment on pull request to indicate there are open comments on generated API review to inform the user to ensure they review the comments and close before they merge swagger PR. Unfortunately, we cannot provide a line-by-line correlation between API review comment to GitHub pull request change due to missing correlation information in APIView token file. So adding a comment on PR to indicate there is a comment on APIView is helpful for the time being.

Feature request here is to add/edit a comment on PR whenever someone adds a comment on APIView. We do not need to show actual comment itself. But showing a text like, `Automatically generated API review from this PR has some unresolved comments`

@heaths FYI...

Contributor guide

Open the contributing guide

Research direction

Start by tracing the APIView comment flow and the GitHub pull request integration mentioned in the issue. The work is done when adding a comment in APIView causes the related PR to receive or update a comment indicating that the generated API review has unresolved comments, without duplicating the notification.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, github
Domain
api, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.