search

anitab-org / mentorship-backend

Mentorship System is an application that matches women in tech to mentor each other, on career development, through 1:1 relations during a certain period of time. This is the backend of this system.
https://mentorship-backend-temp.herokuapp.com/
GNU General Public License v3.0
195 stars 448 forks source link

fix: Swagger documentation HTTP code display #1128

Closed RiddhiAthreya closed 3 years ago

RiddhiAthreya commented 3 years ago

Describe the bug

In some places in the swagger documentation, the HTTP error codes values aren't being displayed and instead the variables are being displayed.

To Reproduce

Steps to reproduce the behavior:

  1. Go to https://mentorship-backend-temp.herokuapp.com/ and check under Mentorship Relation. This is just an example. There are many such instances across the project.

Expected behavior

The error codes need to be displayed. Ex : 400 , 403 etc instead of HTTPStatus.NOT_FOUND

Screenshots

Screenshot (174)

Desktop:

welcome[bot] commented 3 years ago

Hello there!👋 Welcome to the project!💖

Thank you and congrats 🎉 for opening your very first issue in this project. AnitaB.org Open Source is an inclusive community, committed to creating a safe and positive environment 🌸 Please follow our Code Of Conduct 🙌 You can learn more about the community on our website and documentation repository.

You may submit a PR on the same if you like! Please follow our Commit Message Style Guide and Coding Standards while sending PRs. If you want to report a bug 🐞, please follow our bug_report.md template. Please make sure you include steps to reproduce it and be patient we will get back to you as soon as we can 👀

Also, feel free to join us on AnitaB.org Open Source Zulip Community 🤝 We have different streams for each active repository for discussions.👩🏻‍💻🧑🏻‍💻 For mentorship-backend, join #mentorship-system stream! Hope you have a great time here :)

RiddhiAthreya commented 3 years ago

@isabelcosta Can I work on this?

epicadk commented 3 years ago

Yeah for some reason I think that's by design. Also maybe we could display the status code along with the status.

For example

418 I'm a Teapot

cc @isabelcosta @anitab-org/mentorship-maintainers

vj-codes commented 3 years ago

Duplicate of #939 but as it still exists you can work on this @RiddhiAthreya and thank you for reporting it :)