Cursor rule

1---
2description:
3globs: **/*.{openapi.yaml}
4alwaysApply: false
5---
6query:
7  - name: order_by
8    type: string
9    required: optional
10    allowed: [created_at, updated_at, reference_at]
11    default: created_at
12    description: Field used for ordering results. Only temporal fields are allowed. Invalid values must trigger 400 error with `ORDER_BY_INVALID`.
13 
14  - name: sort
15    type: string
16    required: optional
17    allowed: [asc, desc]
18    default: asc
19    case_insensitive: true
20    description: Direction of ordering. Accepts `asc` or `desc`. Invalid values must trigger 400 error with `SORT_INVALID`.
21 
22rules:
23  - if: order_by is missing
24    then: default to `created_at`
25 
26  - if: sort is missing
27    then: default to `asc`
28 
29  - enforce: Must use indexed temporal fields for sorting
30  - enforce: Must ensure sorting stability using secondary key like `entity_id`
31  - enforce: Sorting logic must be compatible with pagination logic
32 
33errors:
34  - scenario: invalid order_by
35    status: 400
36    code: ERR400_INVALID_PARAMETER
37    reason: ORDER_BY_INVALID_VALUE
38 
39  - scenario: invalid sort
40    status: 400
41    code: ERR400_INVALID_PARAMETER
42    reason: SORT_INVALID_VALUE
43 
44examples:
45  - request: GET /api/v1/ledgers?order_by=created_at
46  - request: GET /api/v1/ledgers?order_by=reference_at&sort=desc
47  - request: GET /api/v1/ledgers?sort=DESC
48 
49notes:
50  - Sorting must be applied to all endpoints that return paginated lists.
51  - Must be documented in the OpenAPI (OAS) contract.
52  - Exceptions are allowed only with justification recorded in the Product Decision Record (PDR).
53  - Sorting behavior must be deterministic and predictable across requests.
54 
55 
56 
57