API endpoint groups

[andrewtavis]

Terms

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

Description

This issue follows the work done in #1077 and the corresponding PR in #1159. The goal is that we'll similarly achieve greater flexibility for groups via a transition to an APIView and Serializer, replacing the current ViewSet and ModelSerializer. In order to make the api implement that more flexible we want to move to a APIView and the serializers.Serialer instead of the ViewSet and ModelSerializer.

APIViews are not handling List and Detail Views, therefore we are going to split the views into:

class GroupListAPIView(APIView):
      pass
        
class GroupDetailAPIView(APIView):
      pass

Note that the work in #1159 can generally be copied for this issue with the work for organizations there being translated where needed for groups.

Contribution

Happy to support on this and potentially get to it myself. Can also review as needed if someone wants to open a PR! 😊

[andrewtavis]

CC @to-sta for the discussion here 👋

[IWang20]

Hi, can I be assigned to this issue?

[andrewtavis]

Thanks for your interest in working on this, @IWang20! Please let us know if you need any support :)

[IWang20]

I'm writing tests similar to #1159, and I'm only running the backend cause the entire project takes a while to start on my windows machine.
However, running only the backend using the instructions from CONTRIBUTING.md doesn't have the docker_backend container, which is needed to run the pytests.

Will I have to run the entire project just to run pytests?
Thanks

[to-sta]

I'm writing tests similar to #1159, and I'm only running the backend cause the entire project takes a while to start on my windows machine.
However, running only the backend using the instructions from CONTRIBUTING.md doesn't have the docker_backend container, which is needed to run the pytests.

Will I have to run the entire project just to run pytests?
Thanks

It is enough to run the backend container (it will automatically spin up the database container as well, because the backend depends on the db) and then you can run pytest within the container.

docker compose up backend --build

[IWang20]

Hi, running into an issue where calling
response = client.get("/v1/communities/groups/")
doesn't have count, pagination, and result keys, is this intended and/or important to deal with? Cause the tests in test_api.py from #1159 use these keys for testing.

Here's the test:

Output of print(response.data)

Shouldn't the response look something like this? (per swagger UI)

[to-sta]

@IWang20 Good catch. The GET method for this endpoint doesn't use pagination yet.

But similar to the organisation it should use pagination moving forward. Since this could become a long list of groups.

Feel free to change the tests as well as the view and serializer to accomplish this.