soundr/apiDocs.yml at master · project-name-here/soundr · 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
144
145
146
147
148
149
openapi: '3.0.2'
info:
  title: Soundr
  version: '1.0'
servers:
  - url: http://localhost:8082/v1/
paths:
  /play:
    get:
      summary: Plays a sound by it's base64'd name. Will load it to buffer first if not already loaded.
      parameters:
        - in: query
          name: file
          description: A base64 encoded version of the file name
          schema:
            type: string
        - in: query
          name: loop
          description: Defaults to false; if true, will loop the sound until stopped
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: number
                    description: The ID of the playing sound
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  reason:
                    type: string
                    description: The error message, in this case probably "file not found"
  /buffer:
    get:
      summary: Loads a sound into the buffer.
      parameters:
        - in: query
          name: file
          description: A base64 encoded version of the file name
          schema:
            type: string
      responses:
        '200':
          description: OK

        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  reason:
                    type: string
                    description: The error message, in this case probably "file not found"
  /bufferAll:
    get:
      summary: Loads all sounds into the buffer.
      responses:
        '200':
          description: OK
  /stop:
    get:
      summary: Stops a given sound by it's ID.
      parameters:
        - in: query
          name: id
          description: The ID of the sound to stop
          schema:
            type: number
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  reason:
                    type: string
                    description: The error message
  /stopAll:
    get:
      summary: Stops all sounds.
      responses:
        '200':
          description: OK
  /current:
    get:
      summary: Gets the current playing sound(s).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  sounds:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          description: The ID of the sound
                        name:
                          type: string
                          description: The name of the sound
                        loaded:
                          type: boolean
                          description: Whether the sound is loaded into the buffer
  /list:
   get: # TODO REWORK!!!!!
    summary: Lists all sounds in the buffer.
    responses:
      '200':
        description: OK
        content:
          application/json:
            schema:
              type: object
              properties:
                sounds:
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        description: The name of the sound
                      base64:
                        type: string
                        description: The base64 version of the name
                      url:
                        type: string
                        description: The URL to the sound