wot-server/openapi-spec.yaml at main · weex/wot-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
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
openapi: 3.0.0
info:
  version: 1.0.0
  title: Web of Trust API
  description: Providing API access to update trust scores,  retrieve trusted state and recalculate scoring.

servers:
  - url: http://localhost:20202

paths:
  /status:
    get:
      description: Return general info about server instance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  uptime:
                    description: uptime in seconds
                    type: integer
                  free:
                    description: free space in Mb
                    type: integer
  /trust:
    post:
      description: Set or update single trust value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - source
                - target
              properties:
                source:
                  description: Giver of trust
                  type: string
                target:
                  description: Recipient of trust
                  type: string
                value:
                  type: number
                delta:
                  type: number
      responses:
        '200':
          description: Success set or updated a trust value
  /score:
    get:
      description: Get trusted status of target user from perspective of source.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - source
                - target
              properties:
                source:
                  description: Requesting on behalf of
                  type: string
                target:
                  description: User to return trusted state of
                  type: string
      responses:
        '200':
          description: Successfully retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  trusted:
                    type: boolean
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
  /rescore:
    get:
      description: Recalculate scores
      responses:
        '200':
          description: Successfully retrieved
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
  /debug:
    get:
      description: Get full state for debugging purposes.
      responses:
        '200':
           description: Successfully retrieved
           content:
             application/json:
               schema:
                 type: object
                 properties:
                   paths:
                     type: object
                   ranks:
                     type: object
                   capacities:
                     type: object
                   scores:
                     type: object