From 715da8fc64df4cc1fdd2727137949ae97b0c0633 Mon Sep 17 00:00:00 2001 From: Sam Date: Fri, 19 Jul 2019 12:02:49 +0200 Subject: [PATCH] update docs and api endpoints --- docs/_sources/api/auth.rst.txt | 2 + docs/_sources/api/records.rst.txt | 2 + docs/_sources/api/sports.rst.txt | 2 + docs/_sources/api/stats.rst.txt | 2 + docs/_sources/api/users.rst.txt | 2 + docs/api/auth.html | 43 +++++++++++++++ docs/api/records.html | 1 + docs/api/sports.html | 1 + docs/api/stats.html | 9 +++- docs/api/users.html | 13 +++++ docs/http-routingtable.html | 50 ++++++++++++++++++ docs/objects.inv | Bin 661 -> 774 bytes docs/searchindex.js | 2 +- docsrc/source/api/auth.rst | 2 + docsrc/source/api/records.rst | 2 + docsrc/source/api/sports.rst | 2 + docsrc/source/api/stats.rst | 2 + docsrc/source/api/users.rst | 2 + .../fittrackee_api/activities/stats.py | 3 +- fittrackee_api/fittrackee_api/users/auth.py | 7 +++ fittrackee_api/fittrackee_api/users/users.py | 2 + 21 files changed, 148 insertions(+), 3 deletions(-) diff --git a/docs/_sources/api/auth.rst.txt b/docs/_sources/api/auth.rst.txt index c5c7dc6e..265416ca 100644 --- a/docs/_sources/api/auth.rst.txt +++ b/docs/_sources/api/auth.rst.txt @@ -1,6 +1,8 @@ Authentication ############## +work in progress + .. autoflask:: fittrackee_api:create_app() :endpoints: auth.register_user, diff --git a/docs/_sources/api/records.rst.txt b/docs/_sources/api/records.rst.txt index c78be7c4..fe42bf73 100644 --- a/docs/_sources/api/records.rst.txt +++ b/docs/_sources/api/records.rst.txt @@ -1,6 +1,8 @@ Records ####### +work in progress + .. autoflask:: fittrackee_api:create_app() :endpoints: records.get_records diff --git a/docs/_sources/api/sports.rst.txt b/docs/_sources/api/sports.rst.txt index 84a0b86c..3147efa7 100644 --- a/docs/_sources/api/sports.rst.txt +++ b/docs/_sources/api/sports.rst.txt @@ -1,6 +1,8 @@ Sports ###### +work in progress + .. autoflask:: fittrackee_api:create_app() :endpoints: sports.get_sports, diff --git a/docs/_sources/api/stats.rst.txt b/docs/_sources/api/stats.rst.txt index 0621d298..d802fa3b 100644 --- a/docs/_sources/api/stats.rst.txt +++ b/docs/_sources/api/stats.rst.txt @@ -1,6 +1,8 @@ Statistics ########## +work in progress + .. autoflask:: fittrackee_api:create_app() :endpoints: stats.get_activities_by_sport, diff --git a/docs/_sources/api/users.rst.txt b/docs/_sources/api/users.rst.txt index 09785889..3fc1be80 100644 --- a/docs/_sources/api/users.rst.txt +++ b/docs/_sources/api/users.rst.txt @@ -1,6 +1,8 @@ Users ##### +work in progress + .. autoflask:: fittrackee_api:create_app() :endpoints: users.get_users, diff --git a/docs/api/auth.html b/docs/api/auth.html index cdbcf0ba..452f1e93 100644 --- a/docs/api/auth.html +++ b/docs/api/auth.html @@ -121,6 +121,49 @@

Authentication

+

work in progress

+
+
+POST /api/auth/register
+

register a user

+
+ +
+
+POST /api/auth/login
+

user login

+
+ +
+
+GET /api/auth/logout
+

user logout

+
+ +
+
+GET /api/auth/profile
+

get authenticated user info

+
+ +
+
+POST /api/auth/profile/edit
+

edit authenticated user

+
+ +
+
+POST /api/auth/picture
+

update authenticated user picture

+
+ +
+
+DELETE /api/auth/picture
+

delete authenticated user picture

+
+
diff --git a/docs/api/records.html b/docs/api/records.html index 0cbaf00b..a954dc90 100644 --- a/docs/api/records.html +++ b/docs/api/records.html @@ -121,6 +121,7 @@

Records

+

work in progress

GET /api/records
diff --git a/docs/api/sports.html b/docs/api/sports.html index d5f53b9d..15dbb551 100644 --- a/docs/api/sports.html +++ b/docs/api/sports.html @@ -121,6 +121,7 @@

Sports

+

work in progress

GET /api/sports
diff --git a/docs/api/stats.html b/docs/api/stats.html index 8cbe1bab..f2da2fb5 100644 --- a/docs/api/stats.html +++ b/docs/api/stats.html @@ -121,10 +121,17 @@

Statistics

+

work in progress

+
+
+GET /api/stats/(int: user_id)/by_sport
+

Get activities statistics for a user by sport

+
+
GET /api/stats/(int: user_id)/by_time
-

Get activities statistics for a user

+

Get activities statistics for a user by time

diff --git a/docs/api/users.html b/docs/api/users.html index 5c30926a..224d5aa4 100644 --- a/docs/api/users.html +++ b/docs/api/users.html @@ -121,6 +121,7 @@

Users

+

work in progress

GET /api/users
@@ -133,6 +134,18 @@

Get single user details

+
+
+GET /api/users/(user_id)/picture
+

get user picture

+
+ +
+
+GET /api/ping
+

health check endpoint

+
+
diff --git a/docs/http-routingtable.html b/docs/http-routingtable.html index 3114db7b..58e411a7 100644 --- a/docs/http-routingtable.html +++ b/docs/http-routingtable.html @@ -145,6 +145,21 @@ GET /api/activities/map/(map_id) + + + + GET /api/auth/logout + + + + + GET /api/auth/profile + + + + + GET /api/ping + @@ -160,6 +175,11 @@ GET /api/sports/(int:sport_id) + + + + GET /api/stats/(int:user_id)/by_sport + @@ -175,6 +195,11 @@ GET /api/users/(user_id) + + + + GET /api/users/(user_id)/picture + @@ -185,6 +210,26 @@ POST /api/activities/no_gpx + + + + POST /api/auth/login + + + + + POST /api/auth/picture + + + + + POST /api/auth/profile/edit + + + + + POST /api/auth/register + @@ -195,6 +240,11 @@ DELETE /api/activities/(int:activity_id) + + + + DELETE /api/auth/picture + diff --git a/docs/objects.inv b/docs/objects.inv index 406ab8ee47cf75c72ed303c48abd747574162da1..ab45d0656ba42d2dcccf7f0aba246f772bd11169 100644 GIT binary patch delta 665 zcmbQr+Qv4avVNLx{u~2=w)cOyy!Ynt>%A(?4_xYD8PYZD%brh%Sk^GPrLEZXf8Rfr zgGe*gPM^0BnyYoF(cp7>w%#9)HdM*FaaC)SZ^`>x(Fiw|iFn!2E|HSMR= z67j>PU4FGaC;9grUMwB&x93mRK~S& zP2aR<#mpnYCnwxp>LB%Dn@{}L_uprRH(%n6zV@8`>*xLY0g*4C_iCcI@SVsw`6s|BiK6_o$Hj&L- z6Cd@OZ`dlQAMf}ipytn7fYQNEv-ripGt)Az8$o;yU z3Q_%2^VdJToslwc&HXJqzn_~v`JyWK^;;Ept)^fu351pDlch4rwD)Fv= z9+mjw6u;cAoBrvituiYQzfoc<_x%!{df-z;SJQ>7)pKlo9-o>2^T?z3jGq?FTi_gL z@MMuO+r6nD9j5UG@E6lb8KtE)iXE-h0KIrm*^-hj}`s((?~|c^y$ud!|eNuEy#G zv&}aqre|!q;lB2Vr+wPVIQB00zV(wt>lvo_h~73y+dlo3<-3i=D%q|(H}(B8oa9a_i0N;|&rv z6mIe~7w5jW=X=@=M)5t4uN%v5oaFmnS8wI<@v0By?XWKyH|SZ&#Sz$oc48R-_0Af zlSEU`n#!@b*G*^MbmaZ4FQNbI=I^o|L42ladXZ2x7MXI_zNEMrpLYZ zHJ#$s{pM(8MQDOT_1g>Dy)&;Y)Lyzgk7M$u;8dMj?^kSAYtQdFaYehfm#@6I=U4yP z^;Y-aZhM&>En~lL%js(;nm=3AH_Ti2?PH0{U4k< zEf^fSk$YMA>&Phvn|{sb*ZAf%bxLkr*{|e#)(<;M)eL8-&lWAw@a_vLo$OG?bnki> z=a)&#-LsUEvr7U+=N<8yzEA$w?Oczdui;-(zI>^Snp~M8Sw2s>c3UgYGm*Y`Y8&bo z9S^%4zFXy)`_0e`E3{J2ElB=1XWNxGC*>blyh{De{OkmOox9eHBw^{gmSdBcU!CYL z^V}4t-oxIhKWlnDBhOixZJEpR^lu9CZxd8pD/by_time', methods=['GET']) @authenticate def get_activities_by_time(auth_user_id, user_id): - """Get activities statistics for a user""" + """Get activities statistics for a user by time""" return get_activities(user_id, 'by_time') @stats_blueprint.route('/stats//by_sport', methods=['GET']) @authenticate def get_activities_by_sport(auth_user_id, user_id): + """Get activities statistics for a user by sport""" return get_activities(user_id, 'by_sport') diff --git a/fittrackee_api/fittrackee_api/users/auth.py b/fittrackee_api/fittrackee_api/users/auth.py index 4618b757..92b5d1e4 100644 --- a/fittrackee_api/fittrackee_api/users/auth.py +++ b/fittrackee_api/fittrackee_api/users/auth.py @@ -15,6 +15,7 @@ auth_blueprint = Blueprint('auth', __name__) @auth_blueprint.route('/auth/register', methods=['POST']) def register_user(): + """ register a user """ # get post data post_data = request.get_json() if not post_data or post_data.get('username') is None \ @@ -91,6 +92,7 @@ def register_user(): @auth_blueprint.route('/auth/login', methods=['POST']) def login_user(): + """ user login """ # get post data post_data = request.get_json() if not post_data: @@ -133,6 +135,7 @@ def login_user(): @auth_blueprint.route('/auth/logout', methods=['GET']) @authenticate def logout_user(user_id): + """ user logout """ # get auth token auth_header = request.headers.get('Authorization') if auth_header: @@ -161,6 +164,7 @@ def logout_user(user_id): @auth_blueprint.route('/auth/profile', methods=['GET']) @authenticate def get_user_status(user_id): + """ get authenticated user info """ user = User.query.filter_by(id=user_id).first() response_object = { 'status': 'success', @@ -172,6 +176,7 @@ def get_user_status(user_id): @auth_blueprint.route('/auth/profile/edit', methods=['POST']) @authenticate def edit_user(user_id): + """ edit authenticated user """ # get post data post_data = request.get_json() if not post_data: @@ -237,6 +242,7 @@ def edit_user(user_id): @auth_blueprint.route('/auth/picture', methods=['POST']) @authenticate def edit_picture(user_id): + """ update authenticated user picture """ code = 400 response_object = verify_extension('picture', request) if response_object['status'] != 'success': @@ -287,6 +293,7 @@ def edit_picture(user_id): @auth_blueprint.route('/auth/picture', methods=['DELETE']) @authenticate def del_picture(user_id): + """ delete authenticated user picture """ try: user = User.query.filter_by(id=user_id).first() picture_path = get_absolute_file_path(user.picture) diff --git a/fittrackee_api/fittrackee_api/users/users.py b/fittrackee_api/fittrackee_api/users/users.py index 6d0a7f59..45b5365e 100644 --- a/fittrackee_api/fittrackee_api/users/users.py +++ b/fittrackee_api/fittrackee_api/users/users.py @@ -42,6 +42,7 @@ def get_single_user(user_id): @users_blueprint.route('/users//picture', methods=['GET']) def get_picture(user_id): + """ get user picture """ response_object = { 'status': 'fail', 'message': 'User does not exist' @@ -59,6 +60,7 @@ def get_picture(user_id): @users_blueprint.route('/ping', methods=['GET']) def ping_pong(): + """ health check endpoint """ return jsonify({ 'status': 'success', 'message': 'pong!'