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

Fix minor swagger inconsistencies #520

Merged
merged 4 commits into from
Nov 29, 2022
Merged

Fix minor swagger inconsistencies #520

merged 4 commits into from
Nov 29, 2022

Conversation

gmelodie
Copy link
Contributor

@gmelodie gmelodie commented Nov 11, 2022

I found a couple inconsistencies on our swagger annotations:

  • path variables not being required
  • multiple @Param bodys (which is not allowed)
  • an extra unused annotated variable
  • /admin/peering was a subgroup but we don't do that on other admin subgroups like /admin/cm
  • remove peering,peers tags from /admin/peering endpoints (cause them to show up duplicated on swagger)

@gmelodie gmelodie self-assigned this Nov 11, 2022
@gmelodie gmelodie added the Documentation Improvements or addition to documentation label Nov 11, 2022
@en0ma
Copy link
Contributor

en0ma commented Nov 18, 2022

@gmelodie any update on this?

Copy link
Contributor

@en0ma en0ma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@en0ma
Copy link
Contributor

en0ma commented Nov 27, 2022

@alvin-reyes @snissn @gmelodie let's get this in

@gmelodie gmelodie merged commit 4ef00f3 into dev Nov 29, 2022
@en0ma en0ma deleted the gabe/swagger-tidy branch December 1, 2022 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or addition to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants