From 38490206f84dd4fa9137b4e88ac5706aca0253c0 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Fri, 25 Jan 2019 02:59:27 +0800 Subject: [PATCH] improve the releases api paging (#5831) * improve the releases api paging * add max limit on API paging --- doc/advanced/config-cheat-sheet.en-us.md | 1 + doc/advanced/config-cheat-sheet.zh-cn.md | 8 +++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/advanced/config-cheat-sheet.en-us.md b/doc/advanced/config-cheat-sheet.en-us.md index 775fef6f..15f90769 100644 --- a/doc/advanced/config-cheat-sheet.en-us.md +++ b/doc/advanced/config-cheat-sheet.en-us.md @@ -325,6 +325,7 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`. - `ENABLE_SWAGGER`: **true**: Enables /api/swagger, /api/v1/swagger etc. endpoints. True or false; default is true. - `MAX_RESPONSE_ITEMS`: **50**: Max number of items in a page. +- `DEFAULT_PAGING_NUM`: **30**: Default paging number of api. ## i18n (`i18n`) diff --git a/doc/advanced/config-cheat-sheet.zh-cn.md b/doc/advanced/config-cheat-sheet.zh-cn.md index a7109572..990d4d42 100644 --- a/doc/advanced/config-cheat-sheet.zh-cn.md +++ b/doc/advanced/config-cheat-sheet.zh-cn.md @@ -194,7 +194,13 @@ menu: - `PULL`: **300**: 内部仓库间拉取的超时时间,单位秒 - `GC`: **60**: git仓库GC的超时时间,单位秒 -## markup (`markup`) +## API (`api`) + +- `ENABLE_SWAGGER`: **true**: 是否启用swagger路由 /api/swagger, /api/v1/swagger etc. endpoints. True 或 false; 默认是 true. +- `MAX_RESPONSE_ITEMS`: **50**: 一个页面最大的项目数。 +- `DEFAULT_PAGING_NUM`: **30**: API中默认分页条数。 + +## Markup (`markup`) 外部渲染工具支持,你可以用你熟悉的文档渲染工具. 比如一下将新增一个名字为 `asciidoc` 的渲染工具which is followed `markup.` ini section. And there are some config items below.