webwire-cli 0.1.6

Contract-First API System - Command Line Interface
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
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

namespace user {

    enum UserState {
        Active,
        Inactive,
        Banned
    }

    struct UserRequest {
        email: String,
    }

    struct Name {
        prefix: String (length=0..50),
        first_name: String (length=0..100),
        middle_name: String (length=0..100),
        last_name: String (length=0..100, help="aka. family name"),
        suffix: String (length=0..50),
        full_name: String
    }

    fieldset NameUpdate for Name {
        prefix?,
        first_name?,
        middle_name?,
        last_name?,
        suffix?
    }

    struct User {
        id: UUID,
        email: String,
        name: Name,
        password: String (length=5..64),
        is_admin: Boolean,
    }

    fieldset UserRead for User {
        id,
        email,
        is_admin,
        name
    }

    fieldset UserWrite for User {
        id,
        email?,
        is_admin?,
        name?,
        password?,
    }

    struct UserListRequest {
        offset?: Integer (size=32, range=0..),
        limit?: Integer (range=1..200)
    }

    struct UserList {
        count: Integer (
            range=0..0xFFFF,
            help="Count of objects returned"
        ),
        users: [UserRead] (length=0..128),
        permissions: {UUID: String}
    }

    enum GetError {
        PermissionDenied,
        DoesNotExist
    }

    enum ListError {
        PermissionDenied
    }

    service ExampleService {
        get_version: None -> String,
        user_get: UserRequest -> Result<UserRead, GetError>,
        user_list: UserListRequest -> Result<UserList, ListError>,
    }

}