shaperail-codegen 0.11.3

YAML parser, validator, and code generator for Shaperail
Documentation 
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

resource: orders
version: 1

schema:
  id:         { type: uuid, primary: true, generated: true }
  user_id:    { type: uuid, ref: users.id, required: true }
  total:      { type: number, required: true }
  status:     { type: enum, values: [pending, paid, shipped, delivered, cancelled], default: pending }
  notes:      { type: string, nullable: true }
  created_at: { type: timestamp, generated: true }
  updated_at: { type: timestamp, generated: true }

endpoints:
  list:
    method: GET
    path: /orders
    auth: [member, admin]
    filters: [status, user_id]
    sort: [created_at]
    pagination: cursor

  create:
    method: POST
    path: /orders
    auth: [member]
    input: [user_id, total, notes]
    events: [order.created]

relations:
  user: { resource: users, type: belongs_to, key: user_id }

indexes:
  - { fields: [user_id] }
  - { fields: [status] }