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

Flattening of nested models is really confusing in APIView for Swaggers #5582

Closed
Tracked by #4864
heaths opened this issue Feb 28, 2023 · 5 comments
Closed
Tracked by #4864
Assignees
Labels
APIView Central-EngSys This issue is owned by the Engineering System team.

Comments

@heaths
Copy link
Member

heaths commented Feb 28, 2023

Based on the swagger, only a ResolvedConstentList is returned, but this "flattening" of models makes it seem like either could be returned:

image

See APIView for more examples.

I would just show the response model (if any) and make sure the properties are linked to the definitions.

@heaths heaths added the APIView label Feb 28, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in ApiView Feb 28, 2023
@mikekistler mikekistler moved this from 🆕 New to 📋 Backlog in ApiView Mar 6, 2023
@mikekistler
Copy link
Member

This will be a change in the parser. Should not be too hard but we need to investigate.

@heaths
Copy link
Member Author

heaths commented Mar 6, 2023

Given the request to link models anyway (from elsewhere - not just me), seems that part should come for "free". Just need to stop unrolling the nested models into this location such that, for example, only ResolvedConsentList is documented and its value field (rather, the Type/format column) links to ResolvedConsent.

@heaths
Copy link
Member Author

heaths commented Mar 6, 2023

In the interim, how hard would it be to link to the original swagger - whether in a PR or whatever the originating branch is from? Often times I feel confused by APIView (like this as a prime example) and need to double check with the swagger.

@maririos
Copy link
Member

maririos commented Mar 6, 2023

In the interim, how hard would it be to link to the original swagger - whether in a PR or whatever the originating branch is from? Often times I feel confused by APIView (like this as a prime example) and need to double check with the swagger.

You mean to correlate a specific teable/view with the respective line in Swagger?
or is the Associated Pull Request view enough
image

@heaths
Copy link
Member Author

heaths commented Mar 6, 2023

The PR is sufficient, since I can still view the individual swagger that way: either the diff, or click "View file" on the web to view the whole file. Thank you. I had not noticed that. I typically collapse options.

@praveenkuttappan praveenkuttappan added the Central-EngSys This issue is owned by the Engineering System team. label May 12, 2023
@chidozieononiwu chidozieononiwu moved this from 📋 Backlog to 🏗 In progress in ApiView Jun 13, 2023
@chidozieononiwu chidozieononiwu moved this from 🤔 Triage to 🔬 Dev in PR in Azure SDK EngSys 🚢🎉 Jun 13, 2023
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in ApiView Jun 27, 2023
@github-project-automation github-project-automation bot moved this from 🔬 Dev in PR to 🎊 Closed in Azure SDK EngSys 🚢🎉 Jun 27, 2023
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
Archived in project
Development

No branches or pull requests

5 participants