openrpc-to-typescript/openrpc-users-api.json at master · matejdostal/openrpc-to-typescript · GitHub

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
{
  "openrpc": "1.2.6",
  "info": {
    "title": "User Management API",
    "version": "1.0.1",
    "description": "OpenRPC specification for the user CRUD API where method parameters are spread into the JSON-RPC params object."
  },
  "methods": [
    {
      "name": "getUsers",
      "summary": "Retrieve a list of users",
      "params": [],
      "result": {
        "name": "result",
        "schema": { "$ref": "#/components/schemas/GetUsersResult" }
      }
    },
    {
      "name": "getUserById",
      "summary": "Retrieve a user by ID",
      "params": [
        {
          "name": "userId",
          "required": true,
          "schema": { "type": "integer" }
        }
      ],
      "result": {
        "name": "result",
        "schema": { "$ref": "#/components/schemas/GetUserByIdResult" }
      }
    },
    {
      "name": "createUser",
      "summary": "Create a new user",
      "params": [
        {
          "name": "userName",
          "required": true,
          "schema": { "type": "string" }
        },
        {
          "name": "userEmail",
          "required": false,
          "schema": { "type": "string", "format": "email" }
        }
      ],
      "result": {
        "name": "result",
        "schema": { "$ref": "#/components/schemas/CreateUserResult" }
      }
    },
    {
      "name": "updateUser",
      "summary": "Update an existing user",
      "params": [
        {
          "name": "userId",
          "required": true,
          "schema": { "type": "integer" }
        },
        {
          "name": "userName",
          "required": false,
          "schema": { "type": "string" }
        },
        {
          "name": "userEmail",
          "required": false,
          "schema": { "type": "string", "format": "email" }
        }
      ],
      "result": {
        "name": "result",
        "schema": { "$ref": "#/components/schemas/UpdateUserResult" }
      }
    },
    {
      "name": "deleteUser",
      "summary": "Delete a user by ID",
      "params": [
        {
          "name": "userId",
          "required": true,
          "schema": { "type": "integer" }
        }
      ],
      "result": {
        "name": "result",
        "schema": { "$ref": "#/components/schemas/DeleteUserResult" }
      }
    }
  ],
  "components": {
    "schemas": {
      "User": {
        "type": "object",
        "properties": {
          "userId": { "type": "integer" },
          "userName": { "type": "string" },
          "userEmail": { "type": "string", "format": "email" }
        },
        "required": ["userId", "userName"]
      },
      "GetUsersResult": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": { "$ref": "#/components/schemas/User" }
          },
          "totalCount": { "type": "integer" }
        },
        "required": ["data"]
      },
      "GetUserByIdResult": {
        "type": "object",
        "properties": {
          "data": { "$ref": "#/components/schemas/User" }
        },
        "required": ["data"]
      },
      "CreateUserResult": {
        "type": "object",
        "properties": {
          "data": { "$ref": "#/components/schemas/User" }
        },
        "required": ["data"]
      },
      "UpdateUserResult": {
        "type": "object",
        "properties": {
          "data": { "$ref": "#/components/schemas/User" }
        },
        "required": ["data"]
      },
      "DeleteUserResult": {
        "type": "object",
        "properties": {}
      }
    }
  }
}