Skip to content

⬆️ [maykinmedia/open-api-framework#197] upgrade commonground and use pagination #716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TimdeBeer1 merged 1 commit into from
Jan 16, 2026
+13 −15
Merged

⬆️ [maykinmedia/open-api-framework#197] upgrade commonground and use pagination #716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion requirements/base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ click-plugins==1.1.1
# via celery
click-repl==0.3.0
# via celery
commonground-api-common==2.10.5
commonground-api-common==2.10.7
# via
# -r requirements/base.in
# open-api-framework
Expand Down
2 changes: 1 addition & 1 deletion requirements/ci.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ click-repl==0.3.0
# celery
codecov==2.1.13
# via -r requirements/test-tools.in
commonground-api-common==2.10.5
commonground-api-common==2.10.7
# via
# -c requirements/base.txt
# -r requirements/base.txt
Expand Down
2 changes: 1 addition & 1 deletion requirements/dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ codecov==2.1.13
# via
# -c requirements/ci.txt
# -r requirements/ci.txt
commonground-api-common==2.10.5
commonground-api-common==2.10.7
# via
# -c requirements/ci.txt
# -r requirements/ci.txt
Expand Down
7 changes: 0 additions & 7 deletions src/objects/api/pagination.py
View file
Open in desktop

This file was deleted.

12 changes: 8 additions & 4 deletions src/objects/api/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,8 @@
- name: pageSize
required: false
in: query
description: Number of results to return per page.
description: 'Het aantal resultaten terug te geven per pagina. (default: 100,
maximum: 500).'
schema:
type: integer
- in: query
Expand Down Expand Up @@ -609,7 +610,8 @@
- name: pageSize
required: false
in: query
description: Number of results to return per page.
description: 'Het aantal resultaten terug te geven per pagina. (default: 100,
maximum: 500).'
schema:
type: integer
- in: path
Expand Down Expand Up @@ -685,7 +687,8 @@
- name: pageSize
required: false
in: query
description: Number of results to return per page.
description: 'Het aantal resultaten terug te geven per pagina. (default: 100,
maximum: 500).'
schema:
type: integer
tags:
Expand Down Expand Up @@ -830,7 +833,8 @@
- name: pageSize
required: false
in: query
description: Number of results to return per page.
description: 'Het aantal resultaten terug te geven per pagina. (default: 100,
maximum: 500).'
schema:
type: integer
tags:
Expand All @@ -853,7 +857,7 @@
description: OK
components:
schemas:
GeoJSONGeometry:

Check warning on line 860 in src/objects/api/v2/openapi.yaml

View workflow job for this annotation

GitHub Actions / Checks / Lint OAS 

schema-camel-case  Schema name should be CamelCase in #/components/schemas/GeoJSONGeometry
title: GeoJSONGeometry
type: object
oneOf:
Expand Down Expand Up @@ -1302,7 +1306,7 @@
name: Authorization
description: Token-based authentication with required prefix "Token"
servers:
- url: /api/v2

Check warning on line 1309 in src/objects/api/v2/openapi.yaml

View workflow job for this annotation

GitHub Actions / Checks / Lint OAS 

servers-use-https  Server URL /api/v2 "/api/v2" must match the pattern "^https://.*".
tags:
- name: objects
- name: permissions
Expand Down
2 changes: 1 addition & 1 deletion src/objects/api/v2/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
from rest_framework.generics import get_object_or_404
from rest_framework.response import Response
from vng_api_common.filters_backend import Backend as FilterBackend
from vng_api_common.pagination import DynamicPageSizePagination
from vng_api_common.search import SearchMixin

from objects.core.models import ObjectRecord
Expand All @@ -29,7 +30,6 @@
objects_update_counter,
)
from ..mixins import GeoMixin, ObjectNotificationMixin
from ..pagination import DynamicPageSizePagination
from ..serializers import (
HistoryRecordSerializer,
ObjectSearchSerializer,
Expand Down
1 change: 1 addition & 0 deletions src/objects/conf/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"objects.token.authentication.TokenAuthentication"
],
"DEFAULT_SCHEMA_CLASS": "objects.utils.autoschema.AutoSchema",
"PAGINATION_CLASS": "vng_api_common.pagination.DynamicPageSizePagination",
"DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.NamespaceVersioning",
"DEFAULT_VERSION": "v2", # NOT to be confused with API_VERSION - it's the major version part
"ALLOWED_VERSIONS": ("v2",),
Expand Down