4IRL / urls4irl

Sharing URL's with friends.
3 stars 0 forks source link

API Documentation and Revision of Endpoint Naming #178

Closed GPropersi closed 3 months ago

GPropersi commented 3 months ago

Mainly contains API documentation detailing the request and response data needed from all currently-generated API endpoints.

Camel case is assumed when dealing with JavaScript, while snake case is used while dealing with Python.

Exception includes the csrf_token, which must be labeled as such due to WTForms library. In general, this field is not included since most requests are completed via AJAX, which requires the X-CSRFToken HTTP header instead of the csrf_token field.

Other fixes include:

Closes #173