|
2 | 2 | // @generated from file redpanda/api/common/v1/options.proto (package redpanda.api.common.v1, syntax proto3) |
3 | 3 | /* eslint-disable */ |
4 | 4 |
|
5 | | -import type { GenExtension, GenFile } from "@bufbuild/protobuf/codegenv1"; |
6 | | -import { extDesc, fileDesc } from "@bufbuild/protobuf/codegenv1"; |
| 5 | +import type { GenExtension, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1"; |
| 6 | +import { extDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv1"; |
7 | 7 | import type { MethodOptions } from "@bufbuild/protobuf/wkt"; |
8 | 8 | import { file_google_protobuf_descriptor } from "@bufbuild/protobuf/wkt"; |
| 9 | +import type { Message } from "@bufbuild/protobuf"; |
9 | 10 |
|
10 | 11 | /** |
11 | 12 | * Describes the file redpanda/api/common/v1/options.proto. |
12 | 13 | */ |
13 | 14 | export const file_redpanda_api_common_v1_options: GenFile = /*@__PURE__*/ |
14 | | - fileDesc("CiRyZWRwYW5kYS9hcGkvY29tbW9uL3YxL29wdGlvbnMucHJvdG8SFnJlZHBhbmRhLmFwaS5jb21tb24udjE6UAoTcmVxdWlyZWRfcGVybWlzc2lvbhIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGPd3IAMoCVIScmVxdWlyZWRQZXJtaXNzaW9uQllaV2J1Zi5idWlsZC9nZW4vZ28vcmVkcGFuZGFkYXRhL2NvbW1vbi9wcm90b2NvbGJ1ZmZlcnMvZ28vcmVkcGFuZGEvYXBpL2NvbW1vbi92MTtjb21tb252MWIGcHJvdG8z", [file_google_protobuf_descriptor]); |
| 15 | + fileDesc("CiRyZWRwYW5kYS9hcGkvY29tbW9uL3YxL29wdGlvbnMucHJvdG8SFnJlZHBhbmRhLmFwaS5jb21tb24udjEiZQoTTWV0aG9kQXV0aG9yaXphdGlvbhIVCg1yZXNvdXJjZV90eXBlGAEgASgJEhUKDWlkX2dldHRlcl9jZWwYAiABKAkSEgoKcGVybWlzc2lvbhgDIAEoCRIMCgRza2lwGAQgASgIInMKF0NvbGxlY3Rpb25BdXRob3JpemF0aW9uEh0KFWNvbGxlY3Rpb25fZ2V0dGVyX2NlbBgBIAEoCRI5CgRlYWNoGAIgASgLMisucmVkcGFuZGEuYXBpLmNvbW1vbi52MS5NZXRob2RBdXRob3JpemF0aW9uOlAKE3JlcXVpcmVkX3Blcm1pc3Npb24SHi5nb29nbGUucHJvdG9idWYuTWV0aG9kT3B0aW9ucxj3dyADKAlSEnJlcXVpcmVkUGVybWlzc2lvbjp/ChRtZXRob2RfYXV0aG9yaXphdGlvbhIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGPt3IAEoCzIrLnJlZHBhbmRhLmFwaS5jb21tb24udjEuTWV0aG9kQXV0aG9yaXphdGlvblITbWV0aG9kQXV0aG9yaXphdGlvbjqLAQoYY29sbGVjdGlvbl9hdXRob3JpemF0aW9uEh4uZ29vZ2xlLnByb3RvYnVmLk1ldGhvZE9wdGlvbnMY/HcgASgLMi8ucmVkcGFuZGEuYXBpLmNvbW1vbi52MS5Db2xsZWN0aW9uQXV0aG9yaXphdGlvblIXY29sbGVjdGlvbkF1dGhvcml6YXRpb25CWVpXYnVmLmJ1aWxkL2dlbi9nby9yZWRwYW5kYWRhdGEvY29tbW9uL3Byb3RvY29sYnVmZmVycy9nby9yZWRwYW5kYS9hcGkvY29tbW9uL3YxO2NvbW1vbnYxYgZwcm90bzM", [file_google_protobuf_descriptor]); |
15 | 16 |
|
16 | 17 | /** |
| 18 | + * MethodAuthorization defines the authorization requirements for a single-resource RPC. |
| 19 | + * |
| 20 | + * @generated from message redpanda.api.common.v1.MethodAuthorization |
| 21 | + */ |
| 22 | +export type MethodAuthorization = Message<"redpanda.api.common.v1.MethodAuthorization"> & { |
| 23 | + /** |
| 24 | + * resource_type is the type segment appended to the base resource path, |
| 25 | + * e.g. "pipelines", "aiagents", "mcpservers", "knowledgebases". |
| 26 | + * |
| 27 | + * @generated from field: string resource_type = 1; |
| 28 | + */ |
| 29 | + resourceType: string; |
| 30 | + |
| 31 | + /** |
| 32 | + * id_getter_cel is a CEL expression to extract the resource ID from the request. |
| 33 | + * Available variables: |
| 34 | + * - request: the request proto message |
| 35 | + * |
| 36 | + * e.g. "request.id", "request.pipeline.name", "request.name" |
| 37 | + * Empty string means the permission applies at the base resource level |
| 38 | + * (no sub-resource scoping). |
| 39 | + * |
| 40 | + * @generated from field: string id_getter_cel = 2; |
| 41 | + */ |
| 42 | + idGetterCel: string; |
| 43 | + |
| 44 | + /** |
| 45 | + * permission is the permission name to check. |
| 46 | + * |
| 47 | + * e.g. "dataplane_pipeline_create", "dataplane_aiagent_get" |
| 48 | + * |
| 49 | + * @generated from field: string permission = 3; |
| 50 | + */ |
| 51 | + permission: string; |
| 52 | + |
| 53 | + /** |
| 54 | + * skip exempts this method from authorization. The interceptor passes |
| 55 | + * through without any permission check. Use for RPCs that must remain |
| 56 | + * open (e.g. health checks on the same gRPC server). |
| 57 | + * |
| 58 | + * e.g.: |
| 59 | + * option (redpanda.api.common.v1.method_authorization) = { skip: true }; |
| 60 | + * |
| 61 | + * @generated from field: bool skip = 4; |
| 62 | + */ |
| 63 | + skip: boolean; |
| 64 | +}; |
| 65 | + |
| 66 | +/** |
| 67 | + * Describes the message redpanda.api.common.v1.MethodAuthorization. |
| 68 | + * Use `create(MethodAuthorizationSchema)` to create a new message. |
| 69 | + */ |
| 70 | +export const MethodAuthorizationSchema: GenMessage<MethodAuthorization> = /*@__PURE__*/ |
| 71 | + messageDesc(file_redpanda_api_common_v1_options, 0); |
| 72 | + |
| 73 | +/** |
| 74 | + * CollectionAuthorization defines authorization for list RPCs returning collections. |
| 75 | + * |
| 76 | + * @generated from message redpanda.api.common.v1.CollectionAuthorization |
| 77 | + */ |
| 78 | +export type CollectionAuthorization = Message<"redpanda.api.common.v1.CollectionAuthorization"> & { |
| 79 | + /** |
| 80 | + * collection_getter_cel is a CEL expression to extract the collection |
| 81 | + * from the response message. |
| 82 | + * |
| 83 | + * e.g. "response.pipelines", "response.agents" |
| 84 | + * |
| 85 | + * @generated from field: string collection_getter_cel = 1; |
| 86 | + */ |
| 87 | + collectionGetterCel: string; |
| 88 | + |
| 89 | + /** |
| 90 | + * each defines the permission check applied to each element in the collection. |
| 91 | + * |
| 92 | + * @generated from field: redpanda.api.common.v1.MethodAuthorization each = 2; |
| 93 | + */ |
| 94 | + each?: MethodAuthorization; |
| 95 | +}; |
| 96 | + |
| 97 | +/** |
| 98 | + * Describes the message redpanda.api.common.v1.CollectionAuthorization. |
| 99 | + * Use `create(CollectionAuthorizationSchema)` to create a new message. |
| 100 | + */ |
| 101 | +export const CollectionAuthorizationSchema: GenMessage<CollectionAuthorization> = /*@__PURE__*/ |
| 102 | + messageDesc(file_redpanda_api_common_v1_options, 1); |
| 103 | + |
| 104 | +/** |
| 105 | + * required_permission is a simple permission string required to call this method. |
| 106 | + * Use this for methods that don't need per-resource scoping. |
| 107 | + * |
| 108 | + * e.g.: |
| 109 | + * option (redpanda.api.common.v1.required_permission) = "dataplane_pipeline_create"; |
| 110 | + * |
17 | 111 | * @generated from extension: repeated string required_permission = 15351; |
18 | 112 | */ |
19 | 113 | export const required_permission: GenExtension<MethodOptions, string[]> = /*@__PURE__*/ |
20 | 114 | extDesc(file_redpanda_api_common_v1_options, 0); |
21 | 115 |
|
| 116 | +/** |
| 117 | + * method_authorization defines the permission and resource extraction |
| 118 | + * for single-resource RPCs (create, get, update, delete, start, stop). |
| 119 | + * Can also be used to skip authorization entirely via the skip field. |
| 120 | + * |
| 121 | + * When used together with collection_authorization on the same RPC, |
| 122 | + * the interceptor performs BOTH a pre-call permission check (using this |
| 123 | + * annotation) AND post-call per-item filtering (using collection_authorization). |
| 124 | + * |
| 125 | + * e.g.: |
| 126 | + * option (redpanda.api.common.v1.method_authorization) = { |
| 127 | + * resource_type: "pipelines", |
| 128 | + * id_getter_cel: "request.pipeline.id", |
| 129 | + * permission: "dataplane_pipeline_create" |
| 130 | + * }; |
| 131 | + * |
| 132 | + * @generated from extension: redpanda.api.common.v1.MethodAuthorization method_authorization = 15355; |
| 133 | + */ |
| 134 | +export const method_authorization: GenExtension<MethodOptions, MethodAuthorization> = /*@__PURE__*/ |
| 135 | + extDesc(file_redpanda_api_common_v1_options, 1); |
| 136 | + |
| 137 | +/** |
| 138 | + * collection_authorization defines per-item filtering for list RPCs that |
| 139 | + * return collections of resources. After the handler runs, items the |
| 140 | + * principal lacks permission for are removed from the response. |
| 141 | + * |
| 142 | + * When used alone, the pre-call permission check is skipped — the principal |
| 143 | + * may only have permission on specific resources, not at the parent level. |
| 144 | + * When used together with method_authorization, the pre-call check also runs. |
| 145 | + * |
| 146 | + * e.g.: |
| 147 | + * option (redpanda.api.common.v1.collection_authorization) = { |
| 148 | + * collection_getter_cel: "response.pipelines", |
| 149 | + * each: { |
| 150 | + * resource_type: "pipelines", |
| 151 | + * id_getter_cel: "each.id", |
| 152 | + * permission: "dataplane_pipeline_list" |
| 153 | + * } |
| 154 | + * }; |
| 155 | + * |
| 156 | + * @generated from extension: redpanda.api.common.v1.CollectionAuthorization collection_authorization = 15356; |
| 157 | + */ |
| 158 | +export const collection_authorization: GenExtension<MethodOptions, CollectionAuthorization> = /*@__PURE__*/ |
| 159 | + extDesc(file_redpanda_api_common_v1_options, 2); |
| 160 | + |
0 commit comments