DeWeb/server/api/readAPI-V0.yml at 21933b67e7c31db70393a1b412704c112c44fff6 · massalabs/DeWeb · 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
swagger: "2.0"
info:
  title: DeWeb Read API
  description: DeWeb API used to browse decentralized websites
  version: 0.1.0

schemes:
  - http
paths:
  /{resource}:
    get:
      operationId: getResource
      parameters:
        - name: resource
          in: path
          required: true
          type: string
      responses:
        "200":
          description: Successful response
        "404":
          description: Resource not found
          schema:
            $ref: "#/definitions/Error"
  /:
    get:
      operationId: defaultPage
      responses:
        "200":
          description: Shows the default page

  /__deweb_info:
    get:
      operationId: getDeWebInfo
      produces:
        - application/json
      responses:
        "200":
          description: Successful response
          schema:
            $ref: "#/definitions/DeWebInfo"

definitions:
  Error:
    type: object
    properties:
      message:
        type: string
  DeWebInfo:
    type: object
    properties:
      app:
        type: string
      version:
        type: string
      misc:
        type: object
        additionalProperties: true
      network:
        type: object
        properties:
          network:
            type: string
          version:
            type: string
          chainID:
            type: integer
            format: int64
      allowList:
        type: array
        items:
          type: string
      blockList:
        type: array
        items:
          type: string
      noBanner:
        type: boolean