Mirrored_Repos/InvenTree
1
0
Fork 0
mirror of https://github.com/inventree/InvenTree synced 2024-08-30 18:33:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docstring to Company app

Browse Source
This commit is contained in:
Oliver Walters
2019-04-27 20:43:27 +10:00
parent d9169a0dd1
commit c3f0570926
4 changed files with 43 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
InvenTree/company/api.py
View File

@ -1,3 +1,7 @@
"""
Provides a JSON API for the Company app
"""
# -*- coding: utf-8 -*-
from __future__ import unicode_literals
@ -12,6 +16,13 @@ from .serializers import CompanySerializer
class CompanyList(generics.ListCreateAPIView):
""" API endpoint for accessing a list of Company objects
Provides two methods:
- GET: Return list of objects
- POST: Create a new Company object
"""
serializer_class = CompanySerializer
queryset = Company.objects.all()
@ -44,6 +55,7 @@ class CompanyList(generics.ListCreateAPIView):
class CompanyDetail(generics.RetrieveUpdateDestroyAPIView):
""" API endpoint for detail of a single Company object """
queryset = Company.objects.all()
serializer_class = CompanySerializer