shaperail-codegen 0.16.0

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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

resource: users
version: 1

schema:
  id:         { type: uuid, primary: true, generated: true }
  email:      { type: string, format: email, unique: true, required: true, sensitive: true }
  name:       { type: string, min: 1, max: 200, required: true }
  role:       { type: enum, values: [admin, member, viewer], default: member }
  org_id:     { type: uuid, ref: organizations.id, required: true }
  avatar_url: { type: string, format: url, nullable: true }
  metadata:   { type: json, nullable: true }
  created_at: { type: timestamp, generated: true }
  updated_at: { type: timestamp, generated: true }
  deleted_at: { type: timestamp, nullable: true }

endpoints:
  list:
    method: GET
    path: /users
    auth: [member, admin]
    filters: [role, org_id, created_at]
    search: [name, email]
    pagination: cursor
    sort: [created_at, name]
    cache: { ttl: 60, invalidate_on: [create, update, delete] }

  create:
    method: POST
    path: /users
    auth: [admin]
    input: [email, name, role, org_id]
    controller:
      before: validate_org
    events: [user.created]
    jobs: [send_welcome_email]

  update:
    method: PATCH
    path: /users/:id
    auth: [admin, owner]
    input: [name, role, avatar_url, metadata]
    events: [user.updated]

  delete:
    method: DELETE
    path: /users/:id
    auth: [admin]
    soft_delete: true

relations:
  organization: { resource: organizations, type: belongs_to, key: org_id }
  orders:       { resource: orders, type: has_many, foreign_key: user_id }

indexes:
  - { fields: [email], unique: true }
  - { fields: [org_id, role] }
  - { fields: [created_at], order: desc }