Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate APIView into SDK Automation #2341

Closed
weshaggard opened this issue Sep 10, 2021 · 4 comments
Closed

Integrate APIView into SDK Automation #2341

weshaggard opened this issue Sep 10, 2021 · 4 comments
Assignees
Labels
APIView Priority 2 APIView Central-EngSys This issue is owned by the Engineering System team. feature-request This issue requires a new behavior in the product in order be resolved.

Comments

@weshaggard
Copy link
Member

As part of improving the API review process we want to SDK Automation and PR process for the specs repo to include generating a APIView review session for the changes in the specs PR.

High level requirements:

  • Generate review for the relative changes in the PR
  • Post a comment with a link to the review in the PR
  • The review should already have diffs pre-computed so when the link is clicked it loads quickly (unlike the current link to OpenAPI hub diff which takes a while to load).
  • We should figure out how to integrate the existing OpenAPI links with APIView.
@praveenkuttappan praveenkuttappan transferred this issue from Azure/azure-sdk Nov 24, 2021
@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Nov 24, 2021
@praveenkuttappan praveenkuttappan added APIView feature-request This issue requires a new behavior in the product in order be resolved. APIView Priority 2 and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Nov 24, 2021
@zhenglaizhang zhenglaizhang assigned ruowan and unassigned zhenglaizhang Jan 4, 2022
@mikekistler mikekistler assigned dw511214992 and unassigned ruowan Jun 6, 2022
@maririos maririos added the Central-EngSys This issue is owned by the Engineering System team. label Oct 17, 2022
@azure-sdk azure-sdk moved this to 🤔Triage in Azure SDK EngSys 🤖🧠 Oct 17, 2022
@dw511214992
Copy link
Member

I think we only need to take care of 3rd requirement because others are supported. To support 3rd requirement, we need to ask apiview service to return the apiview link to apiview diff directly. @praveenkuttappan @maririos

@maririos
Copy link
Member

maririos commented Nov 1, 2022

If I understand correctly Wei's comment, then this will land with the work @ruowan is doing

@maririos maririos moved this to 📋 Backlog in ApiView Nov 1, 2022
@weshaggard
Copy link
Member Author

I think once @ruowan's work is done we will be close to this but I think we also need to get the baseline diffs added to ApiView as well and once that is done I will consider this done for swagger/openapi. I believe we already have another issue tracking cadl.

@maririos
Copy link
Member

maririos commented Nov 4, 2022

Thanks @weshaggard . Here is the summary:

This is the issue for Cadl and PR support: #3991

Because work is tracked in specific issues I am going to close this one. If I missed something, feel free to re-open or file a speciic issue

@maririos maririos closed this as completed Nov 4, 2022
Repository owner moved this from 🤔Triage to 🎊Closed in Azure SDK EngSys 🤖🧠 Nov 4, 2022
Repository owner moved this from 📋 Backlog to ✅ Done in ApiView Nov 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIView Priority 2 APIView Central-EngSys This issue is owned by the Engineering System team. feature-request This issue requires a new behavior in the product in order be resolved.
Projects
Status: ✅ Done
Development

No branches or pull requests

7 participants