moonlitgrace / mangareader-api

A Python based web scraping api built with fastapi that provides easy access to manga contents

https://mangareader-api.vercel.app

docs: add description to endpoints

moonlitgrace opened this issue 6 months ago · comments

Moonlit Grace commented 6 months ago

Helpful links:

https://fastapi.tiangolo.com/tutorial/metadata/#create-metadata-for-tags
https://fastapi.tiangolo.com/tutorial/metadata/#use-your-tags
https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#description-from-docstring
https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#summary-and-description

Mariyam Siddiqui commented 3 months ago

Is there an existing documentation to add the changes? the links in the readme are not responsive.

Moonlit Grace commented 3 months ago

hi @mariyam-siddiqui, appreciate your interest in this project.
There are some essential patches left for endpoint routing.

the links in the readme are not responsive.

Api versioning needs a little bit of work

I will update you after fixing these things ( will try to fix it today ).

Moonlit Grace commented 2 months ago

@mariyam-siddiqui
Sorry I fixed this myself since I didnt get any response from you.
related PR: #297

Closing this...