@raystack/proton 0.1.0-00c55b6ba2a3f425eca16ca3d36e172952e4824d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (278) hide show
  1. package/README.md +113 -0
  2. package/google/api/annotations_pb.d.ts +34 -0
  3. package/google/api/annotations_pb.js +36 -0
  4. package/google/api/annotations_pb.ts +39 -0
  5. package/google/api/field_behavior_pb.d.ts +134 -0
  6. package/google/api/field_behavior_pb.js +65 -0
  7. package/google/api/field_behavior_pb.ts +139 -0
  8. package/google/api/http_pb.d.ts +477 -0
  9. package/google/api/http_pb.js +47 -0
  10. package/google/api/http_pb.ts +482 -0
  11. package/google/api/httpbody_pb.d.ts +104 -0
  12. package/google/api/httpbody_pb.js +34 -0
  13. package/google/api/httpbody_pb.ts +108 -0
  14. package/index.d.ts +10 -0
  15. package/index.js +10 -0
  16. package/index.ts +10 -0
  17. package/package.json +94 -0
  18. package/protoc-gen-openapiv2/options/annotations_pb.d.ts +63 -0
  19. package/protoc-gen-openapiv2/options/annotations_pb.js +69 -0
  20. package/protoc-gen-openapiv2/options/annotations_pb.ts +72 -0
  21. package/protoc-gen-openapiv2/options/openapiv2_pb.d.ts +1497 -0
  22. package/protoc-gen-openapiv2/options/openapiv2_pb.js +232 -0
  23. package/protoc-gen-openapiv2/options/openapiv2_pb.ts +1525 -0
  24. package/raystack/assets/index.d.ts +29 -0
  25. package/raystack/assets/index.js +29 -0
  26. package/raystack/assets/index.ts +29 -0
  27. package/raystack/assets/v1beta1/bucket_pb.d.ts +180 -0
  28. package/raystack/assets/v1beta1/bucket_pb.js +32 -0
  29. package/raystack/assets/v1beta1/bucket_pb.ts +190 -0
  30. package/raystack/assets/v1beta1/dashboard_pb.d.ts +217 -0
  31. package/raystack/assets/v1beta1/dashboard_pb.js +32 -0
  32. package/raystack/assets/v1beta1/dashboard_pb.ts +227 -0
  33. package/raystack/assets/v1beta1/event_pb.d.ts +52 -0
  34. package/raystack/assets/v1beta1/event_pb.js +20 -0
  35. package/raystack/assets/v1beta1/event_pb.ts +56 -0
  36. package/raystack/assets/v1beta1/group_pb.d.ts +105 -0
  37. package/raystack/assets/v1beta1/group_pb.js +30 -0
  38. package/raystack/assets/v1beta1/group_pb.ts +113 -0
  39. package/raystack/assets/v1beta1/job_pb.d.ts +78 -0
  40. package/raystack/assets/v1beta1/job_pb.js +25 -0
  41. package/raystack/assets/v1beta1/job_pb.ts +87 -0
  42. package/raystack/assets/v1beta1/lineage_pb.d.ts +43 -0
  43. package/raystack/assets/v1beta1/lineage_pb.js +20 -0
  44. package/raystack/assets/v1beta1/lineage_pb.ts +47 -0
  45. package/raystack/assets/v1beta1/ownership_pb.d.ts +78 -0
  46. package/raystack/assets/v1beta1/ownership_pb.js +26 -0
  47. package/raystack/assets/v1beta1/ownership_pb.ts +82 -0
  48. package/raystack/assets/v1beta1/preview_pb.d.ts +41 -0
  49. package/raystack/assets/v1beta1/preview_pb.js +20 -0
  50. package/raystack/assets/v1beta1/preview_pb.ts +45 -0
  51. package/raystack/assets/v1beta1/properties_pb.d.ts +44 -0
  52. package/raystack/assets/v1beta1/properties_pb.js +20 -0
  53. package/raystack/assets/v1beta1/properties_pb.ts +48 -0
  54. package/raystack/assets/v1beta1/resource_pb.d.ts +74 -0
  55. package/raystack/assets/v1beta1/resource_pb.js +19 -0
  56. package/raystack/assets/v1beta1/resource_pb.ts +77 -0
  57. package/raystack/assets/v1beta1/schema_pb.d.ts +169 -0
  58. package/raystack/assets/v1beta1/schema_pb.js +41 -0
  59. package/raystack/assets/v1beta1/schema_pb.ts +176 -0
  60. package/raystack/assets/v1beta1/table_pb.d.ts +192 -0
  61. package/raystack/assets/v1beta1/table_pb.js +41 -0
  62. package/raystack/assets/v1beta1/table_pb.ts +205 -0
  63. package/raystack/assets/v1beta1/timestamp_pb.d.ts +68 -0
  64. package/raystack/assets/v1beta1/timestamp_pb.js +27 -0
  65. package/raystack/assets/v1beta1/timestamp_pb.ts +73 -0
  66. package/raystack/assets/v1beta1/topic_pb.d.ts +125 -0
  67. package/raystack/assets/v1beta1/topic_pb.js +33 -0
  68. package/raystack/assets/v1beta1/topic_pb.ts +136 -0
  69. package/raystack/assets/v1beta1/user_pb.d.ts +216 -0
  70. package/raystack/assets/v1beta1/user_pb.js +37 -0
  71. package/raystack/assets/v1beta1/user_pb.ts +225 -0
  72. package/raystack/assets/v1beta2/application_pb.d.ts +59 -0
  73. package/raystack/assets/v1beta2/application_pb.js +20 -0
  74. package/raystack/assets/v1beta2/application_pb.ts +63 -0
  75. package/raystack/assets/v1beta2/asset_pb.d.ts +129 -0
  76. package/raystack/assets/v1beta2/asset_pb.js +21 -0
  77. package/raystack/assets/v1beta2/asset_pb.ts +134 -0
  78. package/raystack/assets/v1beta2/bucket_pb.d.ts +163 -0
  79. package/raystack/assets/v1beta2/bucket_pb.js +28 -0
  80. package/raystack/assets/v1beta2/bucket_pb.ts +169 -0
  81. package/raystack/assets/v1beta2/common_pb.d.ts +170 -0
  82. package/raystack/assets/v1beta2/common_pb.js +41 -0
  83. package/raystack/assets/v1beta2/common_pb.ts +177 -0
  84. package/raystack/assets/v1beta2/dashboard_pb.d.ts +192 -0
  85. package/raystack/assets/v1beta2/dashboard_pb.js +28 -0
  86. package/raystack/assets/v1beta2/dashboard_pb.ts +198 -0
  87. package/raystack/assets/v1beta2/experiment_pb.d.ts +134 -0
  88. package/raystack/assets/v1beta2/experiment_pb.js +27 -0
  89. package/raystack/assets/v1beta2/experiment_pb.ts +139 -0
  90. package/raystack/assets/v1beta2/feature_table_pb.d.ts +167 -0
  91. package/raystack/assets/v1beta2/feature_table_pb.js +34 -0
  92. package/raystack/assets/v1beta2/feature_table_pb.ts +173 -0
  93. package/raystack/assets/v1beta2/group_pb.d.ts +77 -0
  94. package/raystack/assets/v1beta2/group_pb.js +27 -0
  95. package/raystack/assets/v1beta2/group_pb.ts +82 -0
  96. package/raystack/assets/v1beta2/job_pb.d.ts +47 -0
  97. package/raystack/assets/v1beta2/job_pb.js +20 -0
  98. package/raystack/assets/v1beta2/job_pb.ts +51 -0
  99. package/raystack/assets/v1beta2/metric_pb.d.ts +83 -0
  100. package/raystack/assets/v1beta2/metric_pb.js +20 -0
  101. package/raystack/assets/v1beta2/metric_pb.ts +87 -0
  102. package/raystack/assets/v1beta2/model_pb.d.ts +227 -0
  103. package/raystack/assets/v1beta2/model_pb.js +41 -0
  104. package/raystack/assets/v1beta2/model_pb.ts +234 -0
  105. package/raystack/assets/v1beta2/table_pb.d.ts +283 -0
  106. package/raystack/assets/v1beta2/table_pb.js +48 -0
  107. package/raystack/assets/v1beta2/table_pb.ts +291 -0
  108. package/raystack/assets/v1beta2/topic_pb.d.ts +117 -0
  109. package/raystack/assets/v1beta2/topic_pb.js +34 -0
  110. package/raystack/assets/v1beta2/topic_pb.ts +123 -0
  111. package/raystack/assets/v1beta2/user_pb.d.ts +203 -0
  112. package/raystack/assets/v1beta2/user_pb.js +34 -0
  113. package/raystack/assets/v1beta2/user_pb.ts +209 -0
  114. package/raystack/common/index.d.ts +2 -0
  115. package/raystack/common/index.js +2 -0
  116. package/raystack/common/index.ts +2 -0
  117. package/raystack/common/v1/service-CommonService_connectquery.d.ts +10 -0
  118. package/raystack/common/v1/service-CommonService_connectquery.js +10 -0
  119. package/raystack/common/v1/service-CommonService_connectquery.ts +10 -0
  120. package/raystack/common/v1/service_pb.d.ts +100 -0
  121. package/raystack/common/v1/service_pb.js +42 -0
  122. package/raystack/common/v1/service_pb.ts +109 -0
  123. package/raystack/compass/index.d.ts +2 -0
  124. package/raystack/compass/index.js +2 -0
  125. package/raystack/compass/index.ts +2 -0
  126. package/raystack/compass/v1beta1/service-CompassService_connectquery.d.ts +184 -0
  127. package/raystack/compass/v1beta1/service-CompassService_connectquery.js +225 -0
  128. package/raystack/compass/v1beta1/service-CompassService_connectquery.ts +225 -0
  129. package/raystack/compass/v1beta1/service_pb.d.ts +2994 -0
  130. package/raystack/compass/v1beta1/service_pb.js +745 -0
  131. package/raystack/compass/v1beta1/service_pb.ts +3104 -0
  132. package/raystack/entropy/index.d.ts +4 -0
  133. package/raystack/entropy/index.js +4 -0
  134. package/raystack/entropy/index.ts +4 -0
  135. package/raystack/entropy/v1beta1/module-ModuleService_connectquery.d.ts +26 -0
  136. package/raystack/entropy/v1beta1/module-ModuleService_connectquery.js +30 -0
  137. package/raystack/entropy/v1beta1/module-ModuleService_connectquery.ts +30 -0
  138. package/raystack/entropy/v1beta1/module_pb.d.ts +261 -0
  139. package/raystack/entropy/v1beta1/module_pb.js +97 -0
  140. package/raystack/entropy/v1beta1/module_pb.ts +277 -0
  141. package/raystack/entropy/v1beta1/resource-ResourceService_connectquery.d.ts +34 -0
  142. package/raystack/entropy/v1beta1/resource-ResourceService_connectquery.js +40 -0
  143. package/raystack/entropy/v1beta1/resource-ResourceService_connectquery.ts +40 -0
  144. package/raystack/entropy/v1beta1/resource_pb.d.ts +636 -0
  145. package/raystack/entropy/v1beta1/resource_pb.js +200 -0
  146. package/raystack/entropy/v1beta1/resource_pb.ts +666 -0
  147. package/raystack/frontier/index.d.ts +5 -0
  148. package/raystack/frontier/index.js +5 -0
  149. package/raystack/frontier/index.ts +5 -0
  150. package/raystack/frontier/v1beta1/admin-AdminService_connectquery.d.ts +263 -0
  151. package/raystack/frontier/v1beta1/admin-AdminService_connectquery.js +316 -0
  152. package/raystack/frontier/v1beta1/admin-AdminService_connectquery.ts +316 -0
  153. package/raystack/frontier/v1beta1/admin_pb.d.ts +3550 -0
  154. package/raystack/frontier/v1beta1/admin_pb.js +914 -0
  155. package/raystack/frontier/v1beta1/admin_pb.ts +3687 -0
  156. package/raystack/frontier/v1beta1/frontier-FrontierService_connectquery.d.ts +746 -0
  157. package/raystack/frontier/v1beta1/frontier-FrontierService_connectquery.js +915 -0
  158. package/raystack/frontier/v1beta1/frontier-FrontierService_connectquery.ts +915 -0
  159. package/raystack/frontier/v1beta1/frontier_pb.d.ts +8883 -0
  160. package/raystack/frontier/v1beta1/frontier_pb.js +2635 -0
  161. package/raystack/frontier/v1beta1/frontier_pb.ts +9265 -0
  162. package/raystack/frontier/v1beta1/models_pb.d.ts +2861 -0
  163. package/raystack/frontier/v1beta1/models_pb.js +450 -0
  164. package/raystack/frontier/v1beta1/models_pb.ts +2928 -0
  165. package/raystack/guardian/index.d.ts +2 -0
  166. package/raystack/guardian/index.js +2 -0
  167. package/raystack/guardian/index.ts +2 -0
  168. package/raystack/guardian/v1beta1/guardian-GuardianService_connectquery.d.ts +168 -0
  169. package/raystack/guardian/v1beta1/guardian-GuardianService_connectquery.js +207 -0
  170. package/raystack/guardian/v1beta1/guardian-GuardianService_connectquery.ts +207 -0
  171. package/raystack/guardian/v1beta1/guardian_pb.d.ts +3537 -0
  172. package/raystack/guardian/v1beta1/guardian_pb.js +823 -0
  173. package/raystack/guardian/v1beta1/guardian_pb.ts +3659 -0
  174. package/raystack/optimus/core/v1beta1/backup-BackupService_connectquery.d.ts +18 -0
  175. package/raystack/optimus/core/v1beta1/backup-BackupService_connectquery.js +20 -0
  176. package/raystack/optimus/core/v1beta1/backup-BackupService_connectquery.ts +20 -0
  177. package/raystack/optimus/core/v1beta1/backup_pb.d.ts +256 -0
  178. package/raystack/optimus/core/v1beta1/backup_pb.js +77 -0
  179. package/raystack/optimus/core/v1beta1/backup_pb.ts +270 -0
  180. package/raystack/optimus/core/v1beta1/job_run-JobRunService_connectquery.d.ts +30 -0
  181. package/raystack/optimus/core/v1beta1/job_run-JobRunService_connectquery.js +33 -0
  182. package/raystack/optimus/core/v1beta1/job_run-JobRunService_connectquery.ts +33 -0
  183. package/raystack/optimus/core/v1beta1/job_run_pb.d.ts +410 -0
  184. package/raystack/optimus/core/v1beta1/job_run_pb.js +127 -0
  185. package/raystack/optimus/core/v1beta1/job_run_pb.ts +430 -0
  186. package/raystack/optimus/core/v1beta1/job_spec-JobSpecificationService_connectquery.d.ts +98 -0
  187. package/raystack/optimus/core/v1beta1/job_spec-JobSpecificationService_connectquery.js +112 -0
  188. package/raystack/optimus/core/v1beta1/job_spec-JobSpecificationService_connectquery.ts +112 -0
  189. package/raystack/optimus/core/v1beta1/job_spec_pb.d.ts +1953 -0
  190. package/raystack/optimus/core/v1beta1/job_spec_pb.js +487 -0
  191. package/raystack/optimus/core/v1beta1/job_spec_pb.ts +2025 -0
  192. package/raystack/optimus/core/v1beta1/namespace-NamespaceService_connectquery.d.ts +24 -0
  193. package/raystack/optimus/core/v1beta1/namespace-NamespaceService_connectquery.js +26 -0
  194. package/raystack/optimus/core/v1beta1/namespace-NamespaceService_connectquery.ts +26 -0
  195. package/raystack/optimus/core/v1beta1/namespace_pb.d.ts +180 -0
  196. package/raystack/optimus/core/v1beta1/namespace_pb.js +69 -0
  197. package/raystack/optimus/core/v1beta1/namespace_pb.ts +192 -0
  198. package/raystack/optimus/core/v1beta1/project-ProjectService_connectquery.d.ts +24 -0
  199. package/raystack/optimus/core/v1beta1/project-ProjectService_connectquery.js +26 -0
  200. package/raystack/optimus/core/v1beta1/project-ProjectService_connectquery.ts +26 -0
  201. package/raystack/optimus/core/v1beta1/project_pb.d.ts +166 -0
  202. package/raystack/optimus/core/v1beta1/project_pb.js +69 -0
  203. package/raystack/optimus/core/v1beta1/project_pb.ts +178 -0
  204. package/raystack/optimus/core/v1beta1/replay-ReplayService_connectquery.d.ts +22 -0
  205. package/raystack/optimus/core/v1beta1/replay-ReplayService_connectquery.js +25 -0
  206. package/raystack/optimus/core/v1beta1/replay-ReplayService_connectquery.ts +25 -0
  207. package/raystack/optimus/core/v1beta1/replay_pb.d.ts +331 -0
  208. package/raystack/optimus/core/v1beta1/replay_pb.js +91 -0
  209. package/raystack/optimus/core/v1beta1/replay_pb.ts +347 -0
  210. package/raystack/optimus/core/v1beta1/resource-ResourceService_connectquery.d.ts +43 -0
  211. package/raystack/optimus/core/v1beta1/resource-ResourceService_connectquery.js +48 -0
  212. package/raystack/optimus/core/v1beta1/resource-ResourceService_connectquery.ts +48 -0
  213. package/raystack/optimus/core/v1beta1/resource_pb.d.ts +507 -0
  214. package/raystack/optimus/core/v1beta1/resource_pb.js +134 -0
  215. package/raystack/optimus/core/v1beta1/resource_pb.ts +530 -0
  216. package/raystack/optimus/core/v1beta1/runtime-RuntimeService_connectquery.d.ts +12 -0
  217. package/raystack/optimus/core/v1beta1/runtime-RuntimeService_connectquery.js +12 -0
  218. package/raystack/optimus/core/v1beta1/runtime-RuntimeService_connectquery.ts +12 -0
  219. package/raystack/optimus/core/v1beta1/runtime_pb.d.ts +62 -0
  220. package/raystack/optimus/core/v1beta1/runtime_pb.js +36 -0
  221. package/raystack/optimus/core/v1beta1/runtime_pb.ts +69 -0
  222. package/raystack/optimus/core/v1beta1/secret-SecretService_connectquery.d.ts +30 -0
  223. package/raystack/optimus/core/v1beta1/secret-SecretService_connectquery.js +33 -0
  224. package/raystack/optimus/core/v1beta1/secret-SecretService_connectquery.ts +33 -0
  225. package/raystack/optimus/core/v1beta1/secret_pb.d.ts +250 -0
  226. package/raystack/optimus/core/v1beta1/secret_pb.js +84 -0
  227. package/raystack/optimus/core/v1beta1/secret_pb.ts +265 -0
  228. package/raystack/optimus/core/v1beta1/status_pb.d.ts +78 -0
  229. package/raystack/optimus/core/v1beta1/status_pb.js +31 -0
  230. package/raystack/optimus/core/v1beta1/status_pb.ts +82 -0
  231. package/raystack/optimus/integration/v1beta1/event_pb.d.ts +239 -0
  232. package/raystack/optimus/integration/v1beta1/event_pb.js +62 -0
  233. package/raystack/optimus/integration/v1beta1/event_pb.ts +250 -0
  234. package/raystack/optimus/plugins/v1beta1/dependency_resolver-DependencyResolverModService_connectquery.d.ts +31 -0
  235. package/raystack/optimus/plugins/v1beta1/dependency_resolver-DependencyResolverModService_connectquery.js +34 -0
  236. package/raystack/optimus/plugins/v1beta1/dependency_resolver-DependencyResolverModService_connectquery.ts +34 -0
  237. package/raystack/optimus/plugins/v1beta1/dependency_resolver_pb.d.ts +353 -0
  238. package/raystack/optimus/plugins/v1beta1/dependency_resolver_pb.js +120 -0
  239. package/raystack/optimus/plugins/v1beta1/dependency_resolver_pb.ts +371 -0
  240. package/raystack/predator/index.d.ts +2 -0
  241. package/raystack/predator/index.js +2 -0
  242. package/raystack/predator/index.ts +2 -0
  243. package/raystack/predator/v1beta1/metrics_log_pb.d.ts +163 -0
  244. package/raystack/predator/v1beta1/metrics_log_pb.js +48 -0
  245. package/raystack/predator/v1beta1/metrics_log_pb.ts +171 -0
  246. package/raystack/predator/v1beta1/result_log_pb.d.ts +143 -0
  247. package/raystack/predator/v1beta1/result_log_pb.js +42 -0
  248. package/raystack/predator/v1beta1/result_log_pb.ts +151 -0
  249. package/raystack/raccoon/index.d.ts +2 -0
  250. package/raystack/raccoon/index.js +2 -0
  251. package/raystack/raccoon/index.ts +2 -0
  252. package/raystack/raccoon/v1beta1/raccoon-EventService_connectquery.d.ts +10 -0
  253. package/raystack/raccoon/v1beta1/raccoon-EventService_connectquery.js +10 -0
  254. package/raystack/raccoon/v1beta1/raccoon-EventService_connectquery.ts +10 -0
  255. package/raystack/raccoon/v1beta1/raccoon_pb.d.ts +268 -0
  256. package/raystack/raccoon/v1beta1/raccoon_pb.js +64 -0
  257. package/raystack/raccoon/v1beta1/raccoon_pb.ts +277 -0
  258. package/raystack/siren/index.d.ts +2 -0
  259. package/raystack/siren/index.js +2 -0
  260. package/raystack/siren/index.ts +2 -0
  261. package/raystack/siren/v1beta1/siren-SirenService_connectquery.d.ts +146 -0
  262. package/raystack/siren/v1beta1/siren-SirenService_connectquery.js +180 -0
  263. package/raystack/siren/v1beta1/siren-SirenService_connectquery.ts +180 -0
  264. package/raystack/siren/v1beta1/siren_pb.d.ts +2281 -0
  265. package/raystack/siren/v1beta1/siren_pb.js +603 -0
  266. package/raystack/siren/v1beta1/siren_pb.ts +2371 -0
  267. package/raystack/stencil/index.d.ts +2 -0
  268. package/raystack/stencil/index.js +2 -0
  269. package/raystack/stencil/index.ts +2 -0
  270. package/raystack/stencil/v1beta1/stencil-StencilService_connectquery.d.ts +70 -0
  271. package/raystack/stencil/v1beta1/stencil-StencilService_connectquery.js +85 -0
  272. package/raystack/stencil/v1beta1/stencil-StencilService_connectquery.ts +85 -0
  273. package/raystack/stencil/v1beta1/stencil_pb.d.ts +1057 -0
  274. package/raystack/stencil/v1beta1/stencil_pb.js +298 -0
  275. package/raystack/stencil/v1beta1/stencil_pb.ts +1102 -0
  276. package/validate/validate_pb.d.ts +1953 -0
  277. package/validate/validate_pb.js +223 -0
  278. package/validate/validate_pb.ts +1984 -0
@@ -0,0 +1,1497 @@
1
+ // @generated by protoc-gen-es v2.6.2 with parameter "target=ts+js+dts,import_extension=none"
2
+ // @generated from file protoc-gen-openapiv2/options/openapiv2.proto (package grpc.gateway.protoc_gen_openapiv2.options, syntax proto3)
3
+ /* eslint-disable */
4
+
5
+ import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
6
+ import type { Message } from "@bufbuild/protobuf";
7
+ import type { Value } from "@bufbuild/protobuf/wkt";
8
+
9
+ /**
10
+ * Describes the file protoc-gen-openapiv2/options/openapiv2.proto.
11
+ */
12
+ export declare const file_protoc_gen_openapiv2_options_openapiv2: GenFile;
13
+
14
+ /**
15
+ * `Swagger` is a representation of OpenAPI v2 specification's Swagger object.
16
+ *
17
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject
18
+ *
19
+ * Example:
20
+ *
21
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
22
+ * info: {
23
+ * title: "Echo API";
24
+ * version: "1.0";
25
+ * description: "";
26
+ * contact: {
27
+ * name: "gRPC-Gateway project";
28
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway";
29
+ * email: "none@example.com";
30
+ * };
31
+ * license: {
32
+ * name: "BSD 3-Clause License";
33
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE.txt";
34
+ * };
35
+ * };
36
+ * schemes: HTTPS;
37
+ * consumes: "application/json";
38
+ * produces: "application/json";
39
+ * };
40
+ *
41
+ *
42
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Swagger
43
+ */
44
+ export declare type Swagger = Message<"grpc.gateway.protoc_gen_openapiv2.options.Swagger"> & {
45
+ /**
46
+ * Specifies the OpenAPI Specification version being used. It can be
47
+ * used by the OpenAPI UI and other clients to interpret the API listing. The
48
+ * value MUST be "2.0".
49
+ *
50
+ * @generated from field: string swagger = 1;
51
+ */
52
+ swagger: string;
53
+
54
+ /**
55
+ * Provides metadata about the API. The metadata can be used by the
56
+ * clients if needed.
57
+ *
58
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
59
+ */
60
+ info?: Info;
61
+
62
+ /**
63
+ * The host (name or ip) serving the API. This MUST be the host only and does
64
+ * not include the scheme nor sub-paths. It MAY include a port. If the host is
65
+ * not included, the host serving the documentation is to be used (including
66
+ * the port). The host does not support path templating.
67
+ *
68
+ * @generated from field: string host = 3;
69
+ */
70
+ host: string;
71
+
72
+ /**
73
+ * The base path on which the API is served, which is relative to the host. If
74
+ * it is not included, the API is served directly under the host. The value
75
+ * MUST start with a leading slash (/). The basePath does not support path
76
+ * templating.
77
+ * Note that using `base_path` does not change the endpoint paths that are
78
+ * generated in the resulting OpenAPI file. If you wish to use `base_path`
79
+ * with relatively generated OpenAPI paths, the `base_path` prefix must be
80
+ * manually removed from your `google.api.http` paths and your code changed to
81
+ * serve the API from the `base_path`.
82
+ *
83
+ * @generated from field: string base_path = 4;
84
+ */
85
+ basePath: string;
86
+
87
+ /**
88
+ * The transfer protocol of the API. Values MUST be from the list: "http",
89
+ * "https", "ws", "wss". If the schemes is not included, the default scheme to
90
+ * be used is the one used to access the OpenAPI definition itself.
91
+ *
92
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
93
+ */
94
+ schemes: Scheme[];
95
+
96
+ /**
97
+ * A list of MIME types the APIs can consume. This is global to all APIs but
98
+ * can be overridden on specific API calls. Value MUST be as described under
99
+ * Mime Types.
100
+ *
101
+ * @generated from field: repeated string consumes = 6;
102
+ */
103
+ consumes: string[];
104
+
105
+ /**
106
+ * A list of MIME types the APIs can produce. This is global to all APIs but
107
+ * can be overridden on specific API calls. Value MUST be as described under
108
+ * Mime Types.
109
+ *
110
+ * @generated from field: repeated string produces = 7;
111
+ */
112
+ produces: string[];
113
+
114
+ /**
115
+ * An object to hold responses that can be used across operations. This
116
+ * property does not define global responses for all operations.
117
+ *
118
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
119
+ */
120
+ responses: { [key: string]: Response };
121
+
122
+ /**
123
+ * Security scheme definitions that can be used across the specification.
124
+ *
125
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
126
+ */
127
+ securityDefinitions?: SecurityDefinitions;
128
+
129
+ /**
130
+ * A declaration of which security schemes are applied for the API as a whole.
131
+ * The list of values describes alternative security schemes that can be used
132
+ * (that is, there is a logical OR between the security requirements).
133
+ * Individual operations can override this definition.
134
+ *
135
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
136
+ */
137
+ security: SecurityRequirement[];
138
+
139
+ /**
140
+ * A list of tags for API documentation control. Tags can be used for logical
141
+ * grouping of operations by resources or any other qualifier.
142
+ *
143
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
144
+ */
145
+ tags: Tag[];
146
+
147
+ /**
148
+ * Additional external documentation.
149
+ *
150
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
151
+ */
152
+ externalDocs?: ExternalDocumentation;
153
+
154
+ /**
155
+ * Custom properties that start with "x-" such as "x-foo" used to describe
156
+ * extra functionality that is not covered by the standard OpenAPI Specification.
157
+ * See: https://swagger.io/docs/specification/2-0/swagger-extensions/
158
+ *
159
+ * @generated from field: map<string, google.protobuf.Value> extensions = 15;
160
+ */
161
+ extensions: { [key: string]: Value };
162
+ };
163
+
164
+ /**
165
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Swagger.
166
+ * Use `create(SwaggerSchema)` to create a new message.
167
+ */
168
+ export declare const SwaggerSchema: GenMessage<Swagger>;
169
+
170
+ /**
171
+ * `Operation` is a representation of OpenAPI v2 specification's Operation object.
172
+ *
173
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject
174
+ *
175
+ * Example:
176
+ *
177
+ * service EchoService {
178
+ * rpc Echo(SimpleMessage) returns (SimpleMessage) {
179
+ * option (google.api.http) = {
180
+ * get: "/v1/example/echo/{id}"
181
+ * };
182
+ *
183
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
184
+ * summary: "Get a message.";
185
+ * operation_id: "getMessage";
186
+ * tags: "echo";
187
+ * responses: {
188
+ * key: "200"
189
+ * value: {
190
+ * description: "OK";
191
+ * }
192
+ * }
193
+ * };
194
+ * }
195
+ * }
196
+ *
197
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Operation
198
+ */
199
+ export declare type Operation = Message<"grpc.gateway.protoc_gen_openapiv2.options.Operation"> & {
200
+ /**
201
+ * A list of tags for API documentation control. Tags can be used for logical
202
+ * grouping of operations by resources or any other qualifier.
203
+ *
204
+ * @generated from field: repeated string tags = 1;
205
+ */
206
+ tags: string[];
207
+
208
+ /**
209
+ * A short summary of what the operation does. For maximum readability in the
210
+ * swagger-ui, this field SHOULD be less than 120 characters.
211
+ *
212
+ * @generated from field: string summary = 2;
213
+ */
214
+ summary: string;
215
+
216
+ /**
217
+ * A verbose explanation of the operation behavior. GFM syntax can be used for
218
+ * rich text representation.
219
+ *
220
+ * @generated from field: string description = 3;
221
+ */
222
+ description: string;
223
+
224
+ /**
225
+ * Additional external documentation for this operation.
226
+ *
227
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;
228
+ */
229
+ externalDocs?: ExternalDocumentation;
230
+
231
+ /**
232
+ * Unique string used to identify the operation. The id MUST be unique among
233
+ * all operations described in the API. Tools and libraries MAY use the
234
+ * operationId to uniquely identify an operation, therefore, it is recommended
235
+ * to follow common programming naming conventions.
236
+ *
237
+ * @generated from field: string operation_id = 5;
238
+ */
239
+ operationId: string;
240
+
241
+ /**
242
+ * A list of MIME types the operation can consume. This overrides the consumes
243
+ * definition at the OpenAPI Object. An empty value MAY be used to clear the
244
+ * global definition. Value MUST be as described under Mime Types.
245
+ *
246
+ * @generated from field: repeated string consumes = 6;
247
+ */
248
+ consumes: string[];
249
+
250
+ /**
251
+ * A list of MIME types the operation can produce. This overrides the produces
252
+ * definition at the OpenAPI Object. An empty value MAY be used to clear the
253
+ * global definition. Value MUST be as described under Mime Types.
254
+ *
255
+ * @generated from field: repeated string produces = 7;
256
+ */
257
+ produces: string[];
258
+
259
+ /**
260
+ * The list of possible responses as they are returned from executing this
261
+ * operation.
262
+ *
263
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;
264
+ */
265
+ responses: { [key: string]: Response };
266
+
267
+ /**
268
+ * The transfer protocol for the operation. Values MUST be from the list:
269
+ * "http", "https", "ws", "wss". The value overrides the OpenAPI Object
270
+ * schemes definition.
271
+ *
272
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;
273
+ */
274
+ schemes: Scheme[];
275
+
276
+ /**
277
+ * Declares this operation to be deprecated. Usage of the declared operation
278
+ * should be refrained. Default value is false.
279
+ *
280
+ * @generated from field: bool deprecated = 11;
281
+ */
282
+ deprecated: boolean;
283
+
284
+ /**
285
+ * A declaration of which security schemes are applied for this operation. The
286
+ * list of values describes alternative security schemes that can be used
287
+ * (that is, there is a logical OR between the security requirements). This
288
+ * definition overrides any declared top-level security. To remove a top-level
289
+ * security declaration, an empty array can be used.
290
+ *
291
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
292
+ */
293
+ security: SecurityRequirement[];
294
+
295
+ /**
296
+ * Custom properties that start with "x-" such as "x-foo" used to describe
297
+ * extra functionality that is not covered by the standard OpenAPI Specification.
298
+ * See: https://swagger.io/docs/specification/2-0/swagger-extensions/
299
+ *
300
+ * @generated from field: map<string, google.protobuf.Value> extensions = 13;
301
+ */
302
+ extensions: { [key: string]: Value };
303
+
304
+ /**
305
+ * Custom parameters such as HTTP request headers.
306
+ * See: https://swagger.io/docs/specification/2-0/describing-parameters/
307
+ * and https://swagger.io/specification/v2/#parameter-object.
308
+ *
309
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14;
310
+ */
311
+ parameters?: Parameters;
312
+ };
313
+
314
+ /**
315
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Operation.
316
+ * Use `create(OperationSchema)` to create a new message.
317
+ */
318
+ export declare const OperationSchema: GenMessage<Operation>;
319
+
320
+ /**
321
+ * `Parameters` is a representation of OpenAPI v2 specification's parameters object.
322
+ * Note: This technically breaks compatibility with the OpenAPI 2 definition structure as we only
323
+ * allow header parameters to be set here since we do not want users specifying custom non-header
324
+ * parameters beyond those inferred from the Protobuf schema.
325
+ * See: https://swagger.io/specification/v2/#parameter-object
326
+ *
327
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Parameters
328
+ */
329
+ export declare type Parameters = Message<"grpc.gateway.protoc_gen_openapiv2.options.Parameters"> & {
330
+ /**
331
+ * `Headers` is one or more HTTP header parameter.
332
+ * See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
333
+ *
334
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1;
335
+ */
336
+ headers: HeaderParameter[];
337
+ };
338
+
339
+ /**
340
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Parameters.
341
+ * Use `create(ParametersSchema)` to create a new message.
342
+ */
343
+ export declare const ParametersSchema: GenMessage<Parameters>;
344
+
345
+ /**
346
+ * `HeaderParameter` a HTTP header parameter.
347
+ * See: https://swagger.io/specification/v2/#parameter-object
348
+ *
349
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter
350
+ */
351
+ export declare type HeaderParameter = Message<"grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter"> & {
352
+ /**
353
+ * `Name` is the header name.
354
+ *
355
+ * @generated from field: string name = 1;
356
+ */
357
+ name: string;
358
+
359
+ /**
360
+ * `Description` is a short description of the header.
361
+ *
362
+ * @generated from field: string description = 2;
363
+ */
364
+ description: string;
365
+
366
+ /**
367
+ * `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
368
+ * See: https://swagger.io/specification/v2/#parameterType.
369
+ *
370
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3;
371
+ */
372
+ type: HeaderParameter_Type;
373
+
374
+ /**
375
+ * `Format` The extending format for the previously mentioned type.
376
+ *
377
+ * @generated from field: string format = 4;
378
+ */
379
+ format: string;
380
+
381
+ /**
382
+ * `Required` indicates if the header is optional
383
+ *
384
+ * @generated from field: bool required = 5;
385
+ */
386
+ required: boolean;
387
+ };
388
+
389
+ /**
390
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.
391
+ * Use `create(HeaderParameterSchema)` to create a new message.
392
+ */
393
+ export declare const HeaderParameterSchema: GenMessage<HeaderParameter>;
394
+
395
+ /**
396
+ * `Type` is a a supported HTTP header type.
397
+ * See https://swagger.io/specification/v2/#parameterType.
398
+ *
399
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type
400
+ */
401
+ export enum HeaderParameter_Type {
402
+ /**
403
+ * @generated from enum value: UNKNOWN = 0;
404
+ */
405
+ UNKNOWN = 0,
406
+
407
+ /**
408
+ * @generated from enum value: STRING = 1;
409
+ */
410
+ STRING = 1,
411
+
412
+ /**
413
+ * @generated from enum value: NUMBER = 2;
414
+ */
415
+ NUMBER = 2,
416
+
417
+ /**
418
+ * @generated from enum value: INTEGER = 3;
419
+ */
420
+ INTEGER = 3,
421
+
422
+ /**
423
+ * @generated from enum value: BOOLEAN = 4;
424
+ */
425
+ BOOLEAN = 4,
426
+ }
427
+
428
+ /**
429
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type.
430
+ */
431
+ export declare const HeaderParameter_TypeSchema: GenEnum<HeaderParameter_Type>;
432
+
433
+ /**
434
+ * `Header` is a representation of OpenAPI v2 specification's Header object.
435
+ *
436
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject
437
+ *
438
+ *
439
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Header
440
+ */
441
+ export declare type Header = Message<"grpc.gateway.protoc_gen_openapiv2.options.Header"> & {
442
+ /**
443
+ * `Description` is a short description of the header.
444
+ *
445
+ * @generated from field: string description = 1;
446
+ */
447
+ description: string;
448
+
449
+ /**
450
+ * The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
451
+ *
452
+ * @generated from field: string type = 2;
453
+ */
454
+ type: string;
455
+
456
+ /**
457
+ * `Format` The extending format for the previously mentioned type.
458
+ *
459
+ * @generated from field: string format = 3;
460
+ */
461
+ format: string;
462
+
463
+ /**
464
+ * `Default` Declares the value of the header that the server will use if none is provided.
465
+ * See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
466
+ * Unlike JSON Schema this value MUST conform to the defined type for the header.
467
+ *
468
+ * @generated from field: string default = 6;
469
+ */
470
+ default: string;
471
+
472
+ /**
473
+ * 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
474
+ *
475
+ * @generated from field: string pattern = 13;
476
+ */
477
+ pattern: string;
478
+ };
479
+
480
+ /**
481
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Header.
482
+ * Use `create(HeaderSchema)` to create a new message.
483
+ */
484
+ export declare const HeaderSchema: GenMessage<Header>;
485
+
486
+ /**
487
+ * `Response` is a representation of OpenAPI v2 specification's Response object.
488
+ *
489
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject
490
+ *
491
+ *
492
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Response
493
+ */
494
+ export declare type Response = Message<"grpc.gateway.protoc_gen_openapiv2.options.Response"> & {
495
+ /**
496
+ * `Description` is a short description of the response.
497
+ * GFM syntax can be used for rich text representation.
498
+ *
499
+ * @generated from field: string description = 1;
500
+ */
501
+ description: string;
502
+
503
+ /**
504
+ * `Schema` optionally defines the structure of the response.
505
+ * If `Schema` is not provided, it means there is no content to the response.
506
+ *
507
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
508
+ */
509
+ schema?: Schema;
510
+
511
+ /**
512
+ * `Headers` A list of headers that are sent with the response.
513
+ * `Header` name is expected to be a string in the canonical format of the MIME header key
514
+ * See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
515
+ *
516
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
517
+ */
518
+ headers: { [key: string]: Header };
519
+
520
+ /**
521
+ * `Examples` gives per-mimetype response examples.
522
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
523
+ *
524
+ * @generated from field: map<string, string> examples = 4;
525
+ */
526
+ examples: { [key: string]: string };
527
+
528
+ /**
529
+ * Custom properties that start with "x-" such as "x-foo" used to describe
530
+ * extra functionality that is not covered by the standard OpenAPI Specification.
531
+ * See: https://swagger.io/docs/specification/2-0/swagger-extensions/
532
+ *
533
+ * @generated from field: map<string, google.protobuf.Value> extensions = 5;
534
+ */
535
+ extensions: { [key: string]: Value };
536
+ };
537
+
538
+ /**
539
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Response.
540
+ * Use `create(ResponseSchema)` to create a new message.
541
+ */
542
+ export declare const ResponseSchema: GenMessage<Response>;
543
+
544
+ /**
545
+ * `Info` is a representation of OpenAPI v2 specification's Info object.
546
+ *
547
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject
548
+ *
549
+ * Example:
550
+ *
551
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
552
+ * info: {
553
+ * title: "Echo API";
554
+ * version: "1.0";
555
+ * description: "";
556
+ * contact: {
557
+ * name: "gRPC-Gateway project";
558
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway";
559
+ * email: "none@example.com";
560
+ * };
561
+ * license: {
562
+ * name: "BSD 3-Clause License";
563
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE.txt";
564
+ * };
565
+ * };
566
+ * ...
567
+ * };
568
+ *
569
+ *
570
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Info
571
+ */
572
+ export declare type Info = Message<"grpc.gateway.protoc_gen_openapiv2.options.Info"> & {
573
+ /**
574
+ * The title of the application.
575
+ *
576
+ * @generated from field: string title = 1;
577
+ */
578
+ title: string;
579
+
580
+ /**
581
+ * A short description of the application. GFM syntax can be used for rich
582
+ * text representation.
583
+ *
584
+ * @generated from field: string description = 2;
585
+ */
586
+ description: string;
587
+
588
+ /**
589
+ * The Terms of Service for the API.
590
+ *
591
+ * @generated from field: string terms_of_service = 3;
592
+ */
593
+ termsOfService: string;
594
+
595
+ /**
596
+ * The contact information for the exposed API.
597
+ *
598
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;
599
+ */
600
+ contact?: Contact;
601
+
602
+ /**
603
+ * The license information for the exposed API.
604
+ *
605
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.License license = 5;
606
+ */
607
+ license?: License;
608
+
609
+ /**
610
+ * Provides the version of the application API (not to be confused
611
+ * with the specification version).
612
+ *
613
+ * @generated from field: string version = 6;
614
+ */
615
+ version: string;
616
+
617
+ /**
618
+ * Custom properties that start with "x-" such as "x-foo" used to describe
619
+ * extra functionality that is not covered by the standard OpenAPI Specification.
620
+ * See: https://swagger.io/docs/specification/2-0/swagger-extensions/
621
+ *
622
+ * @generated from field: map<string, google.protobuf.Value> extensions = 7;
623
+ */
624
+ extensions: { [key: string]: Value };
625
+ };
626
+
627
+ /**
628
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Info.
629
+ * Use `create(InfoSchema)` to create a new message.
630
+ */
631
+ export declare const InfoSchema: GenMessage<Info>;
632
+
633
+ /**
634
+ * `Contact` is a representation of OpenAPI v2 specification's Contact object.
635
+ *
636
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#contactObject
637
+ *
638
+ * Example:
639
+ *
640
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
641
+ * info: {
642
+ * ...
643
+ * contact: {
644
+ * name: "gRPC-Gateway project";
645
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway";
646
+ * email: "none@example.com";
647
+ * };
648
+ * ...
649
+ * };
650
+ * ...
651
+ * };
652
+ *
653
+ *
654
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Contact
655
+ */
656
+ export declare type Contact = Message<"grpc.gateway.protoc_gen_openapiv2.options.Contact"> & {
657
+ /**
658
+ * The identifying name of the contact person/organization.
659
+ *
660
+ * @generated from field: string name = 1;
661
+ */
662
+ name: string;
663
+
664
+ /**
665
+ * The URL pointing to the contact information. MUST be in the format of a
666
+ * URL.
667
+ *
668
+ * @generated from field: string url = 2;
669
+ */
670
+ url: string;
671
+
672
+ /**
673
+ * The email address of the contact person/organization. MUST be in the format
674
+ * of an email address.
675
+ *
676
+ * @generated from field: string email = 3;
677
+ */
678
+ email: string;
679
+ };
680
+
681
+ /**
682
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Contact.
683
+ * Use `create(ContactSchema)` to create a new message.
684
+ */
685
+ export declare const ContactSchema: GenMessage<Contact>;
686
+
687
+ /**
688
+ * `License` is a representation of OpenAPI v2 specification's License object.
689
+ *
690
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#licenseObject
691
+ *
692
+ * Example:
693
+ *
694
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
695
+ * info: {
696
+ * ...
697
+ * license: {
698
+ * name: "BSD 3-Clause License";
699
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE.txt";
700
+ * };
701
+ * ...
702
+ * };
703
+ * ...
704
+ * };
705
+ *
706
+ *
707
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.License
708
+ */
709
+ export declare type License = Message<"grpc.gateway.protoc_gen_openapiv2.options.License"> & {
710
+ /**
711
+ * The license name used for the API.
712
+ *
713
+ * @generated from field: string name = 1;
714
+ */
715
+ name: string;
716
+
717
+ /**
718
+ * A URL to the license used for the API. MUST be in the format of a URL.
719
+ *
720
+ * @generated from field: string url = 2;
721
+ */
722
+ url: string;
723
+ };
724
+
725
+ /**
726
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.License.
727
+ * Use `create(LicenseSchema)` to create a new message.
728
+ */
729
+ export declare const LicenseSchema: GenMessage<License>;
730
+
731
+ /**
732
+ * `ExternalDocumentation` is a representation of OpenAPI v2 specification's
733
+ * ExternalDocumentation object.
734
+ *
735
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject
736
+ *
737
+ * Example:
738
+ *
739
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
740
+ * ...
741
+ * external_docs: {
742
+ * description: "More about gRPC-Gateway";
743
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway";
744
+ * }
745
+ * ...
746
+ * };
747
+ *
748
+ *
749
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation
750
+ */
751
+ export declare type ExternalDocumentation = Message<"grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation"> & {
752
+ /**
753
+ * A short description of the target documentation. GFM syntax can be used for
754
+ * rich text representation.
755
+ *
756
+ * @generated from field: string description = 1;
757
+ */
758
+ description: string;
759
+
760
+ /**
761
+ * The URL for the target documentation. Value MUST be in the format
762
+ * of a URL.
763
+ *
764
+ * @generated from field: string url = 2;
765
+ */
766
+ url: string;
767
+ };
768
+
769
+ /**
770
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation.
771
+ * Use `create(ExternalDocumentationSchema)` to create a new message.
772
+ */
773
+ export declare const ExternalDocumentationSchema: GenMessage<ExternalDocumentation>;
774
+
775
+ /**
776
+ * `Schema` is a representation of OpenAPI v2 specification's Schema object.
777
+ *
778
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
779
+ *
780
+ *
781
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Schema
782
+ */
783
+ export declare type Schema = Message<"grpc.gateway.protoc_gen_openapiv2.options.Schema"> & {
784
+ /**
785
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;
786
+ */
787
+ jsonSchema?: JSONSchema;
788
+
789
+ /**
790
+ * Adds support for polymorphism. The discriminator is the schema property
791
+ * name that is used to differentiate between other schema that inherit this
792
+ * schema. The property name used MUST be defined at this schema and it MUST
793
+ * be in the required property list. When used, the value MUST be the name of
794
+ * this schema or any schema that inherits it.
795
+ *
796
+ * @generated from field: string discriminator = 2;
797
+ */
798
+ discriminator: string;
799
+
800
+ /**
801
+ * Relevant only for Schema "properties" definitions. Declares the property as
802
+ * "read only". This means that it MAY be sent as part of a response but MUST
803
+ * NOT be sent as part of the request. Properties marked as readOnly being
804
+ * true SHOULD NOT be in the required list of the defined schema. Default
805
+ * value is false.
806
+ *
807
+ * @generated from field: bool read_only = 3;
808
+ */
809
+ readOnly: boolean;
810
+
811
+ /**
812
+ * Additional external documentation for this schema.
813
+ *
814
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5;
815
+ */
816
+ externalDocs?: ExternalDocumentation;
817
+
818
+ /**
819
+ * A free-form property to include an example of an instance for this schema in JSON.
820
+ * This is copied verbatim to the output.
821
+ *
822
+ * @generated from field: string example = 6;
823
+ */
824
+ example: string;
825
+ };
826
+
827
+ /**
828
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Schema.
829
+ * Use `create(SchemaSchema)` to create a new message.
830
+ */
831
+ export declare const SchemaSchema: GenMessage<Schema>;
832
+
833
+ /**
834
+ * `JSONSchema` represents properties from JSON Schema taken, and as used, in
835
+ * the OpenAPI v2 spec.
836
+ *
837
+ * This includes changes made by OpenAPI v2.
838
+ *
839
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
840
+ *
841
+ * See also: https://cswr.github.io/JsonSchema/spec/basic_types/,
842
+ * https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json
843
+ *
844
+ * Example:
845
+ *
846
+ * message SimpleMessage {
847
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
848
+ * json_schema: {
849
+ * title: "SimpleMessage"
850
+ * description: "A simple message."
851
+ * required: ["id"]
852
+ * }
853
+ * };
854
+ *
855
+ * // Id represents the message identifier.
856
+ * string id = 1; [
857
+ * (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
858
+ * description: "The unique identifier of the simple message."
859
+ * }];
860
+ * }
861
+ *
862
+ *
863
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema
864
+ */
865
+ export declare type JSONSchema = Message<"grpc.gateway.protoc_gen_openapiv2.options.JSONSchema"> & {
866
+ /**
867
+ * Ref is used to define an external reference to include in the message.
868
+ * This could be a fully qualified proto message reference, and that type must
869
+ * be imported into the protofile. If no message is identified, the Ref will
870
+ * be used verbatim in the output.
871
+ * For example:
872
+ * `ref: ".google.protobuf.Timestamp"`.
873
+ *
874
+ * @generated from field: string ref = 3;
875
+ */
876
+ ref: string;
877
+
878
+ /**
879
+ * The title of the schema.
880
+ *
881
+ * @generated from field: string title = 5;
882
+ */
883
+ title: string;
884
+
885
+ /**
886
+ * A short description of the schema.
887
+ *
888
+ * @generated from field: string description = 6;
889
+ */
890
+ description: string;
891
+
892
+ /**
893
+ * @generated from field: string default = 7;
894
+ */
895
+ default: string;
896
+
897
+ /**
898
+ * @generated from field: bool read_only = 8;
899
+ */
900
+ readOnly: boolean;
901
+
902
+ /**
903
+ * A free-form property to include a JSON example of this field. This is copied
904
+ * verbatim to the output swagger.json. Quotes must be escaped.
905
+ * This property is the same for 2.0 and 3.0.0 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/3.0.0.md#schemaObject https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
906
+ *
907
+ * @generated from field: string example = 9;
908
+ */
909
+ example: string;
910
+
911
+ /**
912
+ * @generated from field: double multiple_of = 10;
913
+ */
914
+ multipleOf: number;
915
+
916
+ /**
917
+ * Maximum represents an inclusive upper limit for a numeric instance. The
918
+ * value of MUST be a number,
919
+ *
920
+ * @generated from field: double maximum = 11;
921
+ */
922
+ maximum: number;
923
+
924
+ /**
925
+ * @generated from field: bool exclusive_maximum = 12;
926
+ */
927
+ exclusiveMaximum: boolean;
928
+
929
+ /**
930
+ * minimum represents an inclusive lower limit for a numeric instance. The
931
+ * value of MUST be a number,
932
+ *
933
+ * @generated from field: double minimum = 13;
934
+ */
935
+ minimum: number;
936
+
937
+ /**
938
+ * @generated from field: bool exclusive_minimum = 14;
939
+ */
940
+ exclusiveMinimum: boolean;
941
+
942
+ /**
943
+ * @generated from field: uint64 max_length = 15;
944
+ */
945
+ maxLength: bigint;
946
+
947
+ /**
948
+ * @generated from field: uint64 min_length = 16;
949
+ */
950
+ minLength: bigint;
951
+
952
+ /**
953
+ * @generated from field: string pattern = 17;
954
+ */
955
+ pattern: string;
956
+
957
+ /**
958
+ * @generated from field: uint64 max_items = 20;
959
+ */
960
+ maxItems: bigint;
961
+
962
+ /**
963
+ * @generated from field: uint64 min_items = 21;
964
+ */
965
+ minItems: bigint;
966
+
967
+ /**
968
+ * @generated from field: bool unique_items = 22;
969
+ */
970
+ uniqueItems: boolean;
971
+
972
+ /**
973
+ * @generated from field: uint64 max_properties = 24;
974
+ */
975
+ maxProperties: bigint;
976
+
977
+ /**
978
+ * @generated from field: uint64 min_properties = 25;
979
+ */
980
+ minProperties: bigint;
981
+
982
+ /**
983
+ * @generated from field: repeated string required = 26;
984
+ */
985
+ required: string[];
986
+
987
+ /**
988
+ * Items in 'array' must be unique.
989
+ *
990
+ * @generated from field: repeated string array = 34;
991
+ */
992
+ array: string[];
993
+
994
+ /**
995
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
996
+ */
997
+ type: JSONSchema_JSONSchemaSimpleTypes[];
998
+
999
+ /**
1000
+ * `Format`
1001
+ *
1002
+ * @generated from field: string format = 36;
1003
+ */
1004
+ format: string;
1005
+
1006
+ /**
1007
+ * Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
1008
+ *
1009
+ * @generated from field: repeated string enum = 46;
1010
+ */
1011
+ enum: string[];
1012
+
1013
+ /**
1014
+ * Additional field level properties used when generating the OpenAPI v2 file.
1015
+ *
1016
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;
1017
+ */
1018
+ fieldConfiguration?: JSONSchema_FieldConfiguration;
1019
+
1020
+ /**
1021
+ * Custom properties that start with "x-" such as "x-foo" used to describe
1022
+ * extra functionality that is not covered by the standard OpenAPI Specification.
1023
+ * See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1024
+ *
1025
+ * @generated from field: map<string, google.protobuf.Value> extensions = 48;
1026
+ */
1027
+ extensions: { [key: string]: Value };
1028
+ };
1029
+
1030
+ /**
1031
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.
1032
+ * Use `create(JSONSchemaSchema)` to create a new message.
1033
+ */
1034
+ export declare const JSONSchemaSchema: GenMessage<JSONSchema>;
1035
+
1036
+ /**
1037
+ * 'FieldConfiguration' provides additional field level properties used when generating the OpenAPI v2 file.
1038
+ * These properties are not defined by OpenAPIv2, but they are used to control the generation.
1039
+ *
1040
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration
1041
+ */
1042
+ export declare type JSONSchema_FieldConfiguration = Message<"grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration"> & {
1043
+ /**
1044
+ * Alternative parameter name when used as path parameter. If set, this will
1045
+ * be used as the complete parameter name when this field is used as a path
1046
+ * parameter. Use this to avoid having auto generated path parameter names
1047
+ * for overlapping paths.
1048
+ *
1049
+ * @generated from field: string path_param_name = 47;
1050
+ */
1051
+ pathParamName: string;
1052
+ };
1053
+
1054
+ /**
1055
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration.
1056
+ * Use `create(JSONSchema_FieldConfigurationSchema)` to create a new message.
1057
+ */
1058
+ export declare const JSONSchema_FieldConfigurationSchema: GenMessage<JSONSchema_FieldConfiguration>;
1059
+
1060
+ /**
1061
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes
1062
+ */
1063
+ export enum JSONSchema_JSONSchemaSimpleTypes {
1064
+ /**
1065
+ * @generated from enum value: UNKNOWN = 0;
1066
+ */
1067
+ UNKNOWN = 0,
1068
+
1069
+ /**
1070
+ * @generated from enum value: ARRAY = 1;
1071
+ */
1072
+ ARRAY = 1,
1073
+
1074
+ /**
1075
+ * @generated from enum value: BOOLEAN = 2;
1076
+ */
1077
+ BOOLEAN = 2,
1078
+
1079
+ /**
1080
+ * @generated from enum value: INTEGER = 3;
1081
+ */
1082
+ INTEGER = 3,
1083
+
1084
+ /**
1085
+ * @generated from enum value: NULL = 4;
1086
+ */
1087
+ NULL = 4,
1088
+
1089
+ /**
1090
+ * @generated from enum value: NUMBER = 5;
1091
+ */
1092
+ NUMBER = 5,
1093
+
1094
+ /**
1095
+ * @generated from enum value: OBJECT = 6;
1096
+ */
1097
+ OBJECT = 6,
1098
+
1099
+ /**
1100
+ * @generated from enum value: STRING = 7;
1101
+ */
1102
+ STRING = 7,
1103
+ }
1104
+
1105
+ /**
1106
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes.
1107
+ */
1108
+ export declare const JSONSchema_JSONSchemaSimpleTypesSchema: GenEnum<JSONSchema_JSONSchemaSimpleTypes>;
1109
+
1110
+ /**
1111
+ * `Tag` is a representation of OpenAPI v2 specification's Tag object.
1112
+ *
1113
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject
1114
+ *
1115
+ *
1116
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Tag
1117
+ */
1118
+ export declare type Tag = Message<"grpc.gateway.protoc_gen_openapiv2.options.Tag"> & {
1119
+ /**
1120
+ * The name of the tag. Use it to allow override of the name of a
1121
+ * global Tag object, then use that name to reference the tag throughout the
1122
+ * OpenAPI file.
1123
+ *
1124
+ * @generated from field: string name = 1;
1125
+ */
1126
+ name: string;
1127
+
1128
+ /**
1129
+ * A short description for the tag. GFM syntax can be used for rich text
1130
+ * representation.
1131
+ *
1132
+ * @generated from field: string description = 2;
1133
+ */
1134
+ description: string;
1135
+
1136
+ /**
1137
+ * Additional external documentation for this tag.
1138
+ *
1139
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;
1140
+ */
1141
+ externalDocs?: ExternalDocumentation;
1142
+
1143
+ /**
1144
+ * Custom properties that start with "x-" such as "x-foo" used to describe
1145
+ * extra functionality that is not covered by the standard OpenAPI Specification.
1146
+ * See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1147
+ *
1148
+ * @generated from field: map<string, google.protobuf.Value> extensions = 4;
1149
+ */
1150
+ extensions: { [key: string]: Value };
1151
+ };
1152
+
1153
+ /**
1154
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Tag.
1155
+ * Use `create(TagSchema)` to create a new message.
1156
+ */
1157
+ export declare const TagSchema: GenMessage<Tag>;
1158
+
1159
+ /**
1160
+ * `SecurityDefinitions` is a representation of OpenAPI v2 specification's
1161
+ * Security Definitions object.
1162
+ *
1163
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityDefinitionsObject
1164
+ *
1165
+ * A declaration of the security schemes available to be used in the
1166
+ * specification. This does not enforce the security schemes on the operations
1167
+ * and only serves to provide the relevant details for each scheme.
1168
+ *
1169
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions
1170
+ */
1171
+ export declare type SecurityDefinitions = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions"> & {
1172
+ /**
1173
+ * A single security scheme definition, mapping a "name" to the scheme it
1174
+ * defines.
1175
+ *
1176
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme> security = 1;
1177
+ */
1178
+ security: { [key: string]: SecurityScheme };
1179
+ };
1180
+
1181
+ /**
1182
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions.
1183
+ * Use `create(SecurityDefinitionsSchema)` to create a new message.
1184
+ */
1185
+ export declare const SecurityDefinitionsSchema: GenMessage<SecurityDefinitions>;
1186
+
1187
+ /**
1188
+ * `SecurityScheme` is a representation of OpenAPI v2 specification's
1189
+ * Security Scheme object.
1190
+ *
1191
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject
1192
+ *
1193
+ * Allows the definition of a security scheme that can be used by the
1194
+ * operations. Supported schemes are basic authentication, an API key (either as
1195
+ * a header or as a query parameter) and OAuth2's common flows (implicit,
1196
+ * password, application and access code).
1197
+ *
1198
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme
1199
+ */
1200
+ export declare type SecurityScheme = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme"> & {
1201
+ /**
1202
+ * The type of the security scheme. Valid values are "basic",
1203
+ * "apiKey" or "oauth2".
1204
+ *
1205
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type type = 1;
1206
+ */
1207
+ type: SecurityScheme_Type;
1208
+
1209
+ /**
1210
+ * A short description for security scheme.
1211
+ *
1212
+ * @generated from field: string description = 2;
1213
+ */
1214
+ description: string;
1215
+
1216
+ /**
1217
+ * The name of the header or query parameter to be used.
1218
+ * Valid for apiKey.
1219
+ *
1220
+ * @generated from field: string name = 3;
1221
+ */
1222
+ name: string;
1223
+
1224
+ /**
1225
+ * The location of the API key. Valid values are "query" or
1226
+ * "header".
1227
+ * Valid for apiKey.
1228
+ *
1229
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In in = 4;
1230
+ */
1231
+ in: SecurityScheme_In;
1232
+
1233
+ /**
1234
+ * The flow used by the OAuth2 security scheme. Valid values are
1235
+ * "implicit", "password", "application" or "accessCode".
1236
+ * Valid for oauth2.
1237
+ *
1238
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow flow = 5;
1239
+ */
1240
+ flow: SecurityScheme_Flow;
1241
+
1242
+ /**
1243
+ * The authorization URL to be used for this flow. This SHOULD be in
1244
+ * the form of a URL.
1245
+ * Valid for oauth2/implicit and oauth2/accessCode.
1246
+ *
1247
+ * @generated from field: string authorization_url = 6;
1248
+ */
1249
+ authorizationUrl: string;
1250
+
1251
+ /**
1252
+ * The token URL to be used for this flow. This SHOULD be in the
1253
+ * form of a URL.
1254
+ * Valid for oauth2/password, oauth2/application and oauth2/accessCode.
1255
+ *
1256
+ * @generated from field: string token_url = 7;
1257
+ */
1258
+ tokenUrl: string;
1259
+
1260
+ /**
1261
+ * The available scopes for the OAuth2 security scheme.
1262
+ * Valid for oauth2.
1263
+ *
1264
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;
1265
+ */
1266
+ scopes?: Scopes;
1267
+
1268
+ /**
1269
+ * Custom properties that start with "x-" such as "x-foo" used to describe
1270
+ * extra functionality that is not covered by the standard OpenAPI Specification.
1271
+ * See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1272
+ *
1273
+ * @generated from field: map<string, google.protobuf.Value> extensions = 9;
1274
+ */
1275
+ extensions: { [key: string]: Value };
1276
+ };
1277
+
1278
+ /**
1279
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.
1280
+ * Use `create(SecuritySchemeSchema)` to create a new message.
1281
+ */
1282
+ export declare const SecuritySchemeSchema: GenMessage<SecurityScheme>;
1283
+
1284
+ /**
1285
+ * The type of the security scheme. Valid values are "basic",
1286
+ * "apiKey" or "oauth2".
1287
+ *
1288
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type
1289
+ */
1290
+ export enum SecurityScheme_Type {
1291
+ /**
1292
+ * @generated from enum value: TYPE_INVALID = 0;
1293
+ */
1294
+ INVALID = 0,
1295
+
1296
+ /**
1297
+ * @generated from enum value: TYPE_BASIC = 1;
1298
+ */
1299
+ BASIC = 1,
1300
+
1301
+ /**
1302
+ * @generated from enum value: TYPE_API_KEY = 2;
1303
+ */
1304
+ API_KEY = 2,
1305
+
1306
+ /**
1307
+ * @generated from enum value: TYPE_OAUTH2 = 3;
1308
+ */
1309
+ OAUTH2 = 3,
1310
+ }
1311
+
1312
+ /**
1313
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type.
1314
+ */
1315
+ export declare const SecurityScheme_TypeSchema: GenEnum<SecurityScheme_Type>;
1316
+
1317
+ /**
1318
+ * The location of the API key. Valid values are "query" or "header".
1319
+ *
1320
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In
1321
+ */
1322
+ export enum SecurityScheme_In {
1323
+ /**
1324
+ * @generated from enum value: IN_INVALID = 0;
1325
+ */
1326
+ INVALID = 0,
1327
+
1328
+ /**
1329
+ * @generated from enum value: IN_QUERY = 1;
1330
+ */
1331
+ QUERY = 1,
1332
+
1333
+ /**
1334
+ * @generated from enum value: IN_HEADER = 2;
1335
+ */
1336
+ HEADER = 2,
1337
+ }
1338
+
1339
+ /**
1340
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In.
1341
+ */
1342
+ export declare const SecurityScheme_InSchema: GenEnum<SecurityScheme_In>;
1343
+
1344
+ /**
1345
+ * The flow used by the OAuth2 security scheme. Valid values are
1346
+ * "implicit", "password", "application" or "accessCode".
1347
+ *
1348
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow
1349
+ */
1350
+ export enum SecurityScheme_Flow {
1351
+ /**
1352
+ * @generated from enum value: FLOW_INVALID = 0;
1353
+ */
1354
+ INVALID = 0,
1355
+
1356
+ /**
1357
+ * @generated from enum value: FLOW_IMPLICIT = 1;
1358
+ */
1359
+ IMPLICIT = 1,
1360
+
1361
+ /**
1362
+ * @generated from enum value: FLOW_PASSWORD = 2;
1363
+ */
1364
+ PASSWORD = 2,
1365
+
1366
+ /**
1367
+ * @generated from enum value: FLOW_APPLICATION = 3;
1368
+ */
1369
+ APPLICATION = 3,
1370
+
1371
+ /**
1372
+ * @generated from enum value: FLOW_ACCESS_CODE = 4;
1373
+ */
1374
+ ACCESS_CODE = 4,
1375
+ }
1376
+
1377
+ /**
1378
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow.
1379
+ */
1380
+ export declare const SecurityScheme_FlowSchema: GenEnum<SecurityScheme_Flow>;
1381
+
1382
+ /**
1383
+ * `SecurityRequirement` is a representation of OpenAPI v2 specification's
1384
+ * Security Requirement object.
1385
+ *
1386
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityRequirementObject
1387
+ *
1388
+ * Lists the required security schemes to execute this operation. The object can
1389
+ * have multiple security schemes declared in it which are all required (that
1390
+ * is, there is a logical AND between the schemes).
1391
+ *
1392
+ * The name used for each property MUST correspond to a security scheme
1393
+ * declared in the Security Definitions.
1394
+ *
1395
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement
1396
+ */
1397
+ export declare type SecurityRequirement = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement"> & {
1398
+ /**
1399
+ * Each name must correspond to a security scheme which is declared in
1400
+ * the Security Definitions. If the security scheme is of type "oauth2",
1401
+ * then the value is a list of scope names required for the execution.
1402
+ * For other security scheme types, the array MUST be empty.
1403
+ *
1404
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue> security_requirement = 1;
1405
+ */
1406
+ securityRequirement: { [key: string]: SecurityRequirement_SecurityRequirementValue };
1407
+ };
1408
+
1409
+ /**
1410
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.
1411
+ * Use `create(SecurityRequirementSchema)` to create a new message.
1412
+ */
1413
+ export declare const SecurityRequirementSchema: GenMessage<SecurityRequirement>;
1414
+
1415
+ /**
1416
+ * If the security scheme is of type "oauth2", then the value is a list of
1417
+ * scope names required for the execution. For other security scheme types,
1418
+ * the array MUST be empty.
1419
+ *
1420
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue
1421
+ */
1422
+ export declare type SecurityRequirement_SecurityRequirementValue = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue"> & {
1423
+ /**
1424
+ * @generated from field: repeated string scope = 1;
1425
+ */
1426
+ scope: string[];
1427
+ };
1428
+
1429
+ /**
1430
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue.
1431
+ * Use `create(SecurityRequirement_SecurityRequirementValueSchema)` to create a new message.
1432
+ */
1433
+ export declare const SecurityRequirement_SecurityRequirementValueSchema: GenMessage<SecurityRequirement_SecurityRequirementValue>;
1434
+
1435
+ /**
1436
+ * `Scopes` is a representation of OpenAPI v2 specification's Scopes object.
1437
+ *
1438
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#scopesObject
1439
+ *
1440
+ * Lists the available scopes for an OAuth2 security scheme.
1441
+ *
1442
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Scopes
1443
+ */
1444
+ export declare type Scopes = Message<"grpc.gateway.protoc_gen_openapiv2.options.Scopes"> & {
1445
+ /**
1446
+ * Maps between a name of a scope to a short description of it (as the value
1447
+ * of the property).
1448
+ *
1449
+ * @generated from field: map<string, string> scope = 1;
1450
+ */
1451
+ scope: { [key: string]: string };
1452
+ };
1453
+
1454
+ /**
1455
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Scopes.
1456
+ * Use `create(ScopesSchema)` to create a new message.
1457
+ */
1458
+ export declare const ScopesSchema: GenMessage<Scopes>;
1459
+
1460
+ /**
1461
+ * Scheme describes the schemes supported by the OpenAPI Swagger
1462
+ * and Operation objects.
1463
+ *
1464
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.Scheme
1465
+ */
1466
+ export enum Scheme {
1467
+ /**
1468
+ * @generated from enum value: UNKNOWN = 0;
1469
+ */
1470
+ UNKNOWN = 0,
1471
+
1472
+ /**
1473
+ * @generated from enum value: HTTP = 1;
1474
+ */
1475
+ HTTP = 1,
1476
+
1477
+ /**
1478
+ * @generated from enum value: HTTPS = 2;
1479
+ */
1480
+ HTTPS = 2,
1481
+
1482
+ /**
1483
+ * @generated from enum value: WS = 3;
1484
+ */
1485
+ WS = 3,
1486
+
1487
+ /**
1488
+ * @generated from enum value: WSS = 4;
1489
+ */
1490
+ WSS = 4,
1491
+ }
1492
+
1493
+ /**
1494
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.Scheme.
1495
+ */
1496
+ export declare const SchemeSchema: GenEnum<Scheme>;
1497
+