Jelajahi Sumber

add example showing how to order results. (#15627)

* add example showing how to order results.

This addresses issue 15622 by building off filtering example to
show how to order results on a named field.

* Apply suggestions from code review

---------

Co-authored-by: Frank Clements <fclements@scoore.net>
Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>
muTeREdO 1 tahun lalu
induk
melakukan
238fa704b9
1 mengubah file dengan 8 tambahan dan 2 penghapusan
  1. 8 2
      docs/integrations/rest-api.md

+ 8 - 2
docs/integrations/rest-api.md

@@ -85,13 +85,19 @@ Each model generally has two views associated with it: a list view and a detail
 * `/api/dcim/devices/` - List existing devices or create a new device
 * `/api/dcim/devices/` - List existing devices or create a new device
 * `/api/dcim/devices/123/` - Retrieve, update, or delete the device with ID 123
 * `/api/dcim/devices/123/` - Retrieve, update, or delete the device with ID 123
 
 
-Lists of objects can be filtered using a set of query parameters. For example, to find all interfaces belonging to the device with ID 123:
+Lists of objects can be filtered and ordered using a set of query parameters. For example, to find all interfaces belonging to the device with ID 123:
 
 
 ```
 ```
 GET /api/dcim/interfaces/?device_id=123
 GET /api/dcim/interfaces/?device_id=123
 ```
 ```
 
 
-See the [filtering documentation](../reference/filtering.md) for more details.
+An optional `ordering` parameter can be used to define how to sort the results. Building off the previous example, to sort all the interfaces in reverse order of creation (newest to oldest) for a device with ID 123:
+
+```
+GET /api/dcim/interfaces/?device_id=123&ordering=-created
+```
+
+See the [filtering documentation](../reference/filtering.md) for more details on topics related to filtering, ordering and lookup expressions.
 
 
 ## Serialization
 ## Serialization