search

Testaustime / testaustime-backend

https://api.testaustime.fi
MIT License
12 stars 11 forks source link

API Documentation #9

Closed Chicken closed 2 years ago

Chicken commented 2 years ago

Update the API documentation. If feeling extra fancy, create a new tool which auto generates the documentation from comments in the code and just write a doc comment above the endpoint in the code when implementing new features.

DrVilepis commented 2 years ago

This might take a while to fix, as we are looking into a better apidoc format such as openapi

Merkush1 commented 2 years ago

Hey guys, i saw that you have some endpoints not documented in https://github.com/Testaustime/testaustime-backend/blob/main/docs/APISPEC.md

So can i document for example some new endpoints like friends/remove, activity/delete and etc?

For the first step i can update endpoints for the first PR in your current page. For the second - add some Swagger (OpenAPI)

DrVilepis commented 2 years ago

Feel free, we aren't really interested in writing documentation right now so it would be great if you could document them.

The OpenAPI format would also be very nice, this would be greatly appreciated.

lajp commented 2 years ago

@Merkush1 also beware that some of the documentation in APISPEC.md might not match the functionality that the endpoints have now. So don't trust the existing apispec.

But yeah, proper, up-to-date docs would be cool :)

zahertalab commented 2 years ago

How to contribute?

lajp commented 2 years ago

Thank you for showing interest in this project. Our contribution guidelines can be found here

Our existing API-documentation recently written by Merkush1 can be found here.

Even tough there's always something that can be improved in documentation, I feel that with #40 merged we can happily close this issue. If @zahertalab or anyone else wants to improve upon the existing documentation or wants further clarification on how a specific endpoint functions, they can always open a new PR/issue.

zahertalab commented 2 years ago

Thank you for showing interest in this project. Our contribution guidelines can be found here

Our existing API-documentation recently written by Merkush1 can be found here.

Even tough there's always something that can be improved in documentation, I feel that with #40 merged we can happily close this issue. If @zahertalab or anyone else wants to improve upon the existing documentation or wants further clarification on how a specific endpoint functions, they can always open a new PR/issue.

I'd like to improve upon the existing documentation. But the links you have put are broken.

bluelhf commented 2 years ago

Thank you for showing interest in this project. Our contribution guidelines can be found here Our existing API-documentation recently written by Merkush1 can be found here. Even tough there's always something that can be improved in documentation, I feel that with #40 merged we can happily close this issue. If @zahertalab or anyone else wants to improve upon the existing documentation or wants further clarification on how a specific endpoint functions, they can always open a new PR/issue.

I'd like to improve upon the existing documentation. But the links you have put are broken.

Here are the correct links to the API specification and contribution guidelines :)