forked from cloudevents/spec
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathschemaregistry.yaml
331 lines (330 loc) · 8.64 KB
/
schemaregistry.yaml
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
openapi: 3.0.0
info:
title: Cloud Native Data Schema Registry
version: "0.2"
paths:
/schema:
get:
description: 'Direct access to a particular schema document providing its Schema Version URI'
operationId: getSchemaVersionByURI
parameters:
- in: query
name: uri
required: true
schema:
type: string
description: 'Schema version URI (requires percent-encoding).'
responses:
'200':
$ref: '#/components/responses/SchemaBytePayloadResponse'
'404':
description: 'Specified schema not found'
/schemagroups:
get:
summary: 'Get list of schema groups'
description: 'Get all schema groups in namespace.'
operationId: getGroups
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: string
tags:
- 'groups'
/schemagroups/{group-id}:
parameters:
- name: group-id
in: path
description: schema group
required: true
schema:
type: string
get:
summary: Get schema group
description: Get schema group description in registry namespace.
operationId: getGroup
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SchemaGroup'
'404':
description: Specified group not found
tags:
- 'groups'
put:
summary: Create schema group
description: Create schema group with specified format in registry namespace.
operationId: createGroup
requestBody:
description: schema group description
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SchemaGroup'
responses:
'201':
description: Created
headers:
Location:
schema:
type: string
'409':
description: Schema group already exists
tags:
- 'groups'
delete:
summary: Delete schema group
description: Delete schema group in schema registry namespace.
operationId: deleteGroup
responses:
'204':
description: OK no content
'404':
description: Specified group not found
tags:
- 'groups'
/schemagroups/{group-id}/schemas:
parameters:
- name: group-id
in: path
description: schema group
required: true
schema:
type: string
get:
tags:
- 'groups'
summary: List schemas for group id
description: Returns schema by group id.
operationId: getSchemasByGroup
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: string
'404':
description: Group not found
delete:
tags:
- 'groups'
summary: Deletes all schemas in group
description: Deletes all schemas under specified group id.
operationId: deleteSchemasByGroup
responses:
'204':
description: OK no content
'404':
description: Group not found
/schemagroups/{group-id}/schemas/{schema-id}:
parameters:
- name: group-id
in: path
description: schema group
required: true
schema:
type: string
- name: schema-id
in: path
description: schema id
required: true
schema:
type: string
post:
summary: Register schema
description: >
Register schema.
If schema of specified name does not exist in specified group, schema is created at version 1.
If schema of specified name exists already in specified group, schema is created at latest version + 1.
If schema with identical content already exists, existing schema's ID is returned.
operationId: createSchema
requestBody:
description: schema content
required: true
content:
application/json;format=avro:
schema:
$ref: '#/components/schemas/SchemaBytePayload'
responses:
'200':
$ref: '#/components/responses/SchemaIdResponse'
'400':
description: Invalid request
tags:
- 'registration'
get:
summary: Get latest version of schema
description: Get latest version of schema.
operationId: getLatestSchema
responses:
'200':
$ref: '#/components/responses/SchemaBytePayloadResponse'
tags:
- 'schemas'
delete:
summary: Delete schema
operationId: deleteSchema
responses:
'204':
description: OK no content
'404':
description: Matching schema not found
tags:
- 'schemas'
/schemagroups/{group-id}/schemas/{schema-id}/versions:
parameters:
- name: group-id
in: path
description: schema group
required: true
schema:
type: string
- name: schema-id
in: path
description: schema id
required: true
schema:
type: string
get:
summary: Get list of versions
description: Get list of versions for specified schema
operationId: getSchemaVersions
responses:
'200':
description: OK
content:
application/json;format=avro:
schema:
type: array
items:
type: integer
tags:
- 'versions'
/schemagroups/{group-id}/schemas/{schema-id}/versions/{version-number}:
parameters:
- name: group-id
in: path
description: schema group
required: true
schema:
type: string
- name: schema-id
in: path
description: schema id
required: true
schema:
type: string
- name: version-number
in: path
description: version number
required: true
schema:
type: integer
get:
summary: Get specified version of schema
operationId: getSchemaVersion
responses:
'200':
$ref: '#/components/responses/SchemaBytePayloadResponse'
'404':
description: Specified schema not found
tags:
- 'versions'
delete:
summary: Delete specified version of schema
operationId: deleteSchemaVersion
responses:
'204':
description: OK no content
tags:
- 'versions'
components:
schemas:
SchemaId:
type: object
properties:
id:
type: string
SchemaBytePayload:
type: string
SchemaGroup:
type: object
properties:
id:
type: string
description:
type: string
createdtimeutc:
type: string
format: date-time
updatedtimeutc:
type: string
format: date-time
format:
type: string
groupProperties:
type: object
additionalProperties:
type: string
responses:
SchemaIdResponse:
description: OK
headers:
Location:
schema:
type: string
Schema-Id:
schema:
type: string
format: uuid
description: unique schema identifier
Schema-Id-Location:
schema:
type: string
format: url
description: location of schema resource
Schema-Version:
schema:
type: integer
description: version of returned schema
content:
application/json;format=avro:
schema:
$ref: '#/components/schemas/SchemaId'
application/json;format=protobuf:
schema:
$ref: '#/components/schemas/SchemaId'
SchemaBytePayloadResponse:
description: OK
headers:
Location:
schema:
type: string
Schema-Id:
schema:
type: string
description: schema identifier
Schema-Id-Location:
schema:
type: string
format: url
description: location of schema resource
Schema-Version:
schema:
type: integer
description: version of returned schema
content:
application/json;format=avro:
schema:
$ref: '#/components/schemas/SchemaBytePayload'