Fix sorting of endpoints with params

Sort foo{arg} after foo/, but before foo/bar. Related to tfranzel#110
jayvdb · Jul 11, 2020 · a4dfe49 · a4dfe49
1 parent 789a062
commit a4dfe49
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 20 deletions.
diff --git a/drf_spectacular/plumbing.py b/drf_spectacular/plumbing.py
@@ -384,6 +384,12 @@ def alpha_operation_sorter(endpoint):
         'PATCH': 3,
         'DELETE': 4
     }.get(method, 5)
+
+    # Sort foo{arg} after foo/, but before foo/bar
+    if path.endswith('/'):
+        path = path[:-1] + ' '
+    path = path.replace('{', '!')
+
     return path, method_priority
 
 

diff --git a/tests/test_extend_schema.yml b/tests/test_extend_schema.yml
@@ -63,6 +63,25 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorDetail'
           description: ''
+  /doesitall/{id}/subscribe/:
+    post:
+      operationId: doesitall_subscribe_create
+      description: ''
+      parameters:
+      - in: path
+        name: id
+        schema:
+          type: integer
+        required: true
+      tags:
+      - doesitall
+      security:
+      - cookieAuth: []
+      - basicAuth: []
+      - {}
+      responses:
+        '201':
+          description: No response body
   /doesitall/callback/{ephemeral}/:
     post:
       operationId: doesitall_callback_create
@@ -217,25 +236,6 @@ paths:
               schema:
                 $ref: '#/components/schemas/Alpha'
           description: ''
-  /doesitall/{id}/subscribe/:
-    post:
-      operationId: doesitall_subscribe_create
-      description: ''
-      parameters:
-      - in: path
-        name: id
-        schema:
-          type: integer
-        required: true
-      tags:
-      - doesitall
-      security:
-      - cookieAuth: []
-      - basicAuth: []
-      - {}
-      responses:
-        '201':
-          description: No response body
 components:
   schemas:
     Alpha:

diff --git a/tests/test_regressions.py b/tests/test_regressions.py
@@ -346,16 +346,18 @@ def similar(request, format=None):
     generator = SchemaGenerator(patterns=urlpatterns)
     schema = generator.get_schema(request=None, public=True)
     validate_schema(schema)
+
     assert len(schema['paths'].keys()) == 7
     assert list(schema['paths'].keys()) == [
         '/pi',
         '/pi/',
+        '/pi{format}',
         '/pi/subpath',
         '/pi/subpath{format}',
         '/pick',
         '/pick{format}',
-        '/pi{format}',
     ]
+
     format_parameter = schema['paths']['/pi{format}']['get']['parameters'][0]
     assert format_parameter['name'] == 'format'
     assert format_parameter['required'] is True