From d078b95b59e08dc35903f2d93417c3c50dca9a00 Mon Sep 17 00:00:00 2001 From: Takashi NATSUME Date: Tue, 25 Dec 2018 18:16:13 +0900 Subject: [PATCH] Add description about sort order in API ref guideline Add a description about sort order of response results in the API reference guideline. Change-Id: I458795a4f745a0699bc8de40aaa2b3c03c762422 Partial-Bug: #1793034 --- doc/source/contributor/api-ref-guideline.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/source/contributor/api-ref-guideline.rst b/doc/source/contributor/api-ref-guideline.rst index df59a0e124..b9ba4921c8 100644 --- a/doc/source/contributor/api-ref-guideline.rst +++ b/doc/source/contributor/api-ref-guideline.rst @@ -160,6 +160,12 @@ Or links to the pages describing them should be added. - Whether the scheduler choose a destination host or not +* Sort order of response results + + - Describe sorting order of response results if the API implements the order + (e.g. The response is sorted by ``created_at`` and ``id`` + in descending order by default) + * Policy - Default policy (the admin only, the admin or the owner)