-
Notifications
You must be signed in to change notification settings - Fork 3
/
openapi.yml
7539 lines (7192 loc) · 278 KB
/
openapi.yml
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: HTTP API Console
description: ""
version: 0.2.0
servers:
- url: http://rpc1.testnet1.source.network:1317/
tags:
- name: ACP
description: Access Control Policy (ACP) message types
- name: Bulletin
description: Bulletin module message types
paths:
/sourcehub.acp.Msg/CheckAccess:
post:
tags:
- ACP
summary: CheckAccess executes an Access Request for an User
description: |-
The resulting evaluation is stored in SourceHub. It's used to generate a cryptographic proof that the given Access Request
was valid at a particular block height.
operationId: SourcehubAcpMsg_CheckAccess
requestBody:
content:
'*/*':
schema:
type: object
properties:
creator:
type: string
policy_id:
type: string
creation_time:
type: string
format: date-time
access_request:
title: AccessRequest represents the wish to perform a set of operations
by an actor
type: object
properties:
operations:
type: array
items:
type: object
properties:
object:
title: target object for operation
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must be
access controlled within a Policy.
permission:
title: permission required to perform operation
type: string
description: Operation represents an action over an object.
actor:
title: actor requesting operations
type: object
properties:
id:
type: string
description: Actor represents an entity which makes access requests
to a Policy.
required: true
responses:
"200":
description: A successful response.
content:
'*/*':
schema:
type: object
properties:
decision:
title: AccessDecision models the result of evaluating a set of
AccessRequests for an Actor
type: object
properties:
id:
type: string
policy_id:
title: used as part of id generation
type: string
creator:
title: used as part of id generation
type: string
creator_acc_sequence:
title: used as part of id generation
type: string
format: uint64
operations:
title: used as part of id generation
type: array
items:
type: object
properties:
object:
title: target object for operation
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must
be access controlled within a Policy.
permission:
title: permission required to perform operation
type: string
description: Operation represents an action over an object.
actor_did:
title: used as part of id generation
type: string
actor:
title: used as part of id generation
type: string
params:
title: used as part of id generation
type: object
properties:
decision_expiration_delta:
title: number of blocks a Decision is valid for
type: string
format: uint64
proof_expiration_delta:
title: number of blocks a DecisionProof is valid for
type: string
format: uint64
ticket_expiration_delta:
title: number of blocks an AccessTicket is valid for
type: string
format: uint64
creation_time:
type: string
format: date-time
issued_height:
title: issued_height stores the block height when the Decision
was evaluated
type: string
format: uint64
default:
description: An unexpected error response.
content:
'*/*':
schema:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
additionalProperties:
type: object
x-codegen-request-body-name: body
/sourcehub.acp.Msg/CreatePolicy:
post:
tags:
- ACP
summary: |-
CreatePolicy adds a new Policy.
description: |-
The Policy models an aplication's high level access control rules.
operationId: SourcehubAcpMsg_CreatePolicy
requestBody:
content:
'*/*':
schema:
type: object
properties:
creator:
type: string
policy:
type: string
marshal_type:
type: string
description: |-
PolicyEncodingType enumerates supported marshaling types for policies.
- UNKNOWN: Fallback value for a missing Marshaling Type
- SHORT_YAML: Policy Marshaled as a YAML Short Policy definition
- SHORT_JSON: Policy Marshaled as a JSON Short Policy definition
default: UNKNOWN
enum:
- UNKNOWN
- SHORT_YAML
- SHORT_JSON
creation_time:
type: string
format: date-time
required: true
responses:
"200":
description: A successful response.
content:
'*/*':
schema:
type: object
properties:
policy:
type: object
properties:
id:
type: string
name:
type: string
description:
type: string
creation_time:
type: string
format: date-time
attributes:
type: object
additionalProperties:
type: string
resources:
type: array
items:
type: object
properties:
name:
type: string
doc:
type: string
permissions:
type: array
items:
type: object
properties:
name:
type: string
doc:
type: string
expression:
type: string
description: |-
Permission models a special type of Relation which is evaluated at runtime.
A permission often maps to an operation defined for a resource which an actor may attempt.
relations:
type: array
items:
type: object
properties:
name:
type: string
doc:
type: string
manages:
title: list of relations managed by the current
relation
type: array
items:
type: string
vr_types:
title: value restriction types
type: array
items:
type: object
properties:
resource_name:
title: resource_name scopes permissible
actors resource
type: string
relation_name:
title: relation_name scopes permissible
actors relation
type: string
description: |-
Restriction models a specification which a Relationship's actor
should meet.
description: |-
Resource models a namespace for objects in a Policy.
Appications will have multiple entities which they must manage such as files or groups.
A Resource represents a set of entities of a certain type.
actor_resource:
type: object
properties:
name:
type: string
doc:
type: string
relations:
type: array
items:
type: object
properties:
name:
type: string
doc:
type: string
manages:
title: list of relations managed by the current
relation
type: array
items:
type: string
vr_types:
title: value restriction types
type: array
items:
type: object
properties:
resource_name:
title: resource_name scopes permissible actors
resource
type: string
relation_name:
title: relation_name scopes permissible actors
relation
type: string
description: |-
Restriction models a specification which a Relationship's actor
should meet.
description: ActorResource represents a special Resource which
is reserved for Policy actors.
creator:
type: string
description: |-
Policy represents an ACP module Policy definition.
Each Policy defines a set of high level rules over how the acces control system
should behave.
default:
description: An unexpected error response.
content:
'*/*':
schema:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
additionalProperties:
type: object
x-codegen-request-body-name: body
/sourcehub.acp.Msg/DeleteRelationship:
post:
tags:
- ACP
summary: |-
DelereRelationship removes a Relationship from a Policy.
description: |-
If the Relationship was not found in a Policy, this Msg is a no-op.
operationId: SourcehubAcpMsg_DeleteRelationship
requestBody:
content:
'*/*':
schema:
type: object
properties:
creator:
type: string
policy_id:
type: string
relationship:
type: object
properties:
object:
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must be access
controlled within a Policy.
relation:
type: string
subject:
type: object
properties:
actor:
type: object
properties:
id:
type: string
description: Actor represents an entity which makes access
requests to a Policy.
actor_set:
type: object
properties:
object:
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must
be access controlled within a Policy.
relation:
type: string
description: |-
ActorSet represents a set of Actors in a Policy.
It is specified through an Object, Relation pair, which represents
all actors which have a relationship with given obj-rel pair.
This expansion is recursive.
all_actors:
type: object
properties: {}
description: |-
AllActors models a special Relationship Subject which indicates
that all Actors in the Policy are included.
object:
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must be access
controlled within a Policy.
description: Subject specifies the target of a Relationship.
description: |-
Relationship models an access control rule.
It states that the given subject has relation with object.
required: true
responses:
"200":
description: A successful response.
content:
'*/*':
schema:
type: object
properties:
record_found:
type: boolean
default:
description: An unexpected error response.
content:
'*/*':
schema:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
additionalProperties:
type: object
x-codegen-request-body-name: body
/sourcehub.acp.Msg/RegisterObject:
post:
tags:
- ACP
summary: RegisterObject creates a Relationship within a Policy.
description: |-
The Owner has complete control over the set of subjects that are related
to their Object,
giving them autonomy to share the object and revoke acces to the object,
much like owners in a Discretionary Access Control model.
Attempting to register a previously registered Object is an error,
Object IDs are therefore assumed to be unique within a Policy.
operationId: SourcehubAcpMsg_RegisterObject
requestBody:
content:
'*/*':
schema:
type: object
properties:
creator:
type: string
policy_id:
type: string
object:
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must be access controlled
within a Policy.
creation_time:
type: string
format: date-time
required: true
responses:
"200":
description: A successful response.
content:
'*/*':
schema:
type: object
properties:
result:
title: RegistrationResult encodes the possible result set from
Registering an Object
type: string
description: |-
- NoOp: NoOp indicates no action was take. The operation failed or the Object already existed and was active
- Registered: Registered indicates the Object was sucessfuly registered to the Actor.
- Unarchived: Unarchived indicates that a previously deleted Object is active again.
Only the original owners can Unarchive an object.
default: NoOp
enum:
- NoOp
- Registered
- Unarchived
default:
description: An unexpected error response.
content:
'*/*':
schema:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
additionalProperties:
type: object
x-codegen-request-body-name: body
/sourcehub.acp.Msg/SetRelationship:
post:
tags:
- ACP
summary: SetRelationship creates or updates a Relationship within a Policy.
description: |-
A Relationship is a statement which ties together an object and a
subjecto with a "relation",
which means the set of high level rules defined in the Policy will apply
to these entities.
operationId: SourcehubAcpMsg_SetRelationship
requestBody:
content:
'*/*':
schema:
type: object
properties:
creator:
type: string
policy_id:
type: string
creation_time:
type: string
format: date-time
relationship:
type: object
properties:
object:
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must be access
controlled within a Policy.
relation:
type: string
subject:
type: object
properties:
actor:
type: object
properties:
id:
type: string
description: Actor represents an entity which makes access
requests to a Policy.
actor_set:
type: object
properties:
object:
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must
be access controlled within a Policy.
relation:
type: string
description: |-
ActorSet represents a set of Actors in a Policy.
It is specified through an Object, Relation pair, which represents
all actors which have a relationship with given obj-rel pair.
This expansion is recursive.
all_actors:
type: object
properties: {}
description: |-
AllActors models a special Relationship Subject which indicates
that all Actors in the Policy are included.
object:
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must be access
controlled within a Policy.
description: Subject specifies the target of a Relationship.
description: |-
Relationship models an access control rule.
It states that the given subject has relation with object.
required: true
responses:
"200":
description: A successful response.
content:
'*/*':
schema:
type: object
properties:
record_existed:
title: "Indicates whether the given Relationship previously existed,\
\ ie the Tx was a no op"
type: boolean
default:
description: An unexpected error response.
content:
'*/*':
schema:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
additionalProperties:
type: object
x-codegen-request-body-name: body
/sourcehub.acp.Msg/UnregisterObject:
post:
tags:
- ACP
summary: UnregisterObject "unshare" a Object.
description: |-
A caveat is that after removing the Relationships, a record of the original Object owner
is maintained to prevent an "ownership hijack" attack.
Suppose Bob owns object Foo, which is shared with Bob but not Eve.
Eve wants to access Foo but was not given permission to, they could "hijack" Bob's object by waiting for Bob to Unregister Foo,
then submitting a RegisterObject Msg, effectively becoming Foo's new owner.
If Charlie has a copy of the object, Eve could convince Charlie to share his copy, granting Eve access to Foo.
The previous scenario where an unauthorized user is able to claim ownership to data previously unaccessible to them
is an "ownership hijack".
operationId: SourcehubAcpMsg_UnregisterObject
requestBody:
content:
'*/*':
schema:
type: object
properties:
creator:
type: string
policy_id:
type: string
object:
type: object
properties:
resource:
type: string
id:
type: string
description: Object represents an entity which must be access controlled
within a Policy.
required: true
responses:
"200":
description: A successful response.
content:
'*/*':
schema:
type: object
properties:
found:
type: boolean
default:
description: An unexpected error response.
content:
'*/*':
schema:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
additionalProperties:
type: object
x-codegen-request-body-name: body
/sourcehub.bulletin.Msg/CreatePost:
post:
tags:
- Bulletin
summary: Post to the Bulletin
operationId: SourcehubBulletinMsg_CreatePost
requestBody:
content:
'*/*':
schema:
type: object
properties:
creator:
type: string
namespace:
type: string
payload:
pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
type: string
format: byte
proof:
pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
type: string
format: byte
required: true
responses:
"200":
description: A successful response.
content:
'*/*':
schema:
type: object
default:
description: An unexpected error response.
content:
'*/*':
schema:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
additionalProperties:
type: object
x-codegen-request-body-name: body
components:
schemas:
cosmos.auth.v1beta1.MsgUpdateParams:
type: object
properties:
authority:
type: string
description: authority is the address that controls the module (defaults
to x/gov unless overwritten).
params:
type: object
properties:
max_memo_characters:
type: string
format: uint64
tx_sig_limit:
type: string
format: uint64
tx_size_cost_per_byte:
type: string
format: uint64
sig_verify_cost_ed25519:
type: string
format: uint64
sig_verify_cost_secp256k1:
type: string
format: uint64
description: |-
params defines the x/auth parameters to update.
NOTE: All parameters must be supplied.
description: |-
MsgUpdateParams is the Msg/UpdateParams request type.
Since: cosmos-sdk 0.47
cosmos.auth.v1beta1.MsgUpdateParamsResponse:
type: object
description: |-
MsgUpdateParamsResponse defines the response structure for executing a
MsgUpdateParams message.
Since: cosmos-sdk 0.47
cosmos.auth.v1beta1.Params:
type: object
properties:
max_memo_characters:
type: string
format: uint64
tx_sig_limit:
type: string
format: uint64
tx_size_cost_per_byte:
type: string
format: uint64
sig_verify_cost_ed25519:
type: string
format: uint64
sig_verify_cost_secp256k1:
type: string
format: uint64
description: Params defines the parameters for the auth module.
google.protobuf.Any:
type: object
properties:
'@type':
type: string
description: |-
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
`path/google.protobuf.Duration`). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme `http`, `https`, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
* If no scheme is provided, `https` is assumed.
* An HTTP GET on the URL must yield a [google.protobuf.Type][]
value in binary format, or produce an error.
* Applications are allowed to cache lookup results based on the
URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)
Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com.
Schemes other than `http`, `https` (or the empty scheme) might be
used with implementation specific semantics.
additionalProperties:
type: object
description: |-
`Any` contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form
of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}
The pack methods provided by protobuf library will by default use
'type.googleapis.com/full.type.name' as the type URL and the unpack
methods only use the fully qualified type name after the last '/'
in the type URL, for example "foo.bar.com/x/y.z" will yield type
name "y.z".
JSON
The JSON representation of an `Any` value uses the regular
representation of the deserialized, embedded message, with an
additional field `@type` which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
`value` which holds the custom JSON in addition to the `@type`
field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
google.rpc.Status:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
additionalProperties:
type: object
description: |-
`Any` contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form
of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.