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

Group related endpoints in Swagger documentation to increase the experience of the developer #710

Open
yaya-mamoudou opened this issue Apr 13, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request medium priority ux

Comments

@yaya-mamoudou
Copy link
Contributor

yaya-mamoudou commented Apr 13, 2023

Description

Currently, our API documentation using Swagger is not very developer friendly, especially when looking for an endpoint. Endpoints that pertain to a particular entity should be grouped together so that if a developer wants to use endpoints that have to do with projects, they could refer to the Project section on the API documentation and find all the endpoints that have something to do with projects. Same thing for Authentication and the rest.

Currently we have

image

We could change to

image

image

@yaya-mamoudou
Copy link
Contributor Author

Hi @tuxology if possible I'll like to work on this issue

@srish srish added documentation Improvements or additions to documentation enhancement New feature or request ux medium priority labels Sep 7, 2023
@godsakani
Copy link
Contributor

Hello @srish , @tuxology , @yaya-mamoudou i will love to work on this issue

@srish
Copy link
Member

srish commented Sep 29, 2023

@godsakani I'd encourage you to start with good-first-task. This task is complex :)

@godsakani
Copy link
Contributor

godsakani commented Sep 29, 2023

@godsakani I'd encourage you to start with good-first-task. This task is complex :)

Thank you @srish . I notice all the good first issues have already being assigned i was left we no choice to work on this one. From the task description i dont think is complex again and also with additional guidance i will be able to work on it. please

@hdtouch101
Copy link

Hi, it seems this issue is for developers alone. kindly tag me in any issues concerning UI/UX

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request medium priority ux
Projects
None yet
Development

No branches or pull requests

4 participants