Renames ordering parameter from "ordering" to "_order" (#495)

* Renames ordering parameter from "ordering" to "_order" * Updates openapi spec
Better-HPC · Dec 4, 2024 · 10a8f41 · 10a8f41
1 parent 627390c
commit 10a8f41
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 79 deletions.
diff --git a/docs/api.yml b/docs/api.yml
@@ -46,6 +46,12 @@ paths:
       operationId: allocations_allocations_list
       description: Manage HPC resource allocations.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -168,12 +174,6 @@ paths:
         name: id__lte
         schema:
           type: integer
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: request
         schema:
@@ -378,6 +378,12 @@ paths:
       operationId: allocations_attachments_list
       description: Files submitted as attachments to allocation requests
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -417,12 +423,6 @@ paths:
         name: id__lte
         schema:
           type: integer
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: request
         schema:
@@ -665,6 +665,12 @@ paths:
       operationId: allocations_clusters_list
       description: Configuration settings for managed Slurm clusters.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -779,12 +785,6 @@ paths:
         name: name__startswith
         schema:
           type: string
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       tags:
       - allocations
       security:
@@ -939,6 +939,12 @@ paths:
       operationId: allocations_requests_list
       description: Manage allocation requests.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -1125,12 +1131,6 @@ paths:
         name: id__lte
         schema:
           type: integer
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: status
         schema:
@@ -1446,6 +1446,12 @@ paths:
       operationId: allocations_reviews_list
       description: Manage administrator reviews of allocation requests.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -1556,12 +1562,6 @@ paths:
         name: last_modified__year
         schema:
           type: number
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: private_comments
         schema:
@@ -1964,6 +1964,12 @@ paths:
       operationId: logs_apps_list
       description: Returns application log data.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -2152,12 +2158,6 @@ paths:
         name: name__startswith
         schema:
           type: string
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: pathname
         schema:
@@ -2329,6 +2329,12 @@ paths:
       operationId: logs_requests_list
       description: Returns HTTP request log data.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -2484,12 +2490,6 @@ paths:
         name: method__startswith
         schema:
           type: string
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: remote_address
         schema:
@@ -2682,6 +2682,12 @@ paths:
       operationId: logs_tasks_list
       description: Returns results from scheduled background tasks.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -2950,12 +2956,6 @@ paths:
         name: meta__startswith
         schema:
           type: string
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: periodic_task_name
         schema:
@@ -3278,6 +3278,12 @@ paths:
       operationId: research_grants_list
       description: Track funding awards and grant information.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -3500,12 +3506,6 @@ paths:
         name: id__lte
         schema:
           type: integer
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: start_date
         schema:
@@ -3765,6 +3765,12 @@ paths:
       operationId: research_publications_list
       description: Manage metadata for research publications.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -3950,12 +3956,6 @@ paths:
         name: journal__startswith
         schema:
           type: string
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: team
         schema:
@@ -4156,6 +4156,12 @@ paths:
       operationId: users_membership_list
       description: Manage team membership.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -4195,12 +4201,6 @@ paths:
         name: id__lte
         schema:
           type: integer
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: role
         schema:
@@ -4444,6 +4444,12 @@ paths:
       operationId: users_teams_list
       description: Manage user teams.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -4529,12 +4535,6 @@ paths:
         name: name__startswith
         schema:
           type: string
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       tags:
       - users
       security:
@@ -4689,6 +4689,12 @@ paths:
       operationId: users_users_list
       description: Manage user account data.
       parameters:
+      - name: _order
+        required: false
+        in: query
+        description: Which field to use when ordering the results.
+        schema:
+          type: string
       - name: _search
         required: false
         in: query
@@ -5054,12 +5060,6 @@ paths:
         name: last_name__startswith
         schema:
           type: string
-      - name: ordering
-        required: false
-        in: query
-        description: Which field to use when ordering the results.
-        schema:
-          type: string
       - in: query
         name: password
         schema:

diff --git a/keystone_api/main/settings.py b/keystone_api/main/settings.py
@@ -162,6 +162,8 @@
 # REST API settings
 
 REST_FRAMEWORK = {
+    'SEARCH_PARAM': '_search',
+    'ORDERING_PARAM': '_order',
     'DEFAULT_PERMISSION_CLASSES': [
         'rest_framework.permissions.IsAuthenticated'
     ],
@@ -181,7 +183,6 @@
         'rest_framework.filters.OrderingFilter',
         'rest_framework.filters.SearchFilter'
     ),
-    'SEARCH_PARAM': '_search',
     'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
 }