feat: pagination.

This commit is contained in:
tx7do
2023-11-04 13:24:42 +08:00
parent efbbf420c3
commit 1c54fc7554
3 changed files with 73 additions and 141 deletions

View File

@@ -8,20 +8,11 @@ import "google/protobuf/any.proto";
import "google/protobuf/field_mask.proto";
import "gnostic/openapi/v3/annotations.proto";
// 排序类型
enum SortOrder {
// 不排序
UNSORTED = 0;
// 升序
ASCENDING = 1;
// 降序
DESCENDING = 2;
}
// 分页通用请求
message PagingRequest {
// 当前页码
optional int32 page = 1 [
json_name = "page",
(gnostic.openapi.v3.property) = {
description: "当前页码",
default: {number: 1}
@@ -29,7 +20,7 @@ message PagingRequest {
];
// 每页的行数
optional int32 pageSize = 2 [
optional int32 page_size = 2 [
json_name = "pageSize",
(gnostic.openapi.v3.property) = {
description: "每一页的行数",
@@ -47,7 +38,7 @@ message PagingRequest {
];
// 或过滤参数
optional string orQuery = 4 [
optional string or_query = 4 [
json_name = "or",
(gnostic.openapi.v3.property) = {
description: "或过滤参数",
@@ -56,7 +47,7 @@ message PagingRequest {
];
// 排序条件
repeated string orderBy = 5 [
repeated string order_by = 5 [
json_name = "orderBy",
(gnostic.openapi.v3.property) = {
description: "排序条件,字段名前加'-'为降序,否则为升序。"
@@ -65,14 +56,14 @@ message PagingRequest {
];
// 是否不分页
optional bool noPaging = 6 [
optional bool no_paging = 6 [
json_name = "nopaging",
(gnostic.openapi.v3.property) = {description: "是否不分页"}
];
// 字段掩码
google.protobuf.FieldMask fieldMask = 7 [
json_name = "field_mask",
google.protobuf.FieldMask field_mask = 7 [
json_name = "fieldMask",
(gnostic.openapi.v3.property) = {description: "字段掩码"}
];
}