opnshare/openapi.yaml at main · rerrahkr/opnshare · 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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
openapi: 3.0.4

info:
  title: OPNShare API
  description: API for getting OPN instruments.
  version: 1.0.0

servers:
  - url: https://opnshare.vercel.app/api
    description: API server for OPNShare.

tags:
  - name: instruments
    description: Operations related to instruments.

paths:
  /instruments:
    get:
      summary: Get all instrument info.
      operationId: getInstruments
      tags:
        - instruments
      parameters:
        - name: limit
          in: query
          required: false
          description: Maximum length of the response instrument list.
          schema:
            type: integer
            default: 20
        - name: nextPageToken
          in: query
          required: false
          description: The `nextPageToken` obtained during the previous request for this request.
          schema:
            type: string
      responses:
        "200":
          description: A list of instruments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    description: A list of instrument info.
                    items:
                      type: object
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: Instrument ID.
                              example: abcdefghijk0123
                        - $ref: "#/components/schemas/InstrumentInfo"
                  total:
                    type: integer
                    description: Total instrument count.
                    example: 123
                  nextPageToken:
                    type: string
                    description: A token used in paging. If the next page is none, this set empty.
                    example: snbdLIHjhbd28cVBYdio2562d
          links:
            GetInstruments:
              operationId: getInstruments
              parameters:
                nextPageToken: "$response.body#nextPageToken"
              description: >
                The `nextPageToken` value returned in the response of data can be used as the `nextPageToken` in `GET /instruments?nextPageToken={nextPageToken}`.
            GetInstrumentById:
              operationId: getInstrument
              parameters:
                id: "$response.body#/items/id"
              description: >
                The `id` value of each instrument in the response can be used as the `id` parameter in `GET /instruments/{id}`.

  /instruments/{id}:
    get:
      summary: Get a specific instrument.
      operationId: getInstrument
      tags:
        - instruments
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the instrument.
          schema:
            type: string
      responses:
        "200":
          description: The requested instrument.
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: "#/components/schemas/InstrumentInfo"
                  - type: object
                    properties:
                      data:
                        $ref: "#/components/schemas/FmInstrumentData"
        "404":
          description: Instrument not found.

components:
  schemas:
    InstrumentInfo:
      type: object
      properties:
        name:
          type: string
          description: Instrument name.
          example: Awesome Lead
        author:
          type: string
          description: User ID of the instrument's author.
          example: johnDoe
        recommendedChip:
          type: string
          enum:
            - OPN
            - OPNA
            - OPNB
            - OPN2
          description: Recommended chip.
        tags:
          type: array
          description: Tags.
          items:
            type: string
          example:
            - lead
            - pop

    FmInstrumentData:
      type: object
      properties:
        al:
          type: integer
          description: Algorithm.
          example: 4
        fb:
          type: integer
          description: Feedback.
          example: 5
        lfoFreq:
          type: integer
          description: LFO frequency.
          example: 0
        ams:
          type:  integer
          description: Amplitude modulation sensitivity.
          example: 0
        pms:
          type: integer
          description: Phase modulation sensitivity.
          example: 0
        op:
          type: array
          description: FM operators. It should contain exactly 4 operators.
          items:
            $ref: "#/components/schemas/FmOperator"
          example:
            - ar: 31
              dr: 0
              sr: 0
              rr: 7
              sl: 0
              tl: 16
              ks: 0
              ml: 2
              dt: 0
              am: false
              ssgEg: 0
            - ar: 31
              dr: 5
              sr: 0
              rr: 7
              sl: 0
              tl: 0
              ks: 0
              ml: 2
              dt: 0
              am: false
              ssgEg: 0
            - ar: 31
              dr: 0
              sr: 0
              rr: 7
              sl: 0
              tl: 10
              ks: 0
              ml: 2
              dt: 3
              am: false
              ssgEg: 0
            - ar: 31
              dr: 5
              sr: 0
              rr: 7
              sl: 0
              tl: 0
              ks: 0
              ml: 2
              dt: 3
              am: false
              ssgEg: 0

    FmOperator:
      type: object
      properties:
        ar:
          type: integer
          description: Attack rate.
        dr:
          type: integer
          description: Decay rate.
        sr:
          type: integer
          description: Sustain rate.
        rr:
          type: integer
          description: Release rate.
        sl:
          type: integer
          description: Sustain level.
        tl:
          type: integer
          description: Total level.
        ks:
          type: integer
          description: Key scale.
        ml:
          type: integer
          description: Multiple level.
        dt:
          type: integer
          description: Detune.
        am:
          type: boolean
          description: Amplitude modulation.
        ssgEg:
          type: integer
          description: SSG-EG type.