drf-to-mkdoc 0.1.8__tar.gz → 0.2.0__tar.gz

{drf_to_mkdoc-0.1.8 → drf_to_mkdoc-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drf-to-mkdoc
-Version: 0.1.8
+Version: 0.2.0
 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.2.0/docs/customizing_endpoints.md

@@ -0,0 +1,173 @@
+
+# Customizing API Endpoint Documentation
+
+`drf-to-mkdoc` automatically generates API documentation from your Django REST Framework (DRF) project using the OpenAPI schema from **DRF Spectacular**. You can refine and extend that documentation using a **custom JSON file**.
+
+---
+
+## 1. Where to put your custom schema
+
+By default, the generator looks for:
+docs/configs/custom\_schema.json
+
+
+
+
+You can change this path by setting `CUSTOM_SCHEMA_FILE` in your `DRF_TO_MKDOC` settings.
+
+---
+
+## 2. JSON File Format
+
+The file should be a JSON object where **keys are `operationId`s** from your OpenAPI schema. Each key can override or extend the operation’s documentation.
+
+Supported fields for each operation:
+
+- `description` → Text description of the endpoint  
+- `parameters` → Array of OpenAPI parameter objects  
+- `requestBody` → OpenAPI RequestBody object  
+- `responses` → OpenAPI Responses object  
+- `append_fields` → A list of keys that should **append to existing lists instead of replacing them**.  
+   - Currently, this is only useful for fields that are arrays in the schema (e.g., `parameters`).  
+   - If the target field is not a list (like `description`, `responses`, or `requestBody`), `append_fields` is ignored and the value is replaced as usual.  
+   - Example: If you want to **keep auto-generated query parameters** and add your own, include `"parameters"` in `append_fields`.  
+
+---
+
+### Example `custom_schema.json` using all supported keys
+
+```json
+{
+  "clinic_panel_appointments_available_appointment_times_list": {
+    "description": "Shows all available appointment times for a clinic.",
+    "parameters": [
+      {
+        "name": "date",
+        "in": "query",
+        "description": "Filter appointments by date",
+        "required": false,
+        "schema": { "type": "string", "format": "date" },
+        "queryparam_type": "filter_fields"
+      },
+      {
+        "name": "search",
+        "in": "query",
+        "description": "Search appointments by doctor or patient name",
+        "required": false,
+        "schema": { "type": "string" },
+        "queryparam_type": "search_fields"
+      }
+    ],
+    "requestBody": {
+      "description": "Request body for creating an appointment",
+      "required": true,
+      "content": {
+        "application/json": {
+          "schema": {
+            "type": "object",
+            "properties": {
+              "doctor_id": { "type": "integer" },
+              "patient_id": { "type": "integer" },
+              "date": { "type": "string", "format": "date" },
+              "time_slot": { "type": "string" }
+            },
+            "required": ["doctor_id", "patient_id", "date", "time_slot"]
+          }
+        }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "List of available time slots",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "date": { "type": "string", "description": "Date in DATE_FORMAT" },
+                  "time_slots": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "start_datetime": { "type": "string", "description": "Start datetime" },
+                        "end_datetime": { "type": "string", "description": "End datetime" }
+                      },
+                      "required": ["start_datetime", "end_datetime"]
+                    },
+                    "description": "Available time slots for the date"
+                  }
+                },
+                "required": ["date", "time_slots"]
+              }
+            }
+          }
+        }
+      },
+      "404": {
+        "description": "No appointments found for the given filters",
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "object",
+              "properties": {
+                "detail": { "type": "string", "example": "Appointments not found" }
+              },
+              "required": ["detail"]
+            }
+          }
+        }
+      }
+    },
+    "append_fields": ["parameters"]
+  }
+}
+````
+
+---
+
+## 3. Adding Query Parameters
+
+If you add a **query parameter** (`"in": "query"`), include a `queryparam_type` so it’s categorized properly in the generated docs.
+
+Supported `queryparam_type` values:
+
+* `search_fields` → Used for search filters
+* `filter_fields` → Standard filters
+* `ordering_fields` → Sort fields
+* `filter_backends` → Backend-specific filters
+* `pagination_fields` → Pagination-related fields
+
+> ⚠️ If `queryparam_type` is missing or invalid, the generator will raise an error.
+
+---
+
+## 4. How the custom schema is applied
+
+1. `drf-to-mkdoc` loads your OpenAPI schema.
+2. It reads your `custom_schema.json`.
+3. For each `operationId` in your JSON:
+
+   * Finds the corresponding endpoint in the schema
+   * Replaces fields like `description`, `responses`, `parameters`, etc.
+   * Appends items for fields listed in `append_fields` instead of replacing
+4. Generates your markdown documentation using the merged schema
+
+---
+
+## 5. Finding `operationId`s
+
+`operationId`s are generated by DRF Spectacular. You can find them by:
+
+* Checking your API endpoint pages in the browser (each includes the `operationId`)
+* Inspecting the OpenAPI JSON/YAML schema (via `/schema/` endpoint or export)
+
+---
+
+## 6. Tips for smooth usage
+
+* Keep `custom_schema.json` in version control so your team benefits.
+* Start small: add descriptions first, then parameters, then responses.
+* Use `append_fields` if you want to **add extra info** without overwriting auto-generated items.

{drf_to_mkdoc-0.1.8 → drf_to_mkdoc-0.2.0}/docs/serving_mkdocs_with_django.md

@@ -65,30 +65,45 @@ class DocumentationView(View):
             raise Http404("Invalid path")
 
         file_path = (site_dir / path).resolve()
-        site_root = site_dir.resolve()
 
-        # Ensure file is inside site dir and exists
-        if not str(file_path).startswith(str(site_root)):
-            raise Http404("Access denied")
-        if not file_path.exists() or not file_path.is_file():
-            raise Http404("Documentation file not found")
+        # Ensure the file exists and is within the site directory
+        try:
+            file_path = file_path.resolve()
+            site_dir = site_dir.resolve()
 
+            # Security check: ensure file is within site directory
+            if not str(file_path).startswith(str(site_dir)):
+                return HttpResponseRedirect("/docs/404/index.html?error=access_denied")
+
+            if not file_path.exists() or not file_path.is_file():
+                return HttpResponseRedirect("/docs/404/index.html")
+
+        except (OSError, ValueError) as e:
+                return HttpResponseRedirect("/docs/404/index.html?error=invalid_file_path")
+
+        # Determine content type
         content_type, _ = mimetypes.guess_type(str(file_path))
         if content_type is None:
             content_type = "application/octet-stream"
 
-        with file_path.open("rb") as f:
-            response = HttpResponse(f.read(), content_type=content_type)
-
-        # Cache headers (tweak as needed)
-        if content_type.startswith("text/html"):
-            response["Cache-Control"] = "no-cache, no-store, must-revalidate"
-            response["Pragma"] = "no-cache"
-            response["Expires"] = "0"
+        # Read and serve the file
+        try:
+            with Path(file_path).open("rb") as f:
+                response = HttpResponse(f.read(), content_type=content_type)
+
+            # Set appropriate headers
+            if content_type.startswith("text/html"):
+                response["Cache-Control"] = "no-cache, no-store, must-revalidate"
+                response["Pragma"] = "no-cache"
+                response["Expires"] = "0"
+            else:
+                response["Cache-Control"] = "public, max-age=3600"
+
+        except OSError as e:
+            return HttpResponseRedirect("/docs/404/index.html?error=could_not_read_file")
         else:
-            response["Cache-Control"] = "public, max-age=3600"
+            return response
 
-        return response
 ```
 
 ## Permission options

{drf_to_mkdoc-0.1.8 → drf_to_mkdoc-0.2.0}/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-0.1.8 → drf_to_mkdoc-0.2.0}/drf_to_mkdoc/management/commands/generate_docs.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 from pathlib import Path
 
 from django.core.management.base import BaseCommand
@@ -33,100 +31,77 @@ class Command(BaseCommand):
     def handle(self, *args, **options):
         self.stdout.write(self.style.SUCCESS("🚀 Starting documentation generation..."))
 
-        docs_dir = Path(drf_to_mkdoc_settings.DOCS_DIR)
-        docs_dir.mkdir(parents=True, exist_ok=True)
+        generate_models = not options["endpoints_only"]
+        generate_endpoints = not options["models_only"]
+        if not generate_models and not generate_endpoints:
+            self.stdout.write(
+                self.style.ERROR(
+                    "❌ No outputs selected: --models-only and --endpoints-only cannot be used together"
+                )
+            )
+            return
+        docs_dir = self._setup_docs_directory()
+        models_data = self._load_models_data() if generate_models else {}
+        schema_data = self._load_schema_data() if generate_endpoints else {}
+
+        if generate_models and models_data:
+            self._generate_models_documentation(models_data, docs_dir)
 
-        if options["models_only"]:
-            self._generate_models_only()
-        elif options["endpoints_only"]:
-            self._generate_endpoints_only()
-        else:
-            self._generate_all()
+        if generate_endpoints and schema_data:
+            self._generate_endpoints_documentation(schema_data, docs_dir)
 
         self.stdout.write(self.style.SUCCESS("✅ Documentation generation complete!"))
 
-    def _generate_models_only(self):
-        """Generate only model documentation"""
-        self.stdout.write("📋 Generating model documentation...")
+    def _setup_docs_directory(self):
+        docs_dir = Path(drf_to_mkdoc_settings.DOCS_DIR)
+        docs_dir.mkdir(parents=True, exist_ok=True)
+        return docs_dir
 
-        # Load model data
+    def _load_models_data(self):
         json_data = load_model_json_data()
         models_data = json_data.get("models", {}) if json_data else {}
 
         if not models_data:
             self.stdout.write(self.style.WARNING("⚠️  No model data found"))
-            return
-
-        docs_dir = Path(drf_to_mkdoc_settings.DOCS_DIR)
 
-        # Generate model documentation
-        generate_model_docs(models_data, docs_dir)
-        create_models_index(models_data, docs_dir)
+        return models_data
 
-        self.stdout.write(self.style.SUCCESS("✅ Model documentation generated"))
-
-    def _generate_endpoints_only(self):
-        """Generate only endpoint documentation"""
-        self.stdout.write("🔗 Generating endpoint documentation...")
-
-        # Load schema
-        schema = get_schema()
+    def _load_schema_data(self):
+        try:
+            schema = get_schema()
+        except Exception as e:
+            self.stdout.write(self.style.ERROR(f"❌ Failed to load OpenAPI schema: {e}"))
+            return {}
         if not schema:
             self.stdout.write(self.style.ERROR("❌ Failed to load OpenAPI schema"))
-            return
+            return {}
 
         paths = schema.get("paths", {})
         components = schema.get("components", {})
 
         self.stdout.write(f"📊 Loaded {len(paths)} API paths")
 
-        docs_dir = Path(drf_to_mkdoc_settings.DOCS_DIR)
+        return {"paths": paths, "components": components}
 
-        # Parse and generate endpoints
-        endpoints_by_app = parse_endpoints_from_schema(paths)
-        total_endpoints = generate_endpoint_files(endpoints_by_app, components)
-        create_endpoints_index(endpoints_by_app, docs_dir)
-
-        self.stdout.write(
-            self.style.SUCCESS(
-                f"✅ Generated {total_endpoints} endpoint files with Django view introspection"
-            )
-        )
-
-    def _generate_all(self):
-        """Generate complete documentation"""
-        self.stdout.write("📚 Generating complete documentation...")
-
-        docs_dir = Path(drf_to_mkdoc_settings.DOCS_DIR)
-
-        # Load data
-        json_data = load_model_json_data()
-        models_data = json_data.get("models", {}) if json_data else {}
-        schema = get_schema()
-
-        if not schema:
-            self.stdout.write(self.style.ERROR("❌ Failed to load OpenAPI schema"))
-            return
-
-        paths = schema.get("paths", {})
-        components = schema.get("components", {})
-
-        self.stdout.write(f"📊 Loaded {len(paths)} API paths")
+    def _generate_models_documentation(self, models_data, docs_dir):
+        self.stdout.write("📋 Generating model documentation...")
 
-        # Generate model documentation
-        if models_data:
-            self.stdout.write("📋 Generating model documentation...")
-            try:
-                generate_model_docs(models_data)
-                create_models_index(models_data, docs_dir)
-            except Exception as e:
-                self.stdout.write(self.style.WARNING(f"⚠️  Failed to generate model docs: {e}"))
+        try:
+            generate_model_docs(models_data)
+            create_models_index(models_data, docs_dir)
+            self.stdout.write(self.style.SUCCESS("✅ Model documentation generated"))
+        except Exception as e:
+            self.stdout.write(self.style.WARNING(f"⚠️  Failed to generate model docs: {e}"))
+            if hasattr(self, "_generating_all"):
                 self.stdout.write(self.style.WARNING("Continuing with endpoint generation..."))
-        else:
-            self.stdout.write(self.style.WARNING("⚠️  No model data found"))
+            raise
 
-        # Generate endpoint documentation
+    def _generate_endpoints_documentation(self, schema_data, docs_dir):
         self.stdout.write("🔗 Generating endpoint documentation...")
+
+        paths = schema_data["paths"]
+        components = schema_data["components"]
+
         endpoints_by_app = parse_endpoints_from_schema(paths)
         total_endpoints = generate_endpoint_files(endpoints_by_app, components)
         create_endpoints_index(endpoints_by_app, docs_dir)

{drf_to_mkdoc-0.1.8 → drf_to_mkdoc-0.2.0}/drf_to_mkdoc/management/commands/generate_model_docs.py

@@ -100,7 +100,7 @@ class Command(BaseCommand):
             "description": self.get_model_description(model),
             "abstract": meta.abstract,
             "proxy": meta.proxy,
-            "fields": {},
+            "column_fields": {},
             "relationships": {},
             "meta_options": self.get_meta_options(meta),
             "methods": self.get_model_methods(model),
@@ -111,10 +111,9 @@ class Command(BaseCommand):
             if field.many_to_many or field.one_to_many or field.many_to_one or field.one_to_one:
                 # Handle relationships separately
                 model_doc["relationships"][field.name] = self.introspect_relationship(field)
-            else:
-                # Handle regular fields
-                model_doc["fields"][field.name] = self.introspect_field(field)
-
+            if not (field.one_to_many or field.many_to_many):
+                # Handle column fields
+                model_doc["column_fields"][field.name] = self.introspect_field(field)
         return model_doc
 
     def introspect_field(self, field):