|
616 | 616 | ]
|
617 | 617 | }
|
618 | 618 | },
|
| 619 | + "/v1/relationships/exportbulk": { |
| 620 | + "post": { |
| 621 | + "summary": "ExportBulkRelationships is the fastest path available to exporting\nrelationships from the server. It is resumable, and will return results\nin an order determined by the server.", |
| 622 | + "operationId": "PermissionsService_ExportBulkRelationships", |
| 623 | + "responses": { |
| 624 | + "200": { |
| 625 | + "description": "A successful response.(streaming responses)", |
| 626 | + "schema": { |
| 627 | + "type": "object", |
| 628 | + "properties": { |
| 629 | + "result": { |
| 630 | + "$ref": "#/definitions/v1ExportBulkRelationshipsResponse" |
| 631 | + }, |
| 632 | + "error": { |
| 633 | + "$ref": "#/definitions/rpcStatus" |
| 634 | + } |
| 635 | + }, |
| 636 | + "title": "Stream result of v1ExportBulkRelationshipsResponse" |
| 637 | + } |
| 638 | + }, |
| 639 | + "default": { |
| 640 | + "description": "An unexpected error response.", |
| 641 | + "schema": { |
| 642 | + "$ref": "#/definitions/rpcStatus" |
| 643 | + } |
| 644 | + } |
| 645 | + }, |
| 646 | + "parameters": [ |
| 647 | + { |
| 648 | + "name": "body", |
| 649 | + "description": "ExportBulkRelationshipsRequest represents a resumable request for\nall relationships from the server.", |
| 650 | + "in": "body", |
| 651 | + "required": true, |
| 652 | + "schema": { |
| 653 | + "$ref": "#/definitions/v1ExportBulkRelationshipsRequest" |
| 654 | + } |
| 655 | + } |
| 656 | + ], |
| 657 | + "tags": [ |
| 658 | + "PermissionsService" |
| 659 | + ] |
| 660 | + } |
| 661 | + }, |
| 662 | + "/v1/relationships/importbulk": { |
| 663 | + "post": { |
| 664 | + "summary": "ImportBulkRelationships is a faster path to writing a large number of\nrelationships at once. It is both batched and streaming. For maximum\nperformance, the caller should attempt to write relationships in as close\nto relationship sort order as possible: (resource.object_type,\nresource.object_id, relation, subject.object.object_type,\nsubject.object.object_id, subject.optional_relation). All relationships\nwritten are done so under a single transaction.", |
| 665 | + "operationId": "PermissionsService_ImportBulkRelationships", |
| 666 | + "responses": { |
| 667 | + "200": { |
| 668 | + "description": "A successful response.", |
| 669 | + "schema": { |
| 670 | + "$ref": "#/definitions/v1ImportBulkRelationshipsResponse" |
| 671 | + } |
| 672 | + }, |
| 673 | + "default": { |
| 674 | + "description": "An unexpected error response.", |
| 675 | + "schema": { |
| 676 | + "$ref": "#/definitions/rpcStatus" |
| 677 | + } |
| 678 | + } |
| 679 | + }, |
| 680 | + "parameters": [ |
| 681 | + { |
| 682 | + "name": "body", |
| 683 | + "description": "ImportBulkRelationshipsRequest represents one batch of the streaming\nImportBulkRelationships API. The maximum size is only limited by the backing\ndatastore, and optimal size should be determined by the calling client\nexperimentally. (streaming inputs)", |
| 684 | + "in": "body", |
| 685 | + "required": true, |
| 686 | + "schema": { |
| 687 | + "$ref": "#/definitions/v1ImportBulkRelationshipsRequest" |
| 688 | + } |
| 689 | + } |
| 690 | + ], |
| 691 | + "tags": [ |
| 692 | + "PermissionsService" |
| 693 | + ] |
| 694 | + } |
| 695 | + }, |
619 | 696 | "/v1/relationships/read": {
|
620 | 697 | "post": {
|
621 | 698 | "summary": "ReadRelationships reads a set of the relationships matching one or more\nfilters.",
|
|
3026 | 3103 | "securityDefinitions": {
|
3027 | 3104 | "ApiKeyAuth": {
|
3028 | 3105 | "type": "apiKey",
|
| 3106 | + "description": "SpiceDB preshared-key, prefixed by Bearer: Bearer \u003cpreshared-key\u003e", |
3029 | 3107 | "name": "Authorization",
|
3030 | 3108 | "in": "header"
|
3031 | 3109 | }
|
3032 | 3110 | },
|
| 3111 | + "security": [ |
| 3112 | + { |
| 3113 | + "ApiKeyAuth": [] |
| 3114 | + } |
| 3115 | + ], |
3033 | 3116 | "externalDocs": {
|
3034 | 3117 | "description": "More about the Authzed API.",
|
3035 | 3118 | "url": "https://docs.authzed.com/reference/api"
|
|
0 commit comments