File size: 2,666 Bytes
1477a90 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | import "@typespec/http";
import "@typespec/rest";
import "@typespec/openapi3";
using TypeSpec.Http;
namespace OpenMeter;
/**
* Pagination query params
*/
@friendlyName("Pagination")
model QueryPagination {
/**
* Page index.
*
* Default is 1.
*/
@query
@minValue(1)
@example(1)
@pageIndex
page?: integer = 1;
/**
* The maximum number of items per page.
*
* Default is 100.
*/
@query
@minValue(1)
@maxValue(1000)
@example(100)
@pageSize
pageSize?: integer = 100;
}
/**
* Limit and offset query params
*/
@friendlyName("LimitOffset")
model QueryLimitOffset {
/**
* Number of items to skip.
*
* Default is 0.
*/
@query
@minValue(0)
@example(0)
offset?: integer = 0;
/**
* Number of items to return.
*
* Default is 100.
*/
@query
@minValue(1)
@maxValue(1000)
@example(100)
limit?: integer = 100;
}
/**
* Ordering query params
*/
@friendlyName("{name}Ordering", T)
model QueryOrdering<T> {
/**
* The order direction.
*/
@query
@example(SortOrder.ASC)
order?: SortOrder = SortOrder.ASC;
/**
* The order by field.
*
* @TODO Default values cannot be passed as generics in typespec,
* even though the docs say so:
* https://typespec.io/docs/language-basics/templates
*/
@query
orderBy?: T;
}
/**
* The order direction.
*/
@friendlyName("SortOrder")
enum SortOrder {
#suppress "@openmeter/api-spec-legacy/casing" "Use existing values"
ASC: "ASC",
#suppress "@openmeter/api-spec-legacy/casing" "Use existing values"
DESC: "DESC",
}
/**
* Paginated response
*/
@friendlyName("{name}PaginatedResponse", T)
model PaginatedResponse<T> {
/**
* The total number of items.
*/
@example(500)
totalCount: integer;
/**
* The page index.
*/
@example(1)
page: integer;
/**
* The maximum number of items per page.
*/
@example(100)
pageSize: integer;
/**
* The items in the current page.
*/
@pageItems
items: T[];
}
/**
* Paginated cursor query parameters.
*/
@friendlyName("CursorPagination")
model QueryCursorPagination {
/**
* The cursor after which to start the pagination.
*/
@query
@continuationToken
cursor?: string;
/**
* The limit of the pagination.
*/
@query
@minValue(1)
@maxValue(100)
limit?: integer = 100;
}
/**
* A response for cursor pagination.
*/
@friendlyName("{name}CursorPaginatedResponse", T)
model CursorPaginatedResponse<T> {
/**
* The items in the response.
*/
@pageItems
@maxItems(100)
items: T[];
/**
* The cursor of the last item in the list.
*/
@continuationToken
nextCursor?: string;
}
|