-
Notifications
You must be signed in to change notification settings - Fork 17
/
openapi.yaml
418 lines (417 loc) · 16 KB
/
openapi.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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
openapi: 3.0.3
info:
title: ""
version: 0.0.1
paths:
/livez:
get:
tags:
- KesselRelationsHealthService
operationId: KesselRelationsHealthService_GetLivez
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1.GetLivezResponse'
/readyz:
get:
tags:
- KesselRelationsHealthService
operationId: KesselRelationsHealthService_GetReadyz
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1.GetReadyzResponse'
/v1beta1/check:
post:
tags:
- KesselCheckService
description: "Checks for the existence of a single Relationship \n (a Relation between a Resource and a Subject or Subject Set)."
operationId: KesselCheckService_Check
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.CheckRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.CheckResponse'
/v1beta1/resources:
get:
tags:
- KesselLookupService
operationId: KesselLookupService_LookupResources
parameters:
- name: resourceType.namespace
in: query
schema:
type: string
- name: resourceType.name
in: query
schema:
type: string
- name: relation
in: query
schema:
type: string
- name: subject.relation
in: query
description: |-
An optional relation which points to a set of Subjects instead of the single Subject.
e.g. "members" or "owners" of a group identified in `subject`.
schema:
type: string
- name: subject.subject.type.namespace
in: query
schema:
type: string
- name: subject.subject.type.name
in: query
schema:
type: string
- name: subject.subject.id
in: query
schema:
type: string
- name: pagination.limit
in: query
schema:
type: integer
format: uint32
- name: pagination.continuationToken
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.LookupResourcesResponse'
/v1beta1/subjects:
get:
tags:
- KesselLookupService
operationId: KesselLookupService_LookupSubjects
parameters:
- name: resource.type.namespace
in: query
schema:
type: string
- name: resource.type.name
in: query
schema:
type: string
- name: resource.id
in: query
schema:
type: string
- name: relation
in: query
schema:
type: string
- name: subjectType.namespace
in: query
schema:
type: string
- name: subjectType.name
in: query
schema:
type: string
- name: subjectRelation
in: query
schema:
type: string
- name: pagination.limit
in: query
schema:
type: integer
format: uint32
- name: pagination.continuationToken
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.LookupSubjectsResponse'
/v1beta1/tuples:
get:
tags:
- KesselTupleService
operationId: KesselTupleService_ReadTuples
parameters:
- name: filter.resourceNamespace
in: query
schema:
type: string
- name: filter.resourceType
in: query
schema:
type: string
- name: filter.resourceId
in: query
schema:
type: string
- name: filter.relation
in: query
schema:
type: string
- name: filter.subjectFilter.subjectNamespace
in: query
schema:
type: string
- name: filter.subjectFilter.subjectType
in: query
schema:
type: string
- name: filter.subjectFilter.subjectId
in: query
schema:
type: string
- name: filter.subjectFilter.relation
in: query
schema:
type: string
- name: pagination.limit
in: query
schema:
type: integer
format: uint32
- name: pagination.continuationToken
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.ReadTuplesResponse'
post:
tags:
- KesselTupleService
operationId: KesselTupleService_CreateTuples
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.CreateTuplesRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.CreateTuplesResponse'
delete:
tags:
- KesselTupleService
operationId: KesselTupleService_DeleteTuples
parameters:
- name: filter.resourceNamespace
in: query
schema:
type: string
- name: filter.resourceType
in: query
schema:
type: string
- name: filter.resourceId
in: query
schema:
type: string
- name: filter.relation
in: query
schema:
type: string
- name: filter.subjectFilter.subjectNamespace
in: query
schema:
type: string
- name: filter.subjectFilter.subjectType
in: query
schema:
type: string
- name: filter.subjectFilter.subjectId
in: query
schema:
type: string
- name: filter.subjectFilter.relation
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.DeleteTuplesResponse'
/v1beta1/tuples/bulkimport:
post:
tags:
- KesselTupleService
operationId: KesselTupleService_ImportBulkTuples
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.ImportBulkTuplesRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/kessel.relations.v1beta1.ImportBulkTuplesResponse'
components:
schemas:
kessel.relations.v1.GetLivezResponse:
type: object
properties:
status:
type: string
code:
type: integer
format: uint32
kessel.relations.v1.GetReadyzResponse:
type: object
properties:
status:
type: string
code:
type: integer
format: uint32
kessel.relations.v1beta1.CheckRequest:
type: object
properties:
resource:
$ref: '#/components/schemas/kessel.relations.v1beta1.ObjectReference'
relation:
type: string
subject:
$ref: '#/components/schemas/kessel.relations.v1beta1.SubjectReference'
kessel.relations.v1beta1.CheckResponse:
type: object
properties:
allowed:
type: integer
format: enum
kessel.relations.v1beta1.CreateTuplesRequest:
type: object
properties:
upsert:
type: boolean
description: |-
Whether or not the request should ignore existing tuples (`true`),
or if the request should fail if the same tuple already exists (`false`).
Defaults to `false`.
tuples:
type: array
items:
$ref: '#/components/schemas/kessel.relations.v1beta1.Relationship'
kessel.relations.v1beta1.CreateTuplesResponse:
type: object
properties: {}
kessel.relations.v1beta1.DeleteTuplesResponse:
type: object
properties: {}
kessel.relations.v1beta1.ImportBulkTuplesRequest:
type: object
properties:
tuples:
type: array
items:
$ref: '#/components/schemas/kessel.relations.v1beta1.Relationship'
kessel.relations.v1beta1.ImportBulkTuplesResponse:
type: object
properties:
numImported:
type: string
kessel.relations.v1beta1.LookupResourcesResponse:
type: object
properties:
resource:
$ref: '#/components/schemas/kessel.relations.v1beta1.ObjectReference'
pagination:
$ref: '#/components/schemas/kessel.relations.v1beta1.ResponsePagination'
kessel.relations.v1beta1.LookupSubjectsResponse:
type: object
properties:
subject:
$ref: '#/components/schemas/kessel.relations.v1beta1.SubjectReference'
pagination:
$ref: '#/components/schemas/kessel.relations.v1beta1.ResponsePagination'
kessel.relations.v1beta1.ObjectReference:
type: object
properties:
type:
$ref: '#/components/schemas/kessel.relations.v1beta1.ObjectType'
id:
type: string
kessel.relations.v1beta1.ObjectType:
type: object
properties:
namespace:
type: string
name:
type: string
kessel.relations.v1beta1.ReadTuplesResponse:
type: object
properties:
tuple:
$ref: '#/components/schemas/kessel.relations.v1beta1.Relationship'
pagination:
$ref: '#/components/schemas/kessel.relations.v1beta1.ResponsePagination'
kessel.relations.v1beta1.Relationship:
type: object
properties:
resource:
$ref: '#/components/schemas/kessel.relations.v1beta1.ObjectReference'
relation:
type: string
subject:
$ref: '#/components/schemas/kessel.relations.v1beta1.SubjectReference'
description: "A _Relationship_ is the realization of a _Relation_ (a string) \n between a _Resource_ and a _Subject_ or a _Subject Set_ (known as a Userset in Zanzibar).\n\n All Relationships are object-object relations.\n \"Resource\" and \"Subject\" are relative terms which define the direction of a Relation.\n That is, Relations are unidirectional.\n If you reverse the Subject and Resource, it is a different Relation and a different Relationship.\n Conventionally, we generally refer to the Resource first, then Subject,\n following the direction of typical graph traversal (Resource to Subject)."
kessel.relations.v1beta1.ResponsePagination:
type: object
properties:
continuationToken:
type: string
kessel.relations.v1beta1.SubjectReference:
type: object
properties:
relation:
type: string
description: |-
An optional relation which points to a set of Subjects instead of the single Subject.
e.g. "members" or "owners" of a group identified in `subject`.
subject:
$ref: '#/components/schemas/kessel.relations.v1beta1.ObjectReference'
description: A reference to a Subject or, if a `relation` is provided, a Subject Set.
tags:
- name: KesselCheckService
- name: KesselLookupService
- name: KesselRelationsHealthService
- name: KesselTupleService
description: "KesselTupleServices manages the persisted _Tuples_ stored in the system..\n \n A Tuple is an explicitly stated, persistent relation \n between a Resource and a Subject or Subject Set. \n It has the same _shape_ as a Relationship but is not the same thing as a Relationship.\n \n A single Tuple may result in zero-to-many Relationships."