update documentation

This commit is contained in:
Sam
2019-07-14 18:18:41 +02:00
parent 8b8d343864
commit 1a0955ff6a
11 changed files with 283 additions and 17 deletions

View File

@@ -1,6 +1,14 @@
FitTrackee API documentation
############################
Activities
##########
.. autoflask:: fittrackee_api:create_app()
:endpoints:
activities.get_activities
activities.get_activities,
activities.get_activity,
activities.post_activity,
activities.post_activity_no_gpx,
activities.update_activity,
activities.delete_activity,
activities.get_map,
activities.get_activity_gpx,
activities.get_activity_chart_data

12
docs/source/api/auth.rst Normal file
View File

@@ -0,0 +1,12 @@
Authentication
##############
.. autoflask:: fittrackee_api:create_app()
:endpoints:
auth.register_user,
auth.login_user,
auth.logout_user,
auth.get_user_status,
auth.edit_user,
auth.edit_picture,
auth.del_picture

13
docs/source/api/index.rst Normal file
View File

@@ -0,0 +1,13 @@
API documentation
#################
.. toctree::
:maxdepth: 2
:caption: Endpoints:
activities
auth
records
sports
stats
users

View File

@@ -0,0 +1,6 @@
Records
#######
.. autoflask:: fittrackee_api:create_app()
:endpoints:
records.get_records

View File

@@ -0,0 +1,10 @@
Sports
######
.. autoflask:: fittrackee_api:create_app()
:endpoints:
sports.get_sports,
sports.get_sport,
sports.post_sport,
sports.update_sport,
sports.delete_sport

View File

@@ -0,0 +1,7 @@
Statistics
##########
.. autoflask:: fittrackee_api:create_app()
:endpoints:
stats.get_activities_by_sport,
stats.get_activities_by_time

View File

@@ -0,0 +1,9 @@
Users
#####
.. autoflask:: fittrackee_api:create_app()
:endpoints:
users.get_users,
users.get_single_user,
users.get_picture,
users.ping_pong