Documentation

[lostsidewalk]

Create API documentation that provides details about the available endpoints, query parameters, and response formats.

[jl3252]

Hi, I'd like to work on this if possible. It looks like only the get method exists right now? With no parameters? Is that correct?

[lostsidewalk]

@jl3252 Hi, thanks for taking an interest in this project; yes, you are correct. Take note that this API will grow, however, so I'd like to establish best practices early on. Ultimately, I'd like a way of generating an OpenAPIv3 spec from JSDoc comments added inline to the controller methods (i.e., /peap), using something like swagger-jsdoc. For now, just getting some momentum behind documenting the controller methods would be an excellent start. Please let me know if you have any questions!

[Believet2]

Hello i will like to contribute to this, thou this my first time contributing to an open source.