drf-to-mkdoc 0.1.8__py3-none-any.whl → 0.1.9__py3-none-any.whl

drf_to_mkdoc/conf/defaults.py

@@ -5,6 +5,8 @@ DEFAULTS = {
     "MODEL_DOCS_FILE": "docs/model-docs.json",  # Path to model documentation JSON file
     "DOC_CONFIG_FILE": "docs/configs/doc_config.json",  # Path to documentation configuration file
     "CUSTOM_SCHEMA_FILE": "docs/configs/custom_schema.json",  # Path to custom schema file
+    "PATH_PARAM_SUBSTITUTE_FUNCTION": None,
+    "PATH_PARAM_SUBSTITUTE_MAPPING": {},
     # Django apps - required, no default
     "DJANGO_APPS": None,  # List of Django app names to process
 }

drf_to_mkdoc/utils/common.py

@@ -174,39 +174,44 @@ def get_custom_schema():
 def convert_to_django_path(path: str, parameters: list[dict[str, Any]]) -> str:
     """
     Convert a path with {param} to a Django-style path with <type:param>.
-    If PATH_PARAM_SUBSTITUTOR is set, use that function instead.
+    If PATH_PARAM_SUBSTITUTE_FUNCTION is set, use that function instead.
     """
     function = None
-    func_path = getattr(drf_to_mkdoc_settings, "PATH_PARAM_SUBSTITUTOR", None)
+    func_path = drf_to_mkdoc_settings.PATH_PARAM_SUBSTITUTE_FUNCTION
 
     if func_path:
         try:
             function = import_string(func_path)
         except ImportError:
-            logger.warning("PATH_PARAM_SUBSTITUTOR is not a valid import path")
+            logger.warning("PATH_PARAM_SUBSTITUTE_FUNCTION is not a valid import path")
 
     # If custom function exists and returns a valid value, use it
+    PATH_PARAM_SUBSTITUTE_MAPPING = drf_to_mkdoc_settings.PATH_PARAM_SUBSTITUTE_MAPPING
     if callable(function):
         try:
-            value = function(path, parameters)
-            if isinstance(value, str) and value.strip():
-                return value
+            result = function(path, parameters)
+            if result and isinstance(result, dict):
+                PATH_PARAM_SUBSTITUTE_MAPPING.update(result)
         except Exception as e:
             logger.exception("Error in custom path substitutor: %s", e)
 
     # Default Django path conversion
     def replacement(match):
         param_name = match.group(1)
-        param_info = next((p for p in parameters if p.get("name") == param_name), {})
-        param_type = param_info.get("schema", {}).get("type")
-        param_format = param_info.get("schema", {}).get("format")
-
-        if param_type == "integer":
-            converter = "int"
-        elif param_type == "string" and param_format == "uuid":
-            converter = "uuid"
+        custom_param_type = PATH_PARAM_SUBSTITUTE_MAPPING.get(param_name)
+        if custom_param_type and custom_param_type in ("int", "uuid", "str"):
+            converter = custom_param_type
         else:
-            converter = "str"
+            param_info = next((p for p in parameters if p.get("name") == param_name), {})
+            param_type = param_info.get("schema", {}).get("type")
+            param_format = param_info.get("schema", {}).get("format")
+
+            if param_type == "integer":
+                converter = "int"
+            elif param_type == "string" and param_format == "uuid":
+                converter = "uuid"
+            else:
+                converter = "str"
 
         return f"<{converter}:{param_name}>"
 

{drf_to_mkdoc-0.1.8.dist-info → drf_to_mkdoc-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drf-to-mkdoc
-Version: 0.1.8
+Version: 0.1.9
 Summary: Generate Markdown API docs from Django/DRF OpenAPI schema for MkDocs
 Author-email: Hossein Shayesteh <shayestehhs1@gmail.com>
 Maintainer-email: Hossein Shayesteh <shayestehhs1@gmail.com>

{drf_to_mkdoc-0.1.8.dist-info → drf_to_mkdoc-0.1.9.dist-info}/RECORD

@@ -1,7 +1,7 @@
 drf_to_mkdoc/__init__.py,sha256=IbTW5uKQvJRG9ncHRuk_AGKHPn4ruxs5LqDpUFgUhws,180
 drf_to_mkdoc/apps.py,sha256=-NrC_dRr6GmLmNQhkNh819B7V1SS4DYDv5JOR0TtuJM,560
 drf_to_mkdoc/conf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-drf_to_mkdoc/conf/defaults.py,sha256=hEjQdN3WsT539UWhFkylI60piykV_7BDudLPNd_E8PE,575
+drf_to_mkdoc/conf/defaults.py,sha256=DZiATgfjkyU_J1RgR_zAzPdOVp-F2o3LVwjb3hP6j0U,660
 drf_to_mkdoc/conf/settings.py,sha256=OOna4jWNTEfROBprpKnEHVl5RcAYExmOf0gBMA0E_FY,1664
 drf_to_mkdoc/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -34,7 +34,7 @@ drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/models/model-tables.css,sha256=8CSy
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/models/responsive.css,sha256=ygqyUtpiWchTBBIQil1C6mN0AC5xinLoP7whSKfBmwg,944
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/models/variables.css,sha256=2HvyjnJrygSzdzpE-FYpo6FGhrYhmZ7NwDFAkADXQNg,1094
 drf_to_mkdoc/utils/__init__.py,sha256=6dFTb07S6yIf-INMy0Mlgf5purNir687ZU9WZtITh4k,68
-drf_to_mkdoc/utils/common.py,sha256=qPF7tfnEsRbf57JJwDCqMtjMFmxmpWguXPQabHkag70,11711
+drf_to_mkdoc/utils/common.py,sha256=SxjGe9MtyxTyroXP7QdUiW9QqZ1N7xPjHHaAI-hqYxc,12077
 drf_to_mkdoc/utils/endpoint_detail_generator.py,sha256=mX3sklhWsd-FmOV-ePrhLpg5l8-Eu7V7qb5EL4Tq0FI,27650
 drf_to_mkdoc/utils/endpoint_list_generator.py,sha256=P7pEHscHNHpjDuTXmAUPYV3_t8uGSdaYOgiDGGoCwYc,9705
 drf_to_mkdoc/utils/model_detail_generator.py,sha256=P5kWO-5aWgvyPgzq1qXnt1380ExnrzlOw18zI57P9u0,8063
@@ -43,8 +43,8 @@ drf_to_mkdoc/utils/extractors/__init__.py,sha256=BvC8gKOPVI9gU1Piw0jRhKQ2ER5s1mo
 drf_to_mkdoc/utils/extractors/query_parameter_extractors.py,sha256=gnDlvF-bxkTp2NcEQf0EZZAfmdQzUpedhZ7N1LAYQzU,8432
 drf_to_mkdoc/utils/md_generators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/utils/md_generators/query_parameters_generators.py,sha256=N-XqZ_FUODSR5V4xM9oEA3aaIiNGNmNwpvrWbQTx6RI,2566
-drf_to_mkdoc-0.1.8.dist-info/licenses/LICENSE,sha256=3n9_ckIREsH8ogCxWW6dFsw_WfGcluG2mHcgl9i_UU0,1068
-drf_to_mkdoc-0.1.8.dist-info/METADATA,sha256=A_y3wLQBP6TCyeuv40sF-iqeD-UEYLzXQwUTdeem1dI,7037
-drf_to_mkdoc-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-drf_to_mkdoc-0.1.8.dist-info/top_level.txt,sha256=ZzJecR6j_tvLZiubUBEgawHflozC4DQy9ooNf1yDJ3Q,13
-drf_to_mkdoc-0.1.8.dist-info/RECORD,,
+drf_to_mkdoc-0.1.9.dist-info/licenses/LICENSE,sha256=3n9_ckIREsH8ogCxWW6dFsw_WfGcluG2mHcgl9i_UU0,1068
+drf_to_mkdoc-0.1.9.dist-info/METADATA,sha256=FgkNktIYpIuto47SGr2cvo_DdxMs15HGG6d8uaZAc7w,7037
+drf_to_mkdoc-0.1.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+drf_to_mkdoc-0.1.9.dist-info/top_level.txt,sha256=ZzJecR6j_tvLZiubUBEgawHflozC4DQy9ooNf1yDJ3Q,13
+drf_to_mkdoc-0.1.9.dist-info/RECORD,,