From 0ba0e368344ad5f34c95955ebb32411ff7586a44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Do=C4=9Fukan=20=C3=87a=C4=9Fatay?= Date: Sat, 15 Mar 2025 09:19:22 +0100 Subject: [PATCH] docs: add module docstring for endpoint init template This commit adds a docstring to the jinja template file to prevent it from being empty. --- .../golden-record/my_test_api_client/api/bodies/__init__.py | 1 + .../golden-record/my_test_api_client/api/config/__init__.py | 1 + .../golden-record/my_test_api_client/api/default/__init__.py | 1 + .../golden-record/my_test_api_client/api/defaults/__init__.py | 1 + .../golden-record/my_test_api_client/api/enums/__init__.py | 1 + .../golden-record/my_test_api_client/api/location/__init__.py | 1 + .../golden-record/my_test_api_client/api/naming/__init__.py | 1 + .../my_test_api_client/api/parameter_references/__init__.py | 1 + .../golden-record/my_test_api_client/api/parameters/__init__.py | 1 + .../golden-record/my_test_api_client/api/responses/__init__.py | 1 + .../golden-record/my_test_api_client/api/tag1/__init__.py | 1 + .../golden-record/my_test_api_client/api/tag2/__init__.py | 1 + .../golden-record/my_test_api_client/api/tests/__init__.py | 1 + .../golden-record/my_test_api_client/api/true_/__init__.py | 1 + .../my_enum_api_client/api/enums/__init__.py | 1 + .../my_enum_api_client/api/tests/__init__.py | 1 + .../test_3_1_features_client/api/const/__init__.py | 1 + .../test_3_1_features_client/api/prefix_items/__init__.py | 1 + integration-tests/integration_tests/api/body/__init__.py | 1 + integration-tests/integration_tests/api/parameters/__init__.py | 1 + openapi_python_client/templates/endpoint_init.py.jinja | 1 + 21 files changed, 21 insertions(+) diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/bodies/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/bodies/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/bodies/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/bodies/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/config/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/config/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/config/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/config/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/default/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/default/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/default/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/default/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/defaults/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/defaults/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/defaults/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/defaults/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/enums/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/enums/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/enums/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/enums/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/location/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/location/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/location/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/location/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/naming/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/naming/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/naming/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/naming/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/parameters/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/parameters/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/parameters/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/parameters/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/responses/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/responses/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/responses/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/responses/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tag1/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/tag1/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/tag1/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/tag1/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tag2/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/tag2/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/tag2/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/tag2/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/tests/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/tests/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/true_/__init__.py b/end_to_end_tests/golden-record/my_test_api_client/api/true_/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/golden-record/my_test_api_client/api/true_/__init__.py +++ b/end_to_end_tests/golden-record/my_test_api_client/api/true_/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/literal-enums-golden-record/my_enum_api_client/api/enums/__init__.py b/end_to_end_tests/literal-enums-golden-record/my_enum_api_client/api/enums/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/literal-enums-golden-record/my_enum_api_client/api/enums/__init__.py +++ b/end_to_end_tests/literal-enums-golden-record/my_enum_api_client/api/enums/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/literal-enums-golden-record/my_enum_api_client/api/tests/__init__.py b/end_to_end_tests/literal-enums-golden-record/my_enum_api_client/api/tests/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/literal-enums-golden-record/my_enum_api_client/api/tests/__init__.py +++ b/end_to_end_tests/literal-enums-golden-record/my_enum_api_client/api/tests/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/test-3-1-golden-record/test_3_1_features_client/api/const/__init__.py b/end_to_end_tests/test-3-1-golden-record/test_3_1_features_client/api/const/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/test-3-1-golden-record/test_3_1_features_client/api/const/__init__.py +++ b/end_to_end_tests/test-3-1-golden-record/test_3_1_features_client/api/const/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/end_to_end_tests/test-3-1-golden-record/test_3_1_features_client/api/prefix_items/__init__.py b/end_to_end_tests/test-3-1-golden-record/test_3_1_features_client/api/prefix_items/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/end_to_end_tests/test-3-1-golden-record/test_3_1_features_client/api/prefix_items/__init__.py +++ b/end_to_end_tests/test-3-1-golden-record/test_3_1_features_client/api/prefix_items/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/integration-tests/integration_tests/api/body/__init__.py b/integration-tests/integration_tests/api/body/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/integration-tests/integration_tests/api/body/__init__.py +++ b/integration-tests/integration_tests/api/body/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/integration-tests/integration_tests/api/parameters/__init__.py b/integration-tests/integration_tests/api/parameters/__init__.py index e69de29bb..2d7c0b23d 100644 --- a/integration-tests/integration_tests/api/parameters/__init__.py +++ b/integration-tests/integration_tests/api/parameters/__init__.py @@ -0,0 +1 @@ +"""Contains endpoint functions for accessing the API""" diff --git a/openapi_python_client/templates/endpoint_init.py.jinja b/openapi_python_client/templates/endpoint_init.py.jinja index e69de29bb..c9921b5fd 100644 --- a/openapi_python_client/templates/endpoint_init.py.jinja +++ b/openapi_python_client/templates/endpoint_init.py.jinja @@ -0,0 +1 @@ +""" Contains endpoint functions for accessing the API """