server/openapi.yaml at main · rmcluster/server · 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
openapi: 3.0.4
info:
  title: "rmcluster server"
  version: 0.0.1

paths:
  /announce:
    get:
      operationId: TrackerAnnounceGet
      summary: Announce a new node
      parameters:
        - name: id
          description: "The unique identifier of the node (should be generated and stored by the node itself)"
          in: query
          required: true
          schema:
            type: string
        - name: port
          description: "The port for the llama-rpc server"
          in: query
          required: true
          schema:
            type: integer
        - name: storage_port
          description: "The port for the storage server"
          in: query
          required: false
          schema:
            type: integer
        - name: ip
          in: query
          required: false
          schema:
            type: string
      responses:
        200:
          description: "Successful announce"
          content:
            application/json:
              schema:
                type: object
                required:
                  - interval
                properties:
                  interval:
                    type: float
                    description: "The number of seconds the client should wait between announces."
  /servers:
    get:
      operationId: TrackerServersGet
      summary: List all nodes currently known to the tracker
      responses:
        200:
          description: "Successful listing of nodes"
          content:
            application/json:
              schema:
                type: object
                required:
                  - servers
                properties:
                  servers:
                    type: array
                    items:
                      type: object
                      required:
                        - ip
                        - port
                        - last_seen
                      properties:
                        ip:
                          type: string
                        port:
                          type: integer
                        storage_port:
                          type: integer
                        last_seen:
                          type: string
                        hardware_model:
                          type: string
                        max_size:
                          type: integer
                        battery:
                          type: number
                        temperature:
                          type: number