Add User Model APIs documentation to README

README.md

@@ -0,0 +1,297 @@
+## User APIs
+
+
+```
+Endpoint: /api/users/auth/login/ 
+
+Method: GET , POST 
+
+1) GET - 
+
+	Request Content Type : JSON 
+
+	Request Body:
+	{
+		username :<string> 
+	}
+
+	Response Body:None
+
+	Response Code Meanings:
+	200- ok (when the user is not logged in)
+	400- Bad Request (a user is already logged in)
+
+2) POST -
+
+	Request Content Type : JSON 
+
+	Request Body:
+	{
+		username:<string> 
+		password:<string> 
+	}
+
+	Response Body:None
+
+	Response Code Meanings:
+	200- ok (user successfully logged in)
+	400- Bad Request (user log in failed or already logged in)
+
+```
+
+
+```
+Endpoint: /api/users/auth/logout/ 
+
+Method: POST 
+
+	Request Content Type : None
+
+	Request Body:None
+
+	Response Body:None
+
+	Response Code Meanings:
+	200- ok (user successfully logged out)
+	401- Unauthorized (No user is logged in , so logout failed)
+
+```
+
+
+
+```
+Endpoint: /api/users/ 
+
+Method: PUT
+
+	Request Content Type : JSON 
+
+	Request Body:
+	{
+		fblink:<url>
+	}
+
+	Response Body:None
+
+	Response Code Meanings:
+	200- ok (fblink of user changed)
+	401- Unauthorized (No user is logged in , so fblink change failed)
+	204- No content(no fblink is given as parameter)
+	400- Bad Request (given flink is not a url)
+
+```
+
+```
+Endpoint: /api/users/acads/ 
+
+Method: GET , PUT 
+
+1) GET - 
+
+	Request Content Type : None
+
+	Request Body:None
+
+	Response Body:
+	{
+	    "roll": "190828",
+	    "acads": [
+	        {
+	            "course_id": 123,
+	            "name": "wer",
+	            "code": "ESC101B"
+	        },
+	        {
+	            "course_id": 1,
+	            "name": "wasdf",
+	            "code": "ESC101C"
+	        },
+	        {
+	            "course_id": 3,
+	            "name": "wedf",
+	            "code": "ESC101F"
+	        }
+	    ]
+	}
+
+	Response Code Meanings:
+	200- ok (all the acads/courses of the user)
+	204- No Content (user is not logged in )
+
+2) PUT -
+
+	Request Content Type : JSON 
+
+	Request Body:
+	{
+		code:<string> 
+	}
+
+	Response Body:
+	if success 
+	{
+		'Status':"ok"
+	}
+	else 
+	{
+		"Error":<Some message>
+	}
+
+	Response Code Meanings:
+	200- ok (course added in user)
+	400- Bad Request (no sch acad/course found)
+	401- Unauthorized (user is not logged in)
+
+```
+
+
+```
+Endpoint: /api/users/profile/
+
+Method: GET
+
+	Request Content Type :None
+
+	Request Body:None
+
+	Response Body:
+	{
+	    "roll": "190828",
+	    "username": "agshubh",
+	    "image": null,
+	    "name": "Shubh Agrawal",
+	    "program": "BTech",
+	    "dept": "CSE",
+	    "hall": "13",
+	    "room": "D305",
+	    "blood_group": "B+ve",
+	    "gender": "Male",
+	    "hometown": "Gurgaon",
+	    "fblink": "http://facebook.com/shubh",
+	    "por": {
+	        "1": "Pclub"
+	    },
+	    "earlier_login": false,
+	    "tags": [
+	        {
+	            "tag_id": 1,
+	            "name": "Shubh Agrawal",
+	            "description": "Desc1"
+	        }
+	    ],
+	    "acads": [
+	        {
+	            "course_id": 123,
+	            "name": "wer",
+	            "code": "ESC101B"
+	        },
+	        {
+	            "course_id": 1,
+	            "name": "wasdf",
+	            "code": "ESC101C"
+	        },
+	        {
+	            "course_id": 3,
+	            "name": "wedf",
+	            "code": "ESC101F"
+	        }
+	    ],
+	    "owned": []
+	}
+
+	Response Code Meanings:
+	200- ok (all the details of user are given)
+	400- Bad Request (No user is logged in)
+```
+
+```
+Endpoint: /api/users/tags/
+
+Method: PUT
+
+	Request Content Type :JSON
+
+	Request Body:
+	{
+		name:<charfield>
+	}
+
+	Response Body:
+	if success 
+	{
+		'Status':"ok"
+	}
+	else 
+	{
+		"Error":<Some message>
+	}
+
+
+	Response Code Meanings:
+	200- ok (tag added in user's tag list)
+	401- unauthorized(No user is logged in)
+	404- Not Found (No such tag is found )
+```
+
+```
+Endpoint: /api/users/course/delete/
+
+Method: DELETE
+
+	Request Content Type :JSON
+
+	Request Body:
+	{
+		code:<charfield>
+	}
+
+	Response Body:None
+
+	Response Code Meanings:
+	200- ok (course delelted from user course list)
+	401- unauthorized(No user is logged in)
+	404- Not Found (No such course is found in user's course list)
+```
+
+
+
+```
+Endpoint: /api/users/tags/delete/
+
+Method: DELETE
+
+	Request Content Type :JSON
+
+	Request Body:
+	{
+		name:<charfield>
+	}
+
+	Response Body:None
+
+	Response Code Meanings:
+	200- ok (tag delelted from user course list)
+	401- unauthorized(No user is logged in)
+	404- Not Found (No such tag is found in user's tag list)
+```
+
+
+```
+Endpoint: /api/users/owned/
+
+Method: GET
+
+	Request Content Type: None
+
+	Request Body:None
+
+	Response Body:
+	{
+	    "roll": "190828",
+	    "owned": []
+	}
+
+	Response Code Meanings:
+	200 - ok (owned tags are return)
+	204 - No Content(user id not loggged in)
+```

acads/admin.py

@@ -1,3 +1,5 @@
 from django.contrib import admin
 
 # Register your models here.
+from .models import AcadsModel
+admin.site.register(AcadsModel)

lifeiitkbackend/settings.py

@@ -108,10 +108,10 @@ def get_secret(setting, secrets=secrets):
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.postgresql_psycopg2",
-        "NAME": "postgres",
-        "USER": "postgres",
-        "PASSWORD": get_secret("DB_PASSWORD"),
-        'HOST': 'db',
+        "NAME": "postgres4",
+        "USER": "postgres4",
+        "PASSWORD": "shubh",
+        'HOST': 'localhost',
         'PORT': 5432,
     }
 }

tags/admin.py

@@ -1,3 +1,6 @@
 from django.contrib import admin
 
 # Register your models here.
+
+from .models import TagModel
+admin.site.register(TagModel)

tokens/admin.py

@@ -1,3 +1,5 @@
 from django.contrib import admin
 
 # Register your models here.
+from .models import Token
+admin.site.register(Token)

users/Serializer.py

@@ -45,3 +45,9 @@ class Meta:
             "roll",
             "acads"
         )
+
+
+class FbLinkSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = User 
+        fields =  ("fblink", "username")

users/admin.py

@@ -1 +1,4 @@
 from django.contrib import admin
+from users.models.users import User 
+
+admin.site.register(User)