Improve docs for get params Django API

Author: TheSuperiorStanislav

saritasa_s3_tools/configs.py

@@ -41,30 +41,23 @@ class S3FileTypeConfig(metaclass=S3FileTypeConfigMeta):
     # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
     content_disposition: typing.Literal["attachment", "inline"] = "attachment"
 
-    @staticmethod
-    def get_formatted_s3_configs() -> str:
-        """Get formatted S3 configs descriptions for api description."""
-        formatted_s3_configs: list[str] = []
-        for name, config in S3FileTypeConfig.configs.items():
-            allowed_types = (
-                ", ".join(config.allowed) if config.allowed else "All types"
+    def get_short_description(self) -> str:
+        """Get short description for config."""
+        allowed_types = (
+            ", ".join(self.allowed) if self.allowed else "All types"
+        )
+        content_length_range = (
+            (
+                f"{self.content_length_range[0]}-"
+                f"{self.content_length_range[1]} bytes"
             )
-            content_length_range = (
-                (
-                    f"{config.content_length_range[0]}-"
-                    f"{config.content_length_range[1]} bytes"
-                )
-                if config.content_length_range
-                else "Any length"
-            )
-            formatted_s3_configs.append(
-                f"`{name}`\n\n"
-                f"| Parameter | Value |\n"
-                f"|:---|:---|\n"
-                f"| Allowed | {allowed_types} |\n"
-                f"| Content length range | {content_length_range} |\n"
-                f"| Expires in | {config.expires_in} seconds |\n"
-                f"| Success action status | {config.success_action_status} |\n"
-                f"| Content disposition | {config.content_disposition} |",
-            )
-        return "\n\n".join(formatted_s3_configs)
+            if self.content_length_range
+            else "Any length"
+        )
+        return (
+            f"*Allowed types*: {allowed_types}, "
+            f"*Content length range*: {content_length_range}, "
+            f"*Expires in*: {self.expires_in} seconds, "
+            f"*Success action status*: {self.success_action_status}, "
+            f"*Content disposition*: {self.content_disposition}"
+        )

saritasa_s3_tools/django/drf_fields.py

@@ -25,7 +25,9 @@ def _get_choices(self) -> dict[str, str]:
         current_choices = tuple(
             (
                 config_name,
-                config_name,
+                configs.S3FileTypeConfig.configs[
+                    config_name
+                ].get_short_description(),
             )
             for config_name in configs.S3FileTypeConfig.configs
         )

saritasa_s3_tools/django/views.py

@@ -154,21 +154,3 @@ def get_extra_meta_data(
             responses=serializers.S3ConfigSerializer(),
         ),
     )(S3GetParamsView)
-
-
-class _Docs(str):
-    """Hack to make dynamic docs for drf-spectacular."""
-
-    def expandtabs(
-        self,
-        *args: typing.Any,
-        **kwargs,
-    ) -> str:
-        return str(
-            self
-            + "\n\n**Available configs**:\n\n"
-            + configs.S3FileTypeConfig.get_formatted_s3_configs(),
-        ).expandtabs(*args, **kwargs)
-
-
-S3GetParamsView.get_params.__doc__ = _Docs(S3GetParamsView.get_params.__doc__)