docs: update documentation for custom back halves feature - Githubissues

DhananjayThomble / URL-Shortener-App

URL Shortener WebApp & Chrome-Extension using Javascript, Node.js, React, and MongoDB.

https://app.snapurl.in

MIT License

54 stars 54 forks source link

docs: update documentation for custom back halves feature #181

Closed SamirMishra27 closed 11 months ago

SamirMishra27 commented 11 months ago

Summary

This commit/PR will update the swagger documentation for the implemented feature of custom-back-halves in commit d2a5ee31

(Update /api/url route)

Add customBackHalf property in response object schema of /api/url (200)

(New /api/url/custom route)

Add documentation for the new route /api/url/custom which allows to create/edit custom back links.
Provide requeest body details & examples.
Provide response body details & examples.
Document responses for 200, 400, 401 & 500.

Upon successful merge, this Resolves and Completes #54 issue.

(This is a hacktoberfest submission 🎃)

Type of change

[x] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[x] This is a documentation update

How should this be tested?

Tests do not apply here.

Checklist

I have read the contributing guide
My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have checked if my PR needs changes to the documentation
My changes generate no new warnings

Video clip of documentation demo

https://github.com/DhananjayThomble/URL-Shortener-App/assets/68955143/57493066-9c52-495c-b906-8985ee9ca799

netlify[bot] commented 11 months ago

Deploy Preview for dturl canceled.

Name	Link
Latest commit	860eac0f0be767cdf33a2d56006fb0f96c51c5ba
Latest deploy log	https://app.netlify.com/sites/dturl/deploys/6540db0fb68ddd00082d8574