bytes-store/openapi.yaml at master · BlueWallet/bytes-store · 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
openapi: 3.0.0
info:
  title: bytes-store
  description: save key-value data
  version: 1.0.0
servers:
  - url: http://localhost:3001
  - url: https://bytes-store.herokuapp.com
paths:
  /namespace/{namespace}/{key}:
    get:
      summary: retrive value from a namespace/key
      parameters:
        - in: path
          name: namespace
          required: true
          schema:
            type: string
          description: unique namespace
        - in: path
          name: key
          required: true
          schema:
            type: string
          description: unique key inside a namespace
      responses:
        "200":
          description: returns stored string KEY in NAMESPACE
    post:
      summary: save key to a namespace
      parameters:
        - in: path
          name: namespace
          required: true
          schema:
            type: string
        - in: path
          name: key
          required: true
          schema:
            type: string
      requestBody:
        description: any string that needs to be stored
        required: true
        content:
          text/plain:
            schema:
              type: string
      responses:
        "201":
          description: string saved successfully. returns increased sequence number
          content:
            text/plain:
              schema:
                type: integer
                example: 666
  /namespacekeys/{namespace}:
    get:
      summary: retrive all keys from a namespace, comma-separated
      parameters:
        - in: path
          name: namespace
          required: true
          schema:
            type: string
      responses:
        "200":
          description: returns comma-separated keys
  /namespaceseq/{namespace}:
    get:
      summary: retrive sequence number for a namespace
      parameters:
        - in: path
          name: namespace
          required: true
          schema:
            type: string
      responses:
        "200":
          description: returns seq num integer
  /namespacesize/{namespace}:
    get:
      summary: retrive byte size of the whole namespace
      parameters:
        - in: path
          name: namespace
          required: true
          schema:
            type: string
      responses:
        "200":
          description: returns byte size num intege