Merge pull request #146 from open-zaak/feature/pagination-for-zaken-c…

…omponent Feature/pagination for zaken component
open-zaak · Oct 29, 2019 · 94da067 · 94da067
2 parents e541a88 + 2367e68
commit 94da067
Show file tree

Hide file tree

Showing 9 changed files with 343 additions and 51 deletions.
diff --git a/src/openzaak/components/zaken/api/viewsets.py b/src/openzaak/components/zaken/api/viewsets.py
@@ -299,6 +299,8 @@ class StatusViewSet(
     serializer_class = StatusSerializer
     filterset_class = StatusFilter
     lookup_field = "uuid"
+    pagination_class = PageNumberPagination
+
     permission_classes = (ZaakAuthRequired,)
     permission_main_object = "zaak"
     required_scopes = {
@@ -382,6 +384,7 @@ class ZaakObjectViewSet(
     serializer_class = ZaakObjectSerializer
     filterset_class = ZaakObjectFilter
     lookup_field = "uuid"
+    pagination_class = PageNumberPagination
 
     permission_classes = (ZaakAuthRequired,)
     permission_main_object = "zaak"
@@ -561,6 +564,8 @@ class KlantContactViewSet(
     queryset = KlantContact.objects.all()
     serializer_class = KlantContactSerializer
     lookup_field = "uuid"
+    pagination_class = PageNumberPagination
+
     permission_classes = (ZaakAuthRequired,)
     permission_main_object = "zaak"
     required_scopes = {
@@ -610,6 +615,8 @@ class RolViewSet(
     serializer_class = RolSerializer
     filterset_class = RolFilter
     lookup_field = "uuid"
+    pagination_class = PageNumberPagination
+
     permission_classes = (ZaakAuthRequired,)
     permission_main_object = "zaak"
     required_scopes = {
@@ -674,6 +681,8 @@ class ResultaatViewSet(
     serializer_class = ResultaatSerializer
     filterset_class = ResultaatFilter
     lookup_field = "uuid"
+    pagination_class = PageNumberPagination
+
     permission_classes = (ZaakAuthRequired,)
     permission_main_object = "zaak"
     required_scopes = {

diff --git a/src/openzaak/components/zaken/openapi.yaml b/src/openzaak/components/zaken/openapi.yaml
@@ -67,6 +67,13 @@ paths:
       operationId: klantcontact_list
       summary: Alle KLANTCONTACTen opvragen.
       description: Alle KLANTCONTACTen opvragen.
+      parameters:
+      - name: page
+        in: query
+        description: Een pagina binnen de gepagineerde set resultaten.
+        required: false
+        schema:
+          type: integer
       responses:
         '200':
           description: OK
@@ -79,9 +86,25 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/KlantContact'
+                required:
+                - count
+                - results
+                type: object
+                properties:
+                  count:
+                    type: integer
+                  next:
+                    type: string
+                    format: uri
+                    nullable: true
+                  previous:
+                    type: string
+                    format: uri
+                    nullable: true
+                  results:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/KlantContact'
         '401':
           description: Unauthorized
           headers:
@@ -507,6 +530,12 @@ paths:
         schema:
           type: string
           format: uri
+      - name: page
+        in: query
+        description: Een pagina binnen de gepagineerde set resultaten.
+        required: false
+        schema:
+          type: integer
       responses:
         '200':
           description: OK
@@ -519,9 +548,25 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/Resultaat'
+                required:
+                - count
+                - results
+                type: object
+                properties:
+                  count:
+                    type: integer
+                  next:
+                    type: string
+                    format: uri
+                    nullable: true
+                  previous:
+                    type: string
+                    format: uri
+                    nullable: true
+                  results:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Resultaat'
         '400':
           description: Bad request
           headers:
@@ -1536,6 +1581,12 @@ paths:
           - klantcontacter
           - zaakcoordinator
           - mede_initiator
+      - name: page
+        in: query
+        description: Een pagina binnen de gepagineerde set resultaten.
+        required: false
+        schema:
+          type: integer
       responses:
         '200':
           description: OK
@@ -1548,9 +1599,25 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/Rol'
+                required:
+                - count
+                - results
+                type: object
+                properties:
+                  count:
+                    type: integer
+                  next:
+                    type: string
+                    format: uri
+                    nullable: true
+                  previous:
+                    type: string
+                    format: uri
+                    nullable: true
+                  results:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Rol'
         '400':
           description: Bad request
           headers:
@@ -2112,6 +2179,12 @@ paths:
         schema:
           type: string
           format: uri
+      - name: page
+        in: query
+        description: Een pagina binnen de gepagineerde set resultaten.
+        required: false
+        schema:
+          type: integer
       responses:
         '200':
           description: OK
@@ -2124,9 +2197,25 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/Status'
+                required:
+                - count
+                - results
+                type: object
+                properties:
+                  count:
+                    type: integer
+                  next:
+                    type: string
+                    format: uri
+                    nullable: true
+                  previous:
+                    type: string
+                    format: uri
+                    nullable: true
+                  results:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Status'
         '400':
           description: Bad request
           headers:
@@ -3554,6 +3643,12 @@ paths:
           - woz_waarde
           - zakelijk_recht
           - overige
+      - name: page
+        in: query
+        description: Een pagina binnen de gepagineerde set resultaten.
+        required: false
+        schema:
+          type: integer
       responses:
         '200':
           description: OK
@@ -3566,9 +3661,25 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/ZaakObject'
+                required:
+                - count
+                - results
+                type: object
+                properties:
+                  count:
+                    type: integer
+                  next:
+                    type: string
+                    format: uri
+                    nullable: true
+                  previous:
+                    type: string
+                    format: uri
+                    nullable: true
+                  results:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/ZaakObject'
         '400':
           description: Bad request
           headers:
@@ -6825,9 +6936,9 @@ components:
       required: true
   securitySchemes:
     JWT-Claims:
-      type: http
-      scheme: bearer
       bearerFormat: JWT
+      scheme: bearer
+      type: http
   schemas:
     KlantContact:
       required:
@@ -9332,7 +9443,7 @@ components:
           description: Which field to use when ordering the results.
           type: string
           minLength: 1
-    Wijzgingen:
+    Wijzigingen:
       title: Wijzigingen
       type: object
       properties:
@@ -9484,7 +9595,7 @@ components:
           format: date-time
           readOnly: true
         wijzigingen:
-          $ref: '#/components/schemas/Wijzgingen'
+          $ref: '#/components/schemas/Wijzigingen'
     ZaakBesluit:
       required:
       - besluit