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

Swagger APIView for PR 21841 is missing information #5376

Closed
mikekistler opened this issue Feb 8, 2023 · 4 comments
Closed

Swagger APIView for PR 21841 is missing information #5376

mikekistler opened this issue Feb 8, 2023 · 4 comments
Assignees
Labels
APIView Central-EngSys This issue is owned by the Engineering System team.

Comments

@mikekistler
Copy link
Member

The Swagger APIView for PR 21841 is missing several important bits of information on the REST API:

  • The properties of the 202 response for POST on /emails:send are not rendered.

image

  • The Operation-Id header parameter for POST on /emails:send is not rendered.
@mikekistler mikekistler added the Central-EngSys This issue is owned by the Engineering System team. label Feb 8, 2023
@ruowan
Copy link
Member

ruowan commented Feb 9, 2023

@mikekistler Here is the fix version APIView of communicationEmail service https://apiviewstaging.azurewebsites.net/Assemblies/Review/cce8b46c14a947dd9a74d636b52f725a

The first issue has been fixed. And the second issue will be fixed in this PR. #5386

@mikekistler
Copy link
Member Author

The first issue is occurring in APIViews generated as recently as 4 days ago:

https://apiview.dev/Assemblies/Review/3a169944515241f7b57e3fb70b9bb92d

@maririos maririos removed the Central-EngSys This issue is owned by the Engineering System team. label Feb 14, 2023
@ruowan
Copy link
Member

ruowan commented Feb 15, 2023

This issue happened on this PR. Azure/azure-rest-api-specs#22316 @praveenkuttappan . I have already updated the swagger-api-parser version in spec PR pipeline. And the generated APIView artifact file is correct. But the APIView website doesn't pick up the latest APIView file.

@praveenkuttappan
Copy link
Member

I see the issue in APIView when a new revision is available. Swagger API review has collapsible section, and this is not correctly considered when calculating the diff. I will look into it to find a solution.
//fyi: @maririos @chidozieononiwu

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIView Central-EngSys This issue is owned by the Engineering System team.
Projects
Status: ✅ Done
Development

No branches or pull requests

4 participants