describe versions sortBy parameter

opf · Oct 29, 2024 · a918e5b · a918e5b
1 parent 25b524a
commit a918e5b
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/api/apiv3/paths/versions.yml b/docs/api/apiv3/paths/versions.yml
@@ -14,6 +14,19 @@ get:
       required: false
       schema:
         type: string
+    - description: |-
+        JSON specifying sort criteria.
+        Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported attributes are:
+
+        + id: Sort by the version id
+        + name: Sort by the version name using numeric collation, comparing sequences of decimal digits by their numeric value
+        + semver_name: Deprecated, use name instead
+      example: '[["name", "desc"]]'
+      in: query
+      name: sortBy
+      required: false
+      schema:
+        type: string
   responses:
     '200':
       content: