zubhub icon indicating copy to clipboard operation
zubhub copied to clipboard

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

Open yaya-mamoudou opened this issue 1 year ago • 5 comments

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 avatar Apr 13 '23 21:04 yaya-mamoudou

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

yaya-mamoudou avatar Apr 13 '23 21:04 yaya-mamoudou

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

godsakani avatar Sep 29 '23 08:09 godsakani

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

srish avatar Sep 29 '23 15:09 srish

@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

godsakani avatar Sep 29 '23 16:09 godsakani

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

hdtouch101 avatar Oct 04 '23 19:10 hdtouch101