Merge pull request #78 from openpreserve/feat/add-ordering

Allow api responses to be ordered
openpreserve · Sep 4, 2024 · 6fa48d6 · 6fa48d6
2 parents d07c6f8 + 704dab4
commit 6fa48d6
Showing 1 changed file with 64 additions and 3 deletions.
diff --git a/api/par-api.yaml b/api/par-api.yaml
@@ -135,6 +135,7 @@ paths:
         schema:
           type: integer
           default: 0
+      - $ref: '#/components/parameters/orderNameLastModDateParam'
       responses:
         200:
           description: Success
@@ -1084,6 +1085,7 @@ paths:
         schema:
           type: integer
           default: 0
+      - $ref: '#/components/parameters/orderNameLastModDateParam'
       responses:
         200:
           description: Success
@@ -1726,6 +1728,7 @@ paths:
         schema:
           type: integer
           default: 0
+      - $ref: '#/components/parameters/orderNameLastModDateParam'
       responses:
         200:
           description: Success
@@ -2145,6 +2148,7 @@ paths:
         schema:
           type: integer
           default: 0
+      - $ref: '#/components/parameters/orderNameLastModDateParam'
       responses:
         200:
           description: Success
@@ -2452,6 +2456,20 @@ paths:
         schema:
           type: integer
           default: 0
+      - name: ordering
+        in: query
+        description: Used for requested ordered responses, this defines the properties
+          to user for ordering the list of Preservation Actions returned. 
+          Add '-' prefix for descending order.
+        schema:
+          type: string
+          enum:
+            - name
+            - last-modified-date
+            - preservation-action-type
+            - -name
+            - -last-modified-date
+            - -preservation-action-type
       responses:
         200:
           description: Success
@@ -4198,6 +4216,7 @@ paths:
         schema:
           type: integer
           default: 0
+      - $ref: '#/components/parameters/orderNameLastModDateParam'
       responses:
         200:
           description: Success
@@ -4462,14 +4481,14 @@ paths:
       - name: file-format-name
         in: header
         description: A comma separated list of names of file formats. This filter
-          matches  only those Business Rules that have been defined to apply to one
-          of  the listed formats. This includes formats where the rule is  applicable
+          matches only those Business Rules that have been defined to apply to one
+          of the listed formats. This includes formats where the rule is  applicable
           indirectly through the format family.
         schema:
           type: string
       - name: format-family-guid
         in: header
-        description: 'A comma separated list of names of formats families. This filter  matches
+        description: 'A comma separated list of GUIDs of formats families. This filter  matches
           only those Business Rules that have been defined to apply to  one of the
           listed format families. '
         schema:
@@ -4524,6 +4543,20 @@ paths:
         schema:
           type: integer
           default: 0
+      - name: ordering
+        in: query
+        description: Used for requested ordered responses, this defines the properties
+          to user for ordering the list of RepresentationFormats returned. 
+          Add '-' prefix for descending order.
+        schema:
+          type: string
+          enum:
+            - id-name
+            - name
+            - last-modified-date
+            - -id-name
+            - -name
+            - -last-modified-date
       responses:
         200:
           description: Success
@@ -4876,6 +4909,20 @@ paths:
         schema:
           type: integer
           default: 0
+      - name: ordering
+        in: query
+        description: Used for requested ordered responses, this defines the properties
+          to user for ordering the list of Tools returned. Add '-' prefix for 
+          descending order.
+        schema:
+          type: string
+          enum:
+            - toolLabel
+            - toolName
+            - toolVersion
+            - -toolLabel
+            - -toolName
+            - -toolVersion
       responses:
         200:
           description: Success
@@ -5780,3 +5827,17 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Tool'
+  parameters:
+    orderNameLastModDateParam:
+      - name: ordering
+        in: query
+        description: Used for requested ordered responses, this defines the properties
+          to user for ordering the returned list. 
+          Add '-' prefix for descending order.
+        schema:
+          type: string
+          enum:
+            - name
+            - last-modified-date
+            - -name
+            - -last-modified-date