django-pfx 1.4.dev52__tar.gz → 1.4.dev54__tar.gz

{django_pfx-1.4.dev52 → django_pfx-1.4.dev54}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.4.dev52
+Version: 1.4.dev54
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev52 → django_pfx-1.4.dev54}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.4.dev52
+Version: 1.4.dev54
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev52 → django_pfx-1.4.dev54}/pfx/pfxcore/locale/fr/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-05-21 15:30+0200\n"
+"POT-Creation-Date: 2024-08-20 12:22+0200\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -280,6 +280,6 @@ msgstr "{model} {obj} modifié."
 msgid "{model} {obj} deleted."
 msgstr "{model} {obj} supprimé."
 
-#: views/rest_views.py:1139 views/rest_views.py:1167
+#: views/rest_views.py:1169 views/rest_views.py:1209
 msgid "Unexpected storage error"
 msgstr "Erreur de stockage inattendue"

{django_pfx-1.4.dev52 → django_pfx-1.4.dev54}/pfx/pfxcore/views/rest_views.py

@@ -1124,11 +1124,41 @@ class MediaRestViewMixin(ModelMixin):
         ---
         get:
             summary: Get upload URL
-            description: Get upload URL for a file field.
+            description: |
+                Get upload URL for a `MediaField` field.
+
+                You can upload a file ont the received URL. When the upload
+                query is done, you have to confirm the process with an
+                update request (`PUT`) on {model}. The body of this request
+                must contain the name of the `MediaField` with the contents
+                of the `file` value in the response of this request.
+
+                1. `GET /<int:pk>/<str:field>/upload-url/<str:filename>`
+                    → `data`
+                2. `PUT data.url aFile Content-Type: aFile.type`
+                3. `PUT /<int:pk> {{field: data.file}}`
             parameters extras:
-                pk: the {model} pk
-                field: the {model} field name
-                filename: the desired filename
+                pk: The {model} pk.
+                field: The {model} field name. Must be the name of
+                    a `MediaField` field.
+                filename: The desired filename.
+            responses:
+                200:
+                    description: The upload URL
+                    content:
+                        application/json:
+                            schema:
+                                properties:
+                                    url:
+                                        type: string
+                                        format: uri
+                                    file:
+                                        type: object
+                                        properties:
+                                            name:
+                                                type: string
+                                            key:
+                                                type: string
         """
         obj = self.get_object(pk=pk)
         try:
@@ -1158,6 +1188,18 @@ class MediaRestViewMixin(ModelMixin):
             parameters extras:
                 pk: the {model} pk
                 field: the {model} field name
+            responses:
+                200:
+                    description: The file URL, if `redirect` is `false`.
+                    content:
+                        application/json:
+                            schema:
+                                properties:
+                                    url:
+                                        type: string
+                                        format: uri
+                302:
+                    description: The redirect, if `redirect` is `true`.
         """
         obj = self.get_object(pk=pk)
         try: