api-ref: document sorting parameters for l3

API users can use the 'sort_key' and 'sort_dir' to do the sorting
on list result. This patch add documentation of these two parameters
for l3 networking resources, including floatingip, router, subnet,
and subnetpool.

Change-Id: I3f1a6fa6f9e3d30882986e8c6c9e80c033d03525
Partial-Bug: #1749024

api-ref/source/v2/floatingips.inc

@@ -53,6 +53,8 @@ Request
    - fixed_ip_address: floatingip-fixed_ip_address-query
    - floating_ip_address: floating_ip_address-query
    - port_id: floatingip-port_id-query
+   - sort_dir: sort_dir
+   - sort_key: floatingip-sort_key
    - tags: tags-query
    - tags-any: tags-any-query
    - not-tags: not-tags-query

api-ref/source/v2/parameters.yaml

@@ -443,6 +443,21 @@ floatingip-router_id-query:
   in: query
   required: false
   type: string
+floatingip-sort_key:
+  description: |
+    Sorts by a floatingip attribute. You can specify multiple pairs of sort key
+    and sort direction query parameters. The sort keys are limited to:
+
+    - ``fixed_ip_address``
+    - ``floating_ip_address``
+    - ``floating_network_id``
+    - ``id``
+    - ``router_id``
+    - ``status``
+    - ``tenant_id``
+  in: query
+  required: false
+  type: string
 floatingip-status-query:
   description: |
     Filter the floating IP list result by the status of the floating IP.
@@ -703,6 +718,20 @@ revision_number-query:
   in: query
   required: false
   type: integer
+router-sort_key:
+  description: |
+    Sorts by a router attribute. You can specify multiple pairs of sort key
+    and sort direction query parameters. The sort keys are limited to:
+
+    - ``admin_state_up``
+    - ``flavor_id``
+    - ``id``
+    - ``name``
+    - ``status``
+    - ``tenant_id``
+  in: query
+  required: false
+  type: string
 router:external-query:
   description: |
     Filter the network list result based on whether the network has an
@@ -783,6 +812,26 @@ subnet-segment_id-query:
   in: query
   required: false
   type: string
+subnet-sort_key:
+  description: |
+    Sorts by a subnet attribute. You can specify multiple pairs of sort key
+    and sort direction query parameters. The sort keys are limited to:
+
+    - ``cidr``
+    - ``enable_dhcp``
+    - ``gateway_ip``
+    - ``id``
+    - ``ip_version``
+    - ``ipv6_address_mode``
+    - ``ipv6_ra_mode``
+    - ``name``
+    - ``network_id``
+    - ``segment_id``
+    - ``subnetpool_id``
+    - ``tenant_id``
+  in: query
+  required: false
+  type: string
 subnet-subnetpool_id-query:
   description: |
     Filter the subnet list result by the ID of the subnet pool associated
@@ -790,6 +839,25 @@ subnet-subnetpool_id-query:
   in: query
   required: false
   type: string
+subnetpool-sort_key:
+  description: |
+    Sorts by a subnetpool attribute. You can specify multiple pairs of sort key
+    and sort direction query parameters. The sort keys are limited to:
+
+    - ``address_scope_id``
+    - ``default_prefixlen``
+    - ``default_quota``
+    - ``id``
+    - ``ip_version``
+    - ``is_default``
+    - ``max_prefixlen``
+    - ``min_prefixlen``
+    - ``name``
+    - ``shared``
+    - ``tenant_id``
+  in: query
+  required: false
+  type: string
 subnetpool_is_default-query:
   description: |
     Filter the subnet pool list result based on if it is a default pool or not.

api-ref/source/v2/routers.inc

@@ -72,6 +72,8 @@ Request
    - description: description-query
    - admin_state_up: admin_state_up-query
    - revision_number: revision_number-query
+   - sort_dir: sort_dir
+   - sort_key: router-sort_key
    - tags: tags-query
    - tags-any: tags-any-query
    - not-tags: not-tags-query

api-ref/source/v2/subnetpools.inc

@@ -191,6 +191,8 @@ Request
    - description: description-query
    - is_default: subnetpool_is_default-query
    - revision_number: revision_number-query
+   - sort_dir: sort_dir
+   - sort_key: subnetpool-sort_key
    - tags: tags-query
    - tags-any: tags-any-query
    - not-tags: not-tags-query

api-ref/source/v2/subnets.inc

@@ -68,6 +68,8 @@ Request
    - ipv6_ra_mode: subnet-ipv6_ra_mode-query
    - revision_number: revision_number-query
    - segment_id: subnet-segment_id-query
+   - sort_dir: sort_dir
+   - sort_key: subnet-sort_key
    - subnetpool_id: subnet-subnetpool_id-query
    - tags: tags-query
    - tags-any: tags-any-query