Request + response examples

1
methods:
2
  - name: user.create
3
    summary: Create a new user
4
    params:
5
      - name: userData
6
        schema:
7
          $ref: '#/components/schemas/CreateUserRequest'
8
        required: true
9
    x-fern-examples:
10
      - name: StandardUser
11
        description: Create a regular user account
12
        params:
13
          userData:
14
            email: "john@example.com"
15
            name: "John Doe"
16
            role: "user"
17
        result:
18
          id: "user_123"
19
          email: "john@example.com"
20
          name: "John Doe"
21
          role: "user"
22
          createdAt: "2024-01-15T10:30:00Z"
23
      - name: AdminUser
24
        description: Create an admin user account
25
        params:
26
          userData:
27
            email: "admin@example.com"
28
            name: "Admin User"
29
            role: "admin"
30
            permissions: ["read", "write", "delete"]
31
        result:
32
          id: "user_456"
33
          email: "admin@example.com"
34
          name: "Admin User"
35
          role: "admin"
36
          createdAt: "2024-01-15T10:30:00Z"
37
    result:
38
      name: user
39
      schema:
40
        $ref: '#/components/schemas/User'