Organization API

[to-sta]

Terms

• I have searched open and closed feature requests
• I agree to follow activist's Code of Conduct

Description

We are starting with creating the API's that will be used by the frontend in production soon 😃.

We are using django-rest-framework in the backend to create our API's. ViewSets in particular the ModelViewSet are used for creating the different HTTP methods. Another benefit of using the ModelViewSet is that we are getting some validation from the model itself and only need to extend that in the serializer if necessary.

Have look at the scheme and the models.py file.

Task is to implement all these methods for the OrganizationViewSet that represent the different HTTP methods:

def list(self, request):
    pass

def create(self, request):
    pass

def retrieve(self, request, pk=None):
    pass

def update(self, request, pk=None):
    pass

def partial_update(self, request, pk=None):
    pass

def destroy(self, request, pk=None):
    pass

The API generally is a combiniation of:

• views.py
• serializer.py
• models.py

Also feel free to suggest changes to the model, in case it is necessary for the logic. They are not set in stone 😃. In terms of testing, you can use Swagger UI for manuall testing (backend endpoint: /v1/schema/swagger-ui/).

Note

Please use an appropiate http status code for your responses.

Contribution

I am happy to help with this issue.

[andrewtavis]

I'll take this one, @to-sta 😊 We can also make ones for organizations and FAQs as well to round out the main things from the start, and then maybe events. As you see fit :) :)

[to-sta]

hmm I was thinking about starting with the main tables:

• resources
• organizations
• event
• topic
• task

What table/model represents the for example FAQ?

[bharath637462]

@to-sta can i create api for
resources
organizations
event
topic
task
below tables?

[Jackblanket847]

def list(self, request):
pass

def create(self, request):
pass

def retrieve(self, request, pk=None):
pass

def update(self, request, pk=None):
pass

def partial_update(self, request, pk=None):
pass

def destroy(self, request, pk=None):
pass

[josueemartinezz]

Hi @andrewtavis, I know you're currently assigned to this issue, but I still wanted to see how progress has been going and see if I could come up with a fix to the issue for my learning.

From my understanding, 4 of the 6 specified HTTP methods have already been completed in /activist/backend/entities/views.py, so would some tasks involve refactoring the Organization app into its own sub-folder as commented in #671? If refactoring is preferred, what would models would encompass models.py since most, if not all, would be passed into their respective API sub-folders like /entitites/organizations and /entities/groups. Thanks!

[andrewtavis]

Hey @josueemartinezz 👋 I think that @to-sta is mostly finalizing this at this point. We'll be doing a sync to finalize this this weekend, but there should be more backend issues after that! If you find another, please write in and we'll do our best to assign you :)

[josueemartinezz]

Hey @josueemartinezz 👋 I think that @to-sta is mostly finalizing this at this point. We'll be doing a sync to finalize this this weekend, but there should be more backend issues after that! If you find another, please write in and we'll do our best to assign you :)

Ah, I see, I'll keep an eye out for to-sta's pull request. Thanks for your response! Looking forward to contribute :)

[andrewtavis]

Looking forward to your contribution! :)

[andrewtavis]

Closed via #629. Thank you, @to-sta! 🙏🙏