diff --git a/guides/common/modules/ref_json-response-metadata.adoc b/guides/common/modules/ref_json-response-metadata.adoc index bb73bc1417..be5b6ddd0c 100644 --- a/guides/common/modules/ref_json-response-metadata.adoc +++ b/guides/common/modules/ref_json-response-metadata.adoc @@ -3,15 +3,15 @@ {Project} API responses contain the following metadata fields: -* `total` {endash} The total number of objects without any search parameters. -* `subtotal` {endash} The number of objects returned with the given search parameters. +`total`:: The total number of objects without any search parameters. +`subtotal`:: The number of objects returned with the given search parameters. If there is no search, then subtotal is equal to total. -* `page` {endash} The page number. -* `per_page` {endash} The maximum number of objects returned per page. -* `limit` {endash} The specified number of objects to return in a collection response. -* `offset` {endash} The number of objects skipped before returning a collection. -* `search` {endash} The search string based on `scoped_scoped` syntax. -* `sort` -** `by` {endash} Specifies by what field the API sorts the collection. -** `order` {endash} The sort order, either ASC for ascending or DESC for descending. -* `results` {endash} The collection of objects. +`page`:: The page number. +`per_page`:: The maximum number of objects returned per page. +`limit`:: The specified number of objects to return in a collection response. +`offset`:: The number of objects skipped before returning a collection. +`search`:: The search string based on `scoped_scoped` syntax. +`sort`:: +* `by` {endash} Specifies by what field the API sorts the collection. +* `order` {endash} The sort order, either ASC for ascending or DESC for descending. +`results`:: The collection of objects.