Remove drf yasg #24

CharString · 2024-02-13T09:51:44Z

Passes test, but please try use it and add test cases where your project breaks.

Fixes #29

codecov-commenter · 2024-02-13T09:53:09Z

Codecov Report

Attention: Patch coverage is 65.82633% with 122 lines in your changes missing coverage. Please review.

Project coverage is 57.79%. Comparing base (9563533) to head (56c2190).
Report is 22 commits behind head on main.

Files with missing lines	Patch %	Lines
vng_api_common/permissions.py	23.65%	71 Missing ⚠️
vng_api_common/schema.py	73.07%	25 Missing and 10 partials ⚠️
vng_api_common/extensions/field_extensions.py	83.05%	8 Missing and 2 partials ⚠️
vng_api_common/extensions/serializer_extensions.py	87.87%	2 Missing and 2 partials ⚠️
vng_api_common/generators.py	75.00%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #24      +/-   ##
==========================================
+ Coverage   54.95%   57.79%   +2.83%     
==========================================
  Files          79       73       -6     
  Lines        3632     3239     -393     
  Branches      590      431     -159     
==========================================
- Hits         1996     1872     -124     
+ Misses       1533     1275     -258     
+ Partials      103       92      -11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

annashamray · 2024-02-13T11:49:51Z

Please don't merge this PR before I review it

annashamray

I think there are some drf-yasg leftovers:

all files in bin folder are using drf-yasg now. I think patch_content_types and use_external_components can be removed. So are the related management commands
All files in inspectors folder still have drf-yasg imports and code. This should be replaces with drf_spectacular extensions
drf-yasg and drf-spectacular have different generation for operation_ids, for the backward compatibility could you keep the same operation_ids as before?

vng_api_common/schema.py

testapp/schema.py

testapp/viewsets.py

vng_api_common/conf/api.py

vng_api_common/generators.py

annashamray · 2024-03-14T15:02:00Z

vng_api_common/generators.py

+
+    def create_view(self, callback, method, request=None):
+        if (
+            method != "HEAD"


What happens if method == HEAD ?

This question remains.

vng_api_common/notifications/api/views.py

vng_api_common/schema.py

Coperh

I think its fine ¯\_(ツ)_/¯

SonnyBA

Whenever Open-Zaak upgrades to this version, I think it can remove some code and reuse code that was added here.

I do think it would be nice to add back the tests for the etag header code and the custom content-type stuff.

.github/workflows/ci.yml

.github/workflows/code_quality.yml

bin/generate_schema

tests/test_cache_headers.py

vng_api_common/extensions/field_extensions.py

vng_api_common/oas.py

vng_api_common/permissions.py

SonnyBA · 2024-09-11T14:23:51Z

vng_api_common/schema.py

+AUDIT_TRAIL_ENABLED = apps.is_installed("vng_api_common.audittrails")
+
+
+def _view_supports_audittrail(view: viewsets.ViewSet) -> bool:


The comment in the permissions files applies here too I guess

This function is just moved from inspectors folder. I moved it to vng_api_common.audittrails.utils file
But I agree with you, we can reuse some schema customization from here in Open Zaak, I'll create an issue for it

setup.cfg

vng_api_common/conf/api.py

vng_api_common/extensions/field_extensions.py

vng_api_common/extensions/serializer_extensions.py

annashamray · 2024-09-11T14:35:22Z

vng_api_common/schema.py

+            ),
+        ]
+
+    def get_override_parameters(self):


This method is declared twice

vng_api_common/notifications/api/views.py

vng_api_common/permissions.py

tests/test_schema.py

vng_api_common/conf/api.py

vng_api_common/extensions/field_extensions.py

vng_api_common/extensions/serializer_extensions.py

annashamray · 2024-11-20T17:00:20Z

setup.cfg

 install_requires =
    django>=3.2.0
    django-filter>=2.0
    django-solo
    djangorestframework>=3.11.0
    djangorestframework_camel_case>=1.2.0
    django-rest-framework-condition
-    drf-yasg>=1.20.0
+    drf-extra-fields>=3.7.0


moved it to optional dependencies

annashamray · 2024-11-21T16:16:43Z

vng_api_common/generators.py

+
+    def create_view(self, callback, method, request=None):
+        if (
+            method != "HEAD"


annashamray · 2024-11-21T16:18:56Z

vng_api_common/generators.py

+            and hasattr(callback.cls, "_conditional_retrieves")
+            and "head" not in callback.actions
+        ):
+            # hack to get test_schema_root_tags pass when run in isolation
+            callback.actions["head"] = callback.cls._conditional_retrieves[0]


vng_api_common/notifications/api/views.py

tests/test_content_type_headers.py

annashamray · 2024-11-26T13:55:18Z

vng_api_common/schema.py

+            ),
+        ]
+
+    def get_override_parameters(self):


All changes are implemented

annashamray · 2024-12-10T09:26:24Z

@SonnyBA Could you please review it? I can't merge it because you request changes

CHANGELOG.rst

SonnyBA · 2024-12-10T11:57:37Z

vng_api_common/generators.py

-        if method == "HEAD":
-            return {}
-        return super().get_overrides(view, method)
+    # todo support registering and reusing Response components


Is this meant to be picked up by a separate ticket?

I've created an issue for it - #55

vng_api_common/schema.py

Co-authored-by: SonnyBA <[email protected]>

…app from testapp

…ded only for drf-spectaculer field extension

Co-authored-by: SonnyBA <[email protected]>

annashamray self-requested a review February 13, 2024 11:48

annashamray requested changes Mar 14, 2024

View reviewed changes

annashamray mentioned this pull request May 14, 2024

replace drf-yasg with drf-spectacular open-zaak/open-notificaties#145

Merged

bart-maykin force-pushed the drf-spectacular branch 16 times, most recently from 5626773 to 56c2190 Compare September 6, 2024 15:42

bart-maykin requested review from annashamray, SonnyBA and Coperh September 10, 2024 07:59

Coperh approved these changes Sep 11, 2024

View reviewed changes

SonnyBA requested changes Sep 11, 2024

View reviewed changes

annashamray previously requested changes Sep 11, 2024

View reviewed changes

annashamray force-pushed the drf-spectacular branch 2 times, most recently from c3bba7a to 59e682e Compare November 26, 2024 15:51

annashamray reviewed Nov 26, 2024

View reviewed changes

bart-maykin approved these changes Nov 29, 2024

View reviewed changes

annashamray mentioned this pull request Nov 29, 2024

Prepare bugfix release #51

Merged

annashamray force-pushed the drf-spectacular branch from 16a7d65 to 7cf4f30 Compare December 10, 2024 09:21

SonnyBA approved these changes Dec 10, 2024

View reviewed changes

CharString and others added 21 commits December 11, 2024 11:14

✅ Make tests pass without drf_yasg

2814ffd

🎨 added custom spectacular schema generation components

6275939

🔥 removed scripts from setup.cfg

cc91120

✨ added geospatial librabrary settings

59739b7

👷 installed gdal in ci test

dab2692

🚧 removing inspector files

09107fa

🔥 remove unneeded code

296a70a

Apply suggestions from code review

eed292c

Co-authored-by: SonnyBA <[email protected]>

👌 [#29] process Sonny's feedback

411d017

♻️ [#29] remove django apps from docs settings

d6a5975

♻️ [#29] move resources for notification webhook OAS into a separate …

acdadcc

…app from testapp

🚚 [#29] move drf-spectacular extensions into separate files

59be9e7

♻️ [#29] remove 'drf-extra-fields from required deps because it's nee…

edf519b

…ded only for drf-spectaculer field extension

⏪ [#29] revert permission classes changes as not relevant

bd9ee0d

⏪ [#29] restore filter backend

40f69b7

♻️ [#29] refactor OAS custom schema and generator

2ee8156

✅ [#29] update tests and testapp

35097be

💚 [#29] cleanup

ffc3276

💚 [#29] fix GH actions

4f508a0

💚 [#29] clean after rebase

b347b2a

Update vng_api_common/schema.py

9daa877

Co-authored-by: SonnyBA <[email protected]>

annashamray force-pushed the drf-spectacular branch from 3c3d9fd to 9daa877 Compare December 11, 2024 10:19

annashamray merged commit 684b6b9 into main Dec 11, 2024
6 checks passed

annashamray deleted the drf-spectacular branch December 11, 2024 10:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove drf yasg #24

Remove drf yasg #24

CharString commented Feb 13, 2024 •

edited by annashamray

Loading

codecov-commenter commented Feb 13, 2024 •

edited

Loading

annashamray commented Feb 13, 2024

annashamray left a comment

annashamray Mar 14, 2024

annashamray Sep 11, 2024

annashamray Nov 21, 2024

Coperh left a comment

SonnyBA left a comment

SonnyBA Sep 11, 2024

annashamray Nov 20, 2024 •

edited

Loading

annashamray Sep 11, 2024

annashamray Nov 26, 2024

annashamray Nov 20, 2024

annashamray Nov 21, 2024

annashamray Nov 21, 2024

annashamray Nov 26, 2024

annashamray commented Dec 10, 2024

SonnyBA Dec 10, 2024

annashamray Dec 11, 2024

		AUDIT_TRAIL_ENABLED = apps.is_installed("vng_api_common.audittrails")


		def _view_supports_audittrail(view: viewsets.ViewSet) -> bool:

Remove drf yasg #24

Remove drf yasg #24

Conversation

CharString commented Feb 13, 2024 • edited by annashamray Loading

codecov-commenter commented Feb 13, 2024 • edited Loading

Codecov Report

annashamray commented Feb 13, 2024

annashamray left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Coperh left a comment

Choose a reason for hiding this comment

SonnyBA left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

annashamray Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

annashamray commented Dec 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CharString commented Feb 13, 2024 •

edited by annashamray

Loading

codecov-commenter commented Feb 13, 2024 •

edited

Loading

annashamray Nov 20, 2024 •

edited

Loading