temporalio 1.5.0 → 1.6.0

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 (492) hide show
  1. checksums.yaml +4 -4
  2. data/Cargo.lock +1461 -621
  3. data/Cargo.toml +1 -1
  4. data/Gemfile +6 -5
  5. data/README.md +42 -1
  6. data/ext/Cargo.toml +9 -3
  7. data/lib/temporalio/api/activity/v1/message.rb +1 -1
  8. data/lib/temporalio/api/cloud/billing/v1/message.rb +2 -1
  9. data/lib/temporalio/api/cloud/cloudservice/v1/request_response.rb +17 -1
  10. data/lib/temporalio/api/cloud/cloudservice/v1/service.rb +1 -1
  11. data/lib/temporalio/api/cloud/connectivityrule/v1/message.rb +1 -1
  12. data/lib/temporalio/api/cloud/identity/v1/message.rb +8 -1
  13. data/lib/temporalio/api/cloud/namespace/v1/message.rb +5 -1
  14. data/lib/temporalio/api/command/v1/message.rb +2 -1
  15. data/lib/temporalio/api/common/v1/message.rb +5 -1
  16. data/lib/temporalio/api/deployment/v1/message.rb +3 -1
  17. data/lib/temporalio/api/history/v1/message.rb +3 -1
  18. data/lib/temporalio/api/namespace/v1/message.rb +1 -1
  19. data/lib/temporalio/api/nexus/v1/message.rb +1 -1
  20. data/lib/temporalio/api/nexusannotations/v1/options.rb +20 -0
  21. data/lib/temporalio/api/payload_visitor.rb +32 -0
  22. data/lib/temporalio/api/schedule/v1/message.rb +1 -1
  23. data/lib/temporalio/api/sdk/v1/event_group_marker.rb +26 -0
  24. data/lib/temporalio/api/update/v1/message.rb +1 -1
  25. data/lib/temporalio/api/workflow/v1/message.rb +3 -2
  26. data/lib/temporalio/api/workflowservice/v1/request_response.rb +11 -1
  27. data/lib/temporalio/api/workflowservice/v1/service.rb +3 -2
  28. data/lib/temporalio/client/connection/cloud_service.rb +120 -0
  29. data/lib/temporalio/client/connection/workflow_service.rb +75 -0
  30. data/lib/temporalio/client/connection.rb +37 -2
  31. data/lib/temporalio/client.rb +10 -5
  32. data/lib/temporalio/internal/bridge/api/workflow_commands/workflow_commands.rb +1 -1
  33. data/lib/temporalio/internal/bridge/client.rb +6 -1
  34. data/lib/temporalio/internal/bridge.rb +20 -0
  35. data/lib/temporalio/internal/google_protobuf.rb +11 -0
  36. data/lib/temporalio/internal/worker/workflow_instance/context.rb +2 -0
  37. data/lib/temporalio/internal/worker/workflow_instance/details.rb +3 -1
  38. data/lib/temporalio/internal/worker/workflow_instance/scheduler.rb +73 -2
  39. data/lib/temporalio/internal/worker/workflow_instance.rb +36 -6
  40. data/lib/temporalio/internal/worker/workflow_worker.rb +10 -2
  41. data/lib/temporalio/internal/workflow_task_failure_error.rb +9 -0
  42. data/lib/temporalio/version.rb +1 -1
  43. data/lib/temporalio/worker/activity_executor/fiber.rb +1 -1
  44. data/lib/temporalio/worker/activity_executor/thread_pool.rb +1 -1
  45. data/lib/temporalio/worker/illegal_workflow_call_validator.rb +3 -1
  46. data/lib/temporalio/worker/workflow_executor/thread_pool.rb +5 -1
  47. data/lib/temporalio/worker/workflow_replayer.rb +17 -4
  48. data/lib/temporalio/worker.rb +30 -5
  49. data/lib/temporalio/workflow/future.rb +5 -0
  50. data/lib/temporalio/workflow/nexus_operation_cancellation_type.rb +4 -2
  51. data/lib/temporalio/workflow.rb +8 -0
  52. data/rbi/google/protobuf.rbi +25 -0
  53. data/rbi/temporalio/activity/cancellation_details.rbi +33 -0
  54. data/rbi/temporalio/activity/complete_async_error.rbi +3 -0
  55. data/rbi/temporalio/activity/context.rbi +42 -0
  56. data/rbi/temporalio/activity/definition.rbi +74 -0
  57. data/rbi/temporalio/activity/info.rbi +112 -0
  58. data/rbi/temporalio/activity.rbi +3 -0
  59. data/rbi/temporalio/api/activity/v1/message.rbi +1453 -0
  60. data/rbi/temporalio/api/batch/v1/message.rbi +1283 -0
  61. data/rbi/temporalio/api/callback/v1/message.rbi +188 -0
  62. data/rbi/temporalio/api/cloud/account/v1/message.rbi +650 -0
  63. data/rbi/temporalio/api/cloud/auditlog/v1/message.rbi +318 -0
  64. data/rbi/temporalio/api/cloud/billing/v1/message.rbi +480 -0
  65. data/rbi/temporalio/api/cloud/cloudservice/v1/request_response.rbi +12454 -0
  66. data/rbi/temporalio/api/cloud/cloudservice/v1/service.rbi +3 -0
  67. data/rbi/temporalio/api/cloud/cloudservice/v1/service_services.rbi +709 -0
  68. data/rbi/temporalio/api/cloud/cloudservice.rbi +5 -0
  69. data/rbi/temporalio/api/cloud/connectivityrule/v1/message.rbi +403 -0
  70. data/rbi/temporalio/api/cloud/identity/v1/message.rbi +3072 -0
  71. data/rbi/temporalio/api/cloud/namespace/v1/message.rbi +3659 -0
  72. data/rbi/temporalio/api/cloud/nexus/v1/message.rbi +595 -0
  73. data/rbi/temporalio/api/cloud/operation/v1/message.rbi +244 -0
  74. data/rbi/temporalio/api/cloud/region/v1/message.rbi +166 -0
  75. data/rbi/temporalio/api/cloud/resource/v1/message.rbi +29 -0
  76. data/rbi/temporalio/api/cloud/sink/v1/message.rbi +438 -0
  77. data/rbi/temporalio/api/cloud/usage/v1/message.rbi +409 -0
  78. data/rbi/temporalio/api/command/v1/message.rbi +2655 -0
  79. data/rbi/temporalio/api/common/v1/grpc_status.rbi +92 -0
  80. data/rbi/temporalio/api/common/v1/message.rbi +2983 -0
  81. data/rbi/temporalio/api/compute/v1/config.rbi +421 -0
  82. data/rbi/temporalio/api/compute/v1/provider.rbi +125 -0
  83. data/rbi/temporalio/api/compute/v1/scaler.rbi +102 -0
  84. data/rbi/temporalio/api/deployment/v1/message.rbi +2340 -0
  85. data/rbi/temporalio/api/enums/v1/activity.rbi +62 -0
  86. data/rbi/temporalio/api/enums/v1/batch_operation.rbi +47 -0
  87. data/rbi/temporalio/api/enums/v1/command_type.rbi +36 -0
  88. data/rbi/temporalio/api/enums/v1/common.rbi +181 -0
  89. data/rbi/temporalio/api/enums/v1/deployment.rbi +80 -0
  90. data/rbi/temporalio/api/enums/v1/event_type.rbi +79 -0
  91. data/rbi/temporalio/api/enums/v1/failed_cause.rbi +155 -0
  92. data/rbi/temporalio/api/enums/v1/namespace.rbi +58 -0
  93. data/rbi/temporalio/api/enums/v1/nexus.rbi +98 -0
  94. data/rbi/temporalio/api/enums/v1/query.rbi +40 -0
  95. data/rbi/temporalio/api/enums/v1/reset.rbi +60 -0
  96. data/rbi/temporalio/api/enums/v1/schedule.rbi +25 -0
  97. data/rbi/temporalio/api/enums/v1/task_queue.rbi +134 -0
  98. data/rbi/temporalio/api/enums/v1/update.rbi +39 -0
  99. data/rbi/temporalio/api/enums/v1/workflow.rbi +259 -0
  100. data/rbi/temporalio/api/errordetails/v1/message.rbi +1389 -0
  101. data/rbi/temporalio/api/export/v1/message.rbi +123 -0
  102. data/rbi/temporalio/api/failure/v1/message.rbi +1303 -0
  103. data/rbi/temporalio/api/filter/v1/message.rbi +267 -0
  104. data/rbi/temporalio/api/history/v1/message.rbi +10737 -0
  105. data/rbi/temporalio/api/namespace/v1/message.rbi +1044 -0
  106. data/rbi/temporalio/api/nexus/v1/message.rbi +2780 -0
  107. data/rbi/temporalio/api/nexusannotations/v1/options.rbi +161 -0
  108. data/rbi/temporalio/api/nexusservices/workerservice/v1/request_response.rbi +124 -0
  109. data/rbi/temporalio/api/operatorservice/v1/request_response.rbi +1836 -0
  110. data/rbi/temporalio/api/operatorservice/v1/service.rbi +3 -0
  111. data/rbi/temporalio/api/operatorservice/v1/service_services.rbi +143 -0
  112. data/rbi/temporalio/api/operatorservice.rbi +5 -0
  113. data/rbi/temporalio/api/payload_visitor.rbi +876 -0
  114. data/rbi/temporalio/api/protoc_gen_openapiv2/options/annotations.rbi +3 -0
  115. data/rbi/temporalio/api/protoc_gen_openapiv2/options/openapiv2.rbi +3482 -0
  116. data/rbi/temporalio/api/protocol/v1/message.rbi +139 -0
  117. data/rbi/temporalio/api/protometa/v1/annotations.rbi +97 -0
  118. data/rbi/temporalio/api/query/v1/message.rbi +288 -0
  119. data/rbi/temporalio/api/replication/v1/message.rbi +226 -0
  120. data/rbi/temporalio/api/rules/v1/message.rbi +492 -0
  121. data/rbi/temporalio/api/schedule/v1/message.rbi +2377 -0
  122. data/rbi/temporalio/api/sdk/v1/enhanced_stack_trace.rbi +478 -0
  123. data/rbi/temporalio/api/sdk/v1/event_group_marker.rbi +337 -0
  124. data/rbi/temporalio/api/sdk/v1/external_storage.rbi +85 -0
  125. data/rbi/temporalio/api/sdk/v1/task_complete_metadata.rbi +206 -0
  126. data/rbi/temporalio/api/sdk/v1/user_metadata.rbi +98 -0
  127. data/rbi/temporalio/api/sdk/v1/worker_config.rbi +255 -0
  128. data/rbi/temporalio/api/sdk/v1/workflow_metadata.rbi +297 -0
  129. data/rbi/temporalio/api/taskqueue/v1/message.rbi +2460 -0
  130. data/rbi/temporalio/api/testservice/v1/request_response.rbi +380 -0
  131. data/rbi/temporalio/api/testservice/v1/service.rbi +3 -0
  132. data/rbi/temporalio/api/testservice/v1/service_services.rbi +100 -0
  133. data/rbi/temporalio/api/update/v1/message.rbi +800 -0
  134. data/rbi/temporalio/api/version/v1/message.rbi +281 -0
  135. data/rbi/temporalio/api/worker/v1/message.rbi +1565 -0
  136. data/rbi/temporalio/api/workflow/v1/message.rbi +5011 -0
  137. data/rbi/temporalio/api/workflowservice/v1/request_response.rbi +30477 -0
  138. data/rbi/temporalio/api/workflowservice/v1/service.rbi +3 -0
  139. data/rbi/temporalio/api/workflowservice/v1/service_services.rbi +1571 -0
  140. data/rbi/temporalio/api/workflowservice.rbi +5 -0
  141. data/rbi/temporalio/api.rbi +7 -0
  142. data/rbi/temporalio/cancellation.rbi +40 -0
  143. data/rbi/temporalio/client/activity_execution.rbi +134 -0
  144. data/rbi/temporalio/client/activity_execution_count.rbi +23 -0
  145. data/rbi/temporalio/client/activity_execution_status.rbi +11 -0
  146. data/rbi/temporalio/client/activity_handle.rbi +49 -0
  147. data/rbi/temporalio/client/activity_id_reference.rbi +24 -0
  148. data/rbi/temporalio/client/async_activity_handle.rbi +49 -0
  149. data/rbi/temporalio/client/connection/cloud_service.rbi +239 -0
  150. data/rbi/temporalio/client/connection/operator_service.rbi +47 -0
  151. data/rbi/temporalio/client/connection/service.rbi +19 -0
  152. data/rbi/temporalio/client/connection/test_service.rbi +29 -0
  153. data/rbi/temporalio/client/connection/workflow_service.rbi +377 -0
  154. data/rbi/temporalio/client/connection.rbi +284 -0
  155. data/rbi/temporalio/client/interceptor.rbi +1067 -0
  156. data/rbi/temporalio/client/pending_activity_state.rbi +9 -0
  157. data/rbi/temporalio/client/plugin.rbi +17 -0
  158. data/rbi/temporalio/client/schedule.rbi +677 -0
  159. data/rbi/temporalio/client/schedule_handle.rbi +40 -0
  160. data/rbi/temporalio/client/with_start_workflow_operation.rbi +126 -0
  161. data/rbi/temporalio/client/workflow_execution.rbi +62 -0
  162. data/rbi/temporalio/client/workflow_execution_count.rbi +23 -0
  163. data/rbi/temporalio/client/workflow_execution_status.rbi +11 -0
  164. data/rbi/temporalio/client/workflow_handle.rbi +148 -0
  165. data/rbi/temporalio/client/workflow_query_reject_condition.rbi +7 -0
  166. data/rbi/temporalio/client/workflow_update_handle.rbi +38 -0
  167. data/rbi/temporalio/client/workflow_update_wait_stage.rbi +7 -0
  168. data/rbi/temporalio/client.rbi +534 -0
  169. data/rbi/temporalio/common_enums.rbi +45 -0
  170. data/rbi/temporalio/contrib/open_telemetry.rbi +73 -0
  171. data/rbi/temporalio/converters/data_converter.rbi +44 -0
  172. data/rbi/temporalio/converters/failure_converter.rbi +20 -0
  173. data/rbi/temporalio/converters/payload_codec.rbi +11 -0
  174. data/rbi/temporalio/converters/payload_converter/binary_null.rbi +5 -0
  175. data/rbi/temporalio/converters/payload_converter/binary_plain.rbi +5 -0
  176. data/rbi/temporalio/converters/payload_converter/binary_protobuf.rbi +5 -0
  177. data/rbi/temporalio/converters/payload_converter/composite.rbi +20 -0
  178. data/rbi/temporalio/converters/payload_converter/encoding.rbi +14 -0
  179. data/rbi/temporalio/converters/payload_converter/json_plain.rbi +10 -0
  180. data/rbi/temporalio/converters/payload_converter/json_protobuf.rbi +5 -0
  181. data/rbi/temporalio/converters/payload_converter.rbi +28 -0
  182. data/rbi/temporalio/converters/raw_value.rbi +11 -0
  183. data/rbi/temporalio/converters.rbi +3 -0
  184. data/rbi/temporalio/env_config.rbi +156 -0
  185. data/rbi/temporalio/error/failure.rbi +3 -0
  186. data/rbi/temporalio/error.rbi +313 -0
  187. data/rbi/temporalio/internal/bridge/api/activity_result/activity_result.rbi +547 -0
  188. data/rbi/temporalio/internal/bridge/api/activity_task/activity_task.rbi +705 -0
  189. data/rbi/temporalio/internal/bridge/api/child_workflow/child_workflow.rbi +332 -0
  190. data/rbi/temporalio/internal/bridge/api/common/common.rbi +191 -0
  191. data/rbi/temporalio/internal/bridge/api/core_interface.rbi +567 -0
  192. data/rbi/temporalio/internal/bridge/api/external_data/external_data.rbi +255 -0
  193. data/rbi/temporalio/internal/bridge/api/nexus/nexus.rbi +527 -0
  194. data/rbi/temporalio/internal/bridge/api/workflow_activation/workflow_activation.rbi +2808 -0
  195. data/rbi/temporalio/internal/bridge/api/workflow_commands/workflow_commands.rbi +3309 -0
  196. data/rbi/temporalio/internal/bridge/api/workflow_completion/workflow_completion.rbi +272 -0
  197. data/rbi/temporalio/internal/bridge/api.rbi +3 -0
  198. data/rbi/temporalio/internal/bridge/client.rbi +346 -0
  199. data/rbi/temporalio/internal/bridge/runtime.rbi +231 -0
  200. data/rbi/temporalio/internal/bridge/testing.rbi +109 -0
  201. data/rbi/temporalio/internal/bridge/worker.rbi +250 -0
  202. data/rbi/temporalio/internal/bridge.rbi +47 -0
  203. data/rbi/temporalio/internal/client/implementation.rbi +53 -0
  204. data/rbi/temporalio/internal/google_protobuf.rbi +8 -0
  205. data/rbi/temporalio/internal/metric.rbi +55 -0
  206. data/rbi/temporalio/internal/proto_utils.rbi +148 -0
  207. data/rbi/temporalio/internal/worker/activity_worker.rbi +108 -0
  208. data/rbi/temporalio/internal/worker/multi_runner.rbi +175 -0
  209. data/rbi/temporalio/internal/worker/workflow_instance/child_workflow_handle.rbi +20 -0
  210. data/rbi/temporalio/internal/worker/workflow_instance/context.rbi +290 -0
  211. data/rbi/temporalio/internal/worker/workflow_instance/details.rbi +87 -0
  212. data/rbi/temporalio/internal/worker/workflow_instance/external_workflow_handle.rbi +14 -0
  213. data/rbi/temporalio/internal/worker/workflow_instance/externally_immutable_hash.rbi +17 -0
  214. data/rbi/temporalio/internal/worker/workflow_instance/handler_execution.rbi +17 -0
  215. data/rbi/temporalio/internal/worker/workflow_instance/handler_hash.rbi +24 -0
  216. data/rbi/temporalio/internal/worker/workflow_instance/illegal_call_tracer.rbi +17 -0
  217. data/rbi/temporalio/internal/worker/workflow_instance/inbound_implementation.rbi +21 -0
  218. data/rbi/temporalio/internal/worker/workflow_instance/nexus_client.rbi +47 -0
  219. data/rbi/temporalio/internal/worker/workflow_instance/nexus_operation_handle.rbi +19 -0
  220. data/rbi/temporalio/internal/worker/workflow_instance/outbound_implementation.rbi +43 -0
  221. data/rbi/temporalio/internal/worker/workflow_instance/replay_safe_logger.rbi +11 -0
  222. data/rbi/temporalio/internal/worker/workflow_instance/replay_safe_metric.rbi +15 -0
  223. data/rbi/temporalio/internal/worker/workflow_instance/scheduler.rbi +36 -0
  224. data/rbi/temporalio/internal/worker/workflow_instance.rbi +231 -0
  225. data/rbi/temporalio/internal/worker/workflow_worker.rbi +199 -0
  226. data/rbi/temporalio/internal/workflow_task_failure_error.rbi +3 -0
  227. data/rbi/temporalio/internal.rbi +3 -0
  228. data/rbi/temporalio/metric.rbi +56 -0
  229. data/rbi/temporalio/priority.rbi +38 -0
  230. data/rbi/temporalio/retry_policy.rbi +40 -0
  231. data/rbi/temporalio/runtime/metric_buffer.rbi +45 -0
  232. data/rbi/temporalio/runtime.rbi +185 -0
  233. data/rbi/temporalio/scoped_logger.rbi +50 -0
  234. data/rbi/temporalio/search_attributes.rbi +94 -0
  235. data/rbi/temporalio/simple_plugin.rbi +41 -0
  236. data/rbi/temporalio/testing/activity_environment.rbi +43 -0
  237. data/rbi/temporalio/testing/workflow_environment.rbi +116 -0
  238. data/rbi/temporalio/testing.rbi +3 -0
  239. data/rbi/temporalio/version.rbi +5 -0
  240. data/rbi/temporalio/versioning_override.rbi +13 -0
  241. data/rbi/temporalio/worker/activity_executor/fiber.rbi +20 -0
  242. data/rbi/temporalio/worker/activity_executor/thread_pool.rbi +20 -0
  243. data/rbi/temporalio/worker/activity_executor.rbi +20 -0
  244. data/rbi/temporalio/worker/deployment_options.rbi +23 -0
  245. data/rbi/temporalio/worker/illegal_workflow_call_validator.rbi +33 -0
  246. data/rbi/temporalio/worker/interceptor.rbi +489 -0
  247. data/rbi/temporalio/worker/plugin.rbi +49 -0
  248. data/rbi/temporalio/worker/poller_behavior.rbi +29 -0
  249. data/rbi/temporalio/worker/thread_pool.rbi +38 -0
  250. data/rbi/temporalio/worker/tuner.rbi +221 -0
  251. data/rbi/temporalio/worker/workflow_executor/thread_pool.rbi +15 -0
  252. data/rbi/temporalio/worker/workflow_executor.rbi +8 -0
  253. data/rbi/temporalio/worker/workflow_replayer.rbi +152 -0
  254. data/rbi/temporalio/worker.rbi +258 -0
  255. data/rbi/temporalio/worker_deployment_version.rbi +29 -0
  256. data/rbi/temporalio/workflow/activity_cancellation_type.rbi +7 -0
  257. data/rbi/temporalio/workflow/child_workflow_cancellation_type.rbi +8 -0
  258. data/rbi/temporalio/workflow/child_workflow_handle.rbi +27 -0
  259. data/rbi/temporalio/workflow/definition.rbi +305 -0
  260. data/rbi/temporalio/workflow/external_workflow_handle.rbi +24 -0
  261. data/rbi/temporalio/workflow/future.rbi +62 -0
  262. data/rbi/temporalio/workflow/handler_unfinished_policy.rbi +6 -0
  263. data/rbi/temporalio/workflow/info.rbi +100 -0
  264. data/rbi/temporalio/workflow/nexus_client.rbi +65 -0
  265. data/rbi/temporalio/workflow/nexus_operation_cancellation_type.rbi +8 -0
  266. data/rbi/temporalio/workflow/nexus_operation_handle.rbi +14 -0
  267. data/rbi/temporalio/workflow/parent_close_policy.rbi +8 -0
  268. data/rbi/temporalio/workflow/update_info.rbi +14 -0
  269. data/rbi/temporalio/workflow.rbi +393 -0
  270. data/rbi/temporalio/workflow_history.rbi +21 -0
  271. data/rbi/temporalio.rbi +5 -0
  272. data/sig/common.rbs +1 -0
  273. data/sig/google/protobuf_compat.rbs +17 -0
  274. data/sig/open_telemetry.rbs +47 -0
  275. data/sig/temporalio/activity/cancellation_details.rbs +21 -0
  276. data/sig/temporalio/activity/complete_async_error.rbs +6 -0
  277. data/sig/temporalio/activity/context.rbs +26 -0
  278. data/sig/temporalio/activity/definition.rbs +60 -0
  279. data/sig/temporalio/activity/info.rbs +57 -0
  280. data/sig/temporalio/activity.rbs +4 -0
  281. data/sig/temporalio/api/activity/v1/message.rbs +708 -0
  282. data/sig/temporalio/api/batch/v1/message.rbs +594 -0
  283. data/sig/temporalio/api/callback/v1/message.rbs +112 -0
  284. data/sig/temporalio/api/cloud/account/v1/message.rbs +314 -0
  285. data/sig/temporalio/api/cloud/auditlog/v1/message.rbs +168 -0
  286. data/sig/temporalio/api/cloud/billing/v1/message.rbs +279 -0
  287. data/sig/temporalio/api/cloud/cloudservice/v1/request_response.rbs +4726 -0
  288. data/sig/temporalio/api/cloud/cloudservice/v1/service.rbs +25 -0
  289. data/sig/temporalio/api/cloud/cloudservice.rbs +8 -0
  290. data/sig/temporalio/api/cloud/connectivityrule/v1/message.rbs +191 -0
  291. data/sig/temporalio/api/cloud/identity/v1/message.rbs +1372 -0
  292. data/sig/temporalio/api/cloud/namespace/v1/message.rbs +1571 -0
  293. data/sig/temporalio/api/cloud/nexus/v1/message.rbs +269 -0
  294. data/sig/temporalio/api/cloud/operation/v1/message.rbs +156 -0
  295. data/sig/temporalio/api/cloud/region/v1/message.rbs +109 -0
  296. data/sig/temporalio/api/cloud/resource/v1/message.rbs +61 -0
  297. data/sig/temporalio/api/cloud/sink/v1/message.rbs +207 -0
  298. data/sig/temporalio/api/cloud/usage/v1/message.rbs +230 -0
  299. data/sig/temporalio/api/command/v1/message.rbs +1211 -0
  300. data/sig/temporalio/api/common/v1/grpc_status.rbs +59 -0
  301. data/sig/temporalio/api/common/v1/message.rbs +1238 -0
  302. data/sig/temporalio/api/compute/v1/config.rbs +176 -0
  303. data/sig/temporalio/api/compute/v1/provider.rbs +73 -0
  304. data/sig/temporalio/api/compute/v1/scaler.rbs +60 -0
  305. data/sig/temporalio/api/deployment/v1/message.rbs +1063 -0
  306. data/sig/temporalio/api/enums/v1/activity.rbs +134 -0
  307. data/sig/temporalio/api/enums/v1/batch_operation.rbs +80 -0
  308. data/sig/temporalio/api/enums/v1/command_type.rbs +74 -0
  309. data/sig/temporalio/api/enums/v1/common.rbs +271 -0
  310. data/sig/temporalio/api/enums/v1/deployment.rbs +177 -0
  311. data/sig/temporalio/api/enums/v1/event_type.rbs +263 -0
  312. data/sig/temporalio/api/enums/v1/failed_cause.rbs +281 -0
  313. data/sig/temporalio/api/enums/v1/namespace.rbs +87 -0
  314. data/sig/temporalio/api/enums/v1/nexus.rbs +172 -0
  315. data/sig/temporalio/api/enums/v1/query.rbs +69 -0
  316. data/sig/temporalio/api/enums/v1/reset.rbs +106 -0
  317. data/sig/temporalio/api/enums/v1/schedule.rbs +68 -0
  318. data/sig/temporalio/api/enums/v1/task_queue.rbs +238 -0
  319. data/sig/temporalio/api/enums/v1/update.rbs +87 -0
  320. data/sig/temporalio/api/enums/v1/workflow.rbs +435 -0
  321. data/sig/temporalio/api/errordetails/v1/message.rbs +532 -0
  322. data/sig/temporalio/api/export/v1/message.rbs +63 -0
  323. data/sig/temporalio/api/failure/v1/message.rbs +579 -0
  324. data/sig/temporalio/api/filter/v1/message.rbs +121 -0
  325. data/sig/temporalio/api/history/v1/message.rbs +4928 -0
  326. data/sig/temporalio/api/namespace/v1/message.rbs +465 -0
  327. data/sig/temporalio/api/nexus/v1/message.rbs +1268 -0
  328. data/sig/temporalio/api/nexusannotations/v1/options.rbs +76 -0
  329. data/sig/temporalio/api/nexusservices/workerservice/v1/request_response.rbs +65 -0
  330. data/sig/temporalio/api/operatorservice/v1/request_response.rbs +679 -0
  331. data/sig/temporalio/api/operatorservice/v1/service.rbs +23 -0
  332. data/sig/temporalio/api/operatorservice.rbs +6 -0
  333. data/sig/temporalio/api/payload_visitor.rbs +298 -0
  334. data/sig/temporalio/api/protoc_gen_openapiv2/options/annotations.rbs +23 -0
  335. data/sig/temporalio/api/protoc_gen_openapiv2/options/openapiv2.rbs +1691 -0
  336. data/sig/temporalio/api/protocol/v1/message.rbs +90 -0
  337. data/sig/temporalio/api/protometa/v1/annotations.rbs +62 -0
  338. data/sig/temporalio/api/query/v1/message.rbs +138 -0
  339. data/sig/temporalio/api/replication/v1/message.rbs +109 -0
  340. data/sig/temporalio/api/rules/v1/message.rbs +213 -0
  341. data/sig/temporalio/api/schedule/v1/message.rbs +1066 -0
  342. data/sig/temporalio/api/sdk/v1/enhanced_stack_trace.rbs +210 -0
  343. data/sig/temporalio/api/sdk/v1/event_group_marker.rbs +154 -0
  344. data/sig/temporalio/api/sdk/v1/external_storage.rbs +54 -0
  345. data/sig/temporalio/api/sdk/v1/task_complete_metadata.rbs +92 -0
  346. data/sig/temporalio/api/sdk/v1/user_metadata.rbs +58 -0
  347. data/sig/temporalio/api/sdk/v1/worker_config.rbs +122 -0
  348. data/sig/temporalio/api/sdk/v1/workflow_metadata.rbs +138 -0
  349. data/sig/temporalio/api/taskqueue/v1/message.rbs +1013 -0
  350. data/sig/temporalio/api/testservice/v1/request_response.rbs +125 -0
  351. data/sig/temporalio/api/testservice/v1/service.rbs +23 -0
  352. data/sig/temporalio/api/update/v1/message.rbs +349 -0
  353. data/sig/temporalio/api/version/v1/message.rbs +143 -0
  354. data/sig/temporalio/api/worker/v1/message.rbs +716 -0
  355. data/sig/temporalio/api/workflow/v1/message.rbs +2322 -0
  356. data/sig/temporalio/api/workflowservice/v1/request_response.rbs +12735 -0
  357. data/sig/temporalio/api/workflowservice/v1/service.rbs +23 -0
  358. data/sig/temporalio/api/workflowservice.rbs +6 -0
  359. data/sig/temporalio/api.rbs +4 -0
  360. data/sig/temporalio/cancellation.rbs +20 -0
  361. data/sig/temporalio/client/activity_execution.rbs +50 -0
  362. data/sig/temporalio/client/activity_execution_count.rbs +17 -0
  363. data/sig/temporalio/client/activity_execution_status.rbs +15 -0
  364. data/sig/temporalio/client/activity_handle.rbs +26 -0
  365. data/sig/temporalio/client/activity_id_reference.rbs +16 -0
  366. data/sig/temporalio/client/async_activity_handle.rbs +41 -0
  367. data/sig/temporalio/client/connection/cloud_service.rbs +315 -0
  368. data/sig/temporalio/client/connection/operator_service.rbs +59 -0
  369. data/sig/temporalio/client/connection/service.rbs +17 -0
  370. data/sig/temporalio/client/connection/test_service.rbs +35 -0
  371. data/sig/temporalio/client/connection/workflow_service.rbs +499 -0
  372. data/sig/temporalio/client/connection.rbs +143 -0
  373. data/sig/temporalio/client/interceptor.rbs +622 -0
  374. data/sig/temporalio/client/pending_activity_state.rbs +14 -0
  375. data/sig/temporalio/client/plugin.rbs +14 -0
  376. data/sig/temporalio/client/schedule.rbs +337 -0
  377. data/sig/temporalio/client/schedule_handle.rbs +44 -0
  378. data/sig/temporalio/client/with_start_workflow_operation.rbs +82 -0
  379. data/sig/temporalio/client/workflow_execution.rbs +37 -0
  380. data/sig/temporalio/client/workflow_execution_count.rbs +17 -0
  381. data/sig/temporalio/client/workflow_execution_status.rbs +16 -0
  382. data/sig/temporalio/client/workflow_handle.rbs +95 -0
  383. data/sig/temporalio/client/workflow_query_reject_condition.rbs +12 -0
  384. data/sig/temporalio/client/workflow_update_handle.rbs +26 -0
  385. data/sig/temporalio/client/workflow_update_wait_stage.rbs +12 -0
  386. data/sig/temporalio/client.rbs +271 -0
  387. data/sig/temporalio/common_enums.rbs +60 -0
  388. data/sig/temporalio/contrib/open_telemetry.rbs +74 -0
  389. data/sig/temporalio/converters/data_converter.rbs +32 -0
  390. data/sig/temporalio/converters/failure_converter.rbs +12 -0
  391. data/sig/temporalio/converters/payload_codec.rbs +8 -0
  392. data/sig/temporalio/converters/payload_converter/binary_null.rbs +9 -0
  393. data/sig/temporalio/converters/payload_converter/binary_plain.rbs +9 -0
  394. data/sig/temporalio/converters/payload_converter/binary_protobuf.rbs +9 -0
  395. data/sig/temporalio/converters/payload_converter/composite.rbs +16 -0
  396. data/sig/temporalio/converters/payload_converter/encoding.rbs +13 -0
  397. data/sig/temporalio/converters/payload_converter/json_plain.rbs +14 -0
  398. data/sig/temporalio/converters/payload_converter/json_protobuf.rbs +9 -0
  399. data/sig/temporalio/converters/payload_converter.rbs +24 -0
  400. data/sig/temporalio/converters/raw_value.rbs +9 -0
  401. data/sig/temporalio/converters.rbs +4 -0
  402. data/sig/temporalio/env_config.rbs +86 -0
  403. data/sig/temporalio/error/failure.rbs +170 -0
  404. data/sig/temporalio/error.rbs +88 -0
  405. data/sig/temporalio/internal/bridge/api/activity_result/activity_result.rbs +247 -0
  406. data/sig/temporalio/internal/bridge/api/activity_task/activity_task.rbs +372 -0
  407. data/sig/temporalio/internal/bridge/api/child_workflow/child_workflow.rbs +207 -0
  408. data/sig/temporalio/internal/bridge/api/common/common.rbs +123 -0
  409. data/sig/temporalio/internal/bridge/api/core_interface.rbs +231 -0
  410. data/sig/temporalio/internal/bridge/api/external_data/external_data.rbs +134 -0
  411. data/sig/temporalio/internal/bridge/api/nexus/nexus.rbs +285 -0
  412. data/sig/temporalio/internal/bridge/api/workflow_activation/workflow_activation.rbs +1304 -0
  413. data/sig/temporalio/internal/bridge/api/workflow_commands/workflow_commands.rbs +1526 -0
  414. data/sig/temporalio/internal/bridge/api/workflow_completion/workflow_completion.rbs +136 -0
  415. data/sig/temporalio/internal/bridge/api.rbs +8 -0
  416. data/sig/temporalio/internal/bridge/client.rbs +144 -0
  417. data/sig/temporalio/internal/bridge/metric.rbs +28 -0
  418. data/sig/temporalio/internal/bridge/runtime.rbs +97 -0
  419. data/sig/temporalio/internal/bridge/testing.rbs +91 -0
  420. data/sig/temporalio/internal/bridge/worker.rbs +199 -0
  421. data/sig/temporalio/internal/bridge.rbs +36 -0
  422. data/sig/temporalio/internal/client/implementation.rbs +33 -0
  423. data/sig/temporalio/internal/google_protobuf.rbs +7 -0
  424. data/sig/temporalio/internal/metric.rbs +35 -0
  425. data/sig/temporalio/internal/proto_utils.rbs +94 -0
  426. data/sig/temporalio/internal/worker/activity_worker.rbs +64 -0
  427. data/sig/temporalio/internal/worker/multi_runner.rbs +132 -0
  428. data/sig/temporalio/internal/worker/workflow_instance/child_workflow_handle.rbs +22 -0
  429. data/sig/temporalio/internal/worker/workflow_instance/context.rbs +172 -0
  430. data/sig/temporalio/internal/worker/workflow_instance/details.rbs +43 -0
  431. data/sig/temporalio/internal/worker/workflow_instance/external_workflow_handle.rbs +15 -0
  432. data/sig/temporalio/internal/worker/workflow_instance/externally_immutable_hash.rbs +16 -0
  433. data/sig/temporalio/internal/worker/workflow_instance/handler_execution.rbs +19 -0
  434. data/sig/temporalio/internal/worker/workflow_instance/handler_hash.rbs +14 -0
  435. data/sig/temporalio/internal/worker/workflow_instance/illegal_call_tracer.rbs +20 -0
  436. data/sig/temporalio/internal/worker/workflow_instance/inbound_implementation.rbs +19 -0
  437. data/sig/temporalio/internal/worker/workflow_instance/nexus_client.rbs +25 -0
  438. data/sig/temporalio/internal/worker/workflow_instance/nexus_operation_handle.rbs +19 -0
  439. data/sig/temporalio/internal/worker/workflow_instance/outbound_implementation.rbs +35 -0
  440. data/sig/temporalio/internal/worker/workflow_instance/replay_safe_logger.rbs +16 -0
  441. data/sig/temporalio/internal/worker/workflow_instance/replay_safe_metric.rbs +15 -0
  442. data/sig/temporalio/internal/worker/workflow_instance/scheduler.rbs +52 -0
  443. data/sig/temporalio/internal/worker/workflow_instance.rbs +111 -0
  444. data/sig/temporalio/internal/worker/workflow_worker.rbs +99 -0
  445. data/sig/temporalio/internal/workflow_task_failure_error.rbs +6 -0
  446. data/sig/temporalio/internal.rbs +4 -0
  447. data/sig/temporalio/metric.rbs +55 -0
  448. data/sig/temporalio/priority.rbs +17 -0
  449. data/sig/temporalio/retry_policy.rbs +21 -0
  450. data/sig/temporalio/runtime/metric_buffer.rbs +49 -0
  451. data/sig/temporalio/runtime.rbs +118 -0
  452. data/sig/temporalio/scoped_logger.rbs +15 -0
  453. data/sig/temporalio/search_attributes.rbs +82 -0
  454. data/sig/temporalio/simple_plugin.rbs +65 -0
  455. data/sig/temporalio/testing/activity_environment.rbs +52 -0
  456. data/sig/temporalio/testing/workflow_environment.rbs +141 -0
  457. data/sig/temporalio/testing.rbs +4 -0
  458. data/sig/temporalio/version.rbs +3 -0
  459. data/sig/temporalio/versioning_override.rbs +17 -0
  460. data/sig/temporalio/worker/activity_executor/fiber.rbs +9 -0
  461. data/sig/temporalio/worker/activity_executor/thread_pool.rbs +11 -0
  462. data/sig/temporalio/worker/activity_executor.rbs +12 -0
  463. data/sig/temporalio/worker/deployment_options.rbs +17 -0
  464. data/sig/temporalio/worker/illegal_workflow_call_validator.rbs +25 -0
  465. data/sig/temporalio/worker/interceptor.rbs +373 -0
  466. data/sig/temporalio/worker/plugin.rbs +47 -0
  467. data/sig/temporalio/worker/poller_behavior.rbs +23 -0
  468. data/sig/temporalio/worker/thread_pool.rbs +44 -0
  469. data/sig/temporalio/worker/tuner.rbs +121 -0
  470. data/sig/temporalio/worker/workflow_executor/thread_pool.rbs +58 -0
  471. data/sig/temporalio/worker/workflow_executor.rbs +15 -0
  472. data/sig/temporalio/worker/workflow_replayer.rbs +105 -0
  473. data/sig/temporalio/worker.rbs +168 -0
  474. data/sig/temporalio/worker_deployment_version.rbs +17 -0
  475. data/sig/temporalio/workflow/activity_cancellation_type.rbs +11 -0
  476. data/sig/temporalio/workflow/child_workflow_cancellation_type.rbs +12 -0
  477. data/sig/temporalio/workflow/child_workflow_handle.rbs +18 -0
  478. data/sig/temporalio/workflow/definition.rbs +181 -0
  479. data/sig/temporalio/workflow/external_workflow_handle.rbs +17 -0
  480. data/sig/temporalio/workflow/future.rbs +24 -0
  481. data/sig/temporalio/workflow/handler_unfinished_policy.rbs +10 -0
  482. data/sig/temporalio/workflow/info.rbs +79 -0
  483. data/sig/temporalio/workflow/nexus_client.rbs +34 -0
  484. data/sig/temporalio/workflow/nexus_operation_cancellation_type.rbs +12 -0
  485. data/sig/temporalio/workflow/nexus_operation_handle.rbs +10 -0
  486. data/sig/temporalio/workflow/parent_close_policy.rbs +12 -0
  487. data/sig/temporalio/workflow/update_info.rbs +15 -0
  488. data/sig/temporalio/workflow.rbs +215 -0
  489. data/sig/temporalio/workflow_history.rbs +13 -0
  490. data/sig/temporalio.rbs +3 -0
  491. data/temporalio.gemspec +1 -1
  492. metadata +445 -2
@@ -0,0 +1,3482 @@
1
+ # Code generated by protoc-gen-rbi. DO NOT EDIT.
2
+ # source: protoc-gen-openapiv2/options/openapiv2.proto
3
+ # typed: strict
4
+
5
+ # `Swagger` is a representation of OpenAPI v2 specification's Swagger object.
6
+ #
7
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject
8
+ #
9
+ # Example:
10
+ #
11
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
12
+ # info: {
13
+ # title: "Echo API";
14
+ # version: "1.0";
15
+ # description: "";
16
+ # contact: {
17
+ # name: "gRPC-Gateway project";
18
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway";
19
+ # email: "none@example.com";
20
+ # };
21
+ # license: {
22
+ # name: "BSD 3-Clause License";
23
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
24
+ # };
25
+ # };
26
+ # schemes: HTTPS;
27
+ # consumes: "application/json";
28
+ # produces: "application/json";
29
+ # };
30
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Swagger
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+
34
+ sig do
35
+ params(
36
+ swagger: T.nilable(String),
37
+ info: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Info),
38
+ host: T.nilable(String),
39
+ base_path: T.nilable(String),
40
+ schemes: T.nilable(T::Array[T.any(Symbol, String, Integer)]),
41
+ consumes: T.nilable(T::Array[String]),
42
+ produces: T.nilable(T::Array[String]),
43
+ responses: T.nilable(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Response)]),
44
+ security_definitions: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions),
45
+ security: T.nilable(T::Array[T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement)]),
46
+ tags: T.nilable(T::Array[T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Tag)]),
47
+ external_docs: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation),
48
+ extensions: T.nilable(T::Hash[String, T.nilable(Google::Protobuf::Value)])
49
+ ).void
50
+ end
51
+ def initialize(
52
+ swagger: "",
53
+ info: nil,
54
+ host: "",
55
+ base_path: "",
56
+ schemes: [],
57
+ consumes: [],
58
+ produces: [],
59
+ responses: ::Google::Protobuf::Map.new(:string, :message, Grpc::Gateway::ProtocGenOpenapiv2::Options::Response),
60
+ security_definitions: nil,
61
+ security: [],
62
+ tags: [],
63
+ external_docs: nil,
64
+ extensions: ::Google::Protobuf::Map.new(:string, :message, Google::Protobuf::Value)
65
+ )
66
+ end
67
+
68
+ # Specifies the OpenAPI Specification version being used. It can be
69
+ # used by the OpenAPI UI and other clients to interpret the API listing. The
70
+ # value MUST be "2.0".
71
+ sig { returns(String) }
72
+ def swagger
73
+ end
74
+
75
+ # Specifies the OpenAPI Specification version being used. It can be
76
+ # used by the OpenAPI UI and other clients to interpret the API listing. The
77
+ # value MUST be "2.0".
78
+ sig { params(value: String).void }
79
+ def swagger=(value)
80
+ end
81
+
82
+ # Specifies the OpenAPI Specification version being used. It can be
83
+ # used by the OpenAPI UI and other clients to interpret the API listing. The
84
+ # value MUST be "2.0".
85
+ sig { void }
86
+ def clear_swagger
87
+ end
88
+
89
+ # Provides metadata about the API. The metadata can be used by the
90
+ # clients if needed.
91
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Info)) }
92
+ def info
93
+ end
94
+
95
+ # Provides metadata about the API. The metadata can be used by the
96
+ # clients if needed.
97
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Info)).void }
98
+ def info=(value)
99
+ end
100
+
101
+ # Provides metadata about the API. The metadata can be used by the
102
+ # clients if needed.
103
+ sig { void }
104
+ def clear_info
105
+ end
106
+
107
+ # The host (name or ip) serving the API. This MUST be the host only and does
108
+ # not include the scheme nor sub-paths. It MAY include a port. If the host is
109
+ # not included, the host serving the documentation is to be used (including
110
+ # the port). The host does not support path templating.
111
+ sig { returns(String) }
112
+ def host
113
+ end
114
+
115
+ # The host (name or ip) serving the API. This MUST be the host only and does
116
+ # not include the scheme nor sub-paths. It MAY include a port. If the host is
117
+ # not included, the host serving the documentation is to be used (including
118
+ # the port). The host does not support path templating.
119
+ sig { params(value: String).void }
120
+ def host=(value)
121
+ end
122
+
123
+ # The host (name or ip) serving the API. This MUST be the host only and does
124
+ # not include the scheme nor sub-paths. It MAY include a port. If the host is
125
+ # not included, the host serving the documentation is to be used (including
126
+ # the port). The host does not support path templating.
127
+ sig { void }
128
+ def clear_host
129
+ end
130
+
131
+ # The base path on which the API is served, which is relative to the host. If
132
+ # it is not included, the API is served directly under the host. The value
133
+ # MUST start with a leading slash (/). The basePath does not support path
134
+ # templating.
135
+ # Note that using `base_path` does not change the endpoint paths that are
136
+ # generated in the resulting OpenAPI file. If you wish to use `base_path`
137
+ # with relatively generated OpenAPI paths, the `base_path` prefix must be
138
+ # manually removed from your `google.api.http` paths and your code changed to
139
+ # serve the API from the `base_path`.
140
+ sig { returns(String) }
141
+ def base_path
142
+ end
143
+
144
+ # The base path on which the API is served, which is relative to the host. If
145
+ # it is not included, the API is served directly under the host. The value
146
+ # MUST start with a leading slash (/). The basePath does not support path
147
+ # templating.
148
+ # Note that using `base_path` does not change the endpoint paths that are
149
+ # generated in the resulting OpenAPI file. If you wish to use `base_path`
150
+ # with relatively generated OpenAPI paths, the `base_path` prefix must be
151
+ # manually removed from your `google.api.http` paths and your code changed to
152
+ # serve the API from the `base_path`.
153
+ sig { params(value: String).void }
154
+ def base_path=(value)
155
+ end
156
+
157
+ # The base path on which the API is served, which is relative to the host. If
158
+ # it is not included, the API is served directly under the host. The value
159
+ # MUST start with a leading slash (/). The basePath does not support path
160
+ # templating.
161
+ # Note that using `base_path` does not change the endpoint paths that are
162
+ # generated in the resulting OpenAPI file. If you wish to use `base_path`
163
+ # with relatively generated OpenAPI paths, the `base_path` prefix must be
164
+ # manually removed from your `google.api.http` paths and your code changed to
165
+ # serve the API from the `base_path`.
166
+ sig { void }
167
+ def clear_base_path
168
+ end
169
+
170
+ # The transfer protocol of the API. Values MUST be from the list: "http",
171
+ # "https", "ws", "wss". If the schemes is not included, the default scheme to
172
+ # be used is the one used to access the OpenAPI definition itself.
173
+ sig { returns(T::Array[T.any(Symbol, Integer)]) }
174
+ def schemes
175
+ end
176
+
177
+ # The transfer protocol of the API. Values MUST be from the list: "http",
178
+ # "https", "ws", "wss". If the schemes is not included, the default scheme to
179
+ # be used is the one used to access the OpenAPI definition itself.
180
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
181
+ def schemes=(value)
182
+ end
183
+
184
+ # The transfer protocol of the API. Values MUST be from the list: "http",
185
+ # "https", "ws", "wss". If the schemes is not included, the default scheme to
186
+ # be used is the one used to access the OpenAPI definition itself.
187
+ sig { void }
188
+ def clear_schemes
189
+ end
190
+
191
+ # A list of MIME types the APIs can consume. This is global to all APIs but
192
+ # can be overridden on specific API calls. Value MUST be as described under
193
+ # Mime Types.
194
+ sig { returns(T::Array[String]) }
195
+ def consumes
196
+ end
197
+
198
+ # A list of MIME types the APIs can consume. This is global to all APIs but
199
+ # can be overridden on specific API calls. Value MUST be as described under
200
+ # Mime Types.
201
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
202
+ def consumes=(value)
203
+ end
204
+
205
+ # A list of MIME types the APIs can consume. This is global to all APIs but
206
+ # can be overridden on specific API calls. Value MUST be as described under
207
+ # Mime Types.
208
+ sig { void }
209
+ def clear_consumes
210
+ end
211
+
212
+ # A list of MIME types the APIs can produce. This is global to all APIs but
213
+ # can be overridden on specific API calls. Value MUST be as described under
214
+ # Mime Types.
215
+ sig { returns(T::Array[String]) }
216
+ def produces
217
+ end
218
+
219
+ # A list of MIME types the APIs can produce. This is global to all APIs but
220
+ # can be overridden on specific API calls. Value MUST be as described under
221
+ # Mime Types.
222
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
223
+ def produces=(value)
224
+ end
225
+
226
+ # A list of MIME types the APIs can produce. This is global to all APIs but
227
+ # can be overridden on specific API calls. Value MUST be as described under
228
+ # Mime Types.
229
+ sig { void }
230
+ def clear_produces
231
+ end
232
+
233
+ # An object to hold responses that can be used across operations. This
234
+ # property does not define global responses for all operations.
235
+ sig { returns(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Response)]) }
236
+ def responses
237
+ end
238
+
239
+ # An object to hold responses that can be used across operations. This
240
+ # property does not define global responses for all operations.
241
+ sig { params(value: ::Google::Protobuf::Map).void }
242
+ def responses=(value)
243
+ end
244
+
245
+ # An object to hold responses that can be used across operations. This
246
+ # property does not define global responses for all operations.
247
+ sig { void }
248
+ def clear_responses
249
+ end
250
+
251
+ # Security scheme definitions that can be used across the specification.
252
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions)) }
253
+ def security_definitions
254
+ end
255
+
256
+ # Security scheme definitions that can be used across the specification.
257
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions)).void }
258
+ def security_definitions=(value)
259
+ end
260
+
261
+ # Security scheme definitions that can be used across the specification.
262
+ sig { void }
263
+ def clear_security_definitions
264
+ end
265
+
266
+ # A declaration of which security schemes are applied for the API as a whole.
267
+ # The list of values describes alternative security schemes that can be used
268
+ # (that is, there is a logical OR between the security requirements).
269
+ # Individual operations can override this definition.
270
+ sig { returns(T::Array[T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement)]) }
271
+ def security
272
+ end
273
+
274
+ # A declaration of which security schemes are applied for the API as a whole.
275
+ # The list of values describes alternative security schemes that can be used
276
+ # (that is, there is a logical OR between the security requirements).
277
+ # Individual operations can override this definition.
278
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
279
+ def security=(value)
280
+ end
281
+
282
+ # A declaration of which security schemes are applied for the API as a whole.
283
+ # The list of values describes alternative security schemes that can be used
284
+ # (that is, there is a logical OR between the security requirements).
285
+ # Individual operations can override this definition.
286
+ sig { void }
287
+ def clear_security
288
+ end
289
+
290
+ # A list of tags for API documentation control. Tags can be used for logical
291
+ # grouping of operations by resources or any other qualifier.
292
+ sig { returns(T::Array[T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Tag)]) }
293
+ def tags
294
+ end
295
+
296
+ # A list of tags for API documentation control. Tags can be used for logical
297
+ # grouping of operations by resources or any other qualifier.
298
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
299
+ def tags=(value)
300
+ end
301
+
302
+ # A list of tags for API documentation control. Tags can be used for logical
303
+ # grouping of operations by resources or any other qualifier.
304
+ sig { void }
305
+ def clear_tags
306
+ end
307
+
308
+ # Additional external documentation.
309
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)) }
310
+ def external_docs
311
+ end
312
+
313
+ # Additional external documentation.
314
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)).void }
315
+ def external_docs=(value)
316
+ end
317
+
318
+ # Additional external documentation.
319
+ sig { void }
320
+ def clear_external_docs
321
+ end
322
+
323
+ # Custom properties that start with "x-" such as "x-foo" used to describe
324
+ # extra functionality that is not covered by the standard OpenAPI Specification.
325
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
326
+ sig { returns(T::Hash[String, T.nilable(Google::Protobuf::Value)]) }
327
+ def extensions
328
+ end
329
+
330
+ # Custom properties that start with "x-" such as "x-foo" used to describe
331
+ # extra functionality that is not covered by the standard OpenAPI Specification.
332
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
333
+ sig { params(value: ::Google::Protobuf::Map).void }
334
+ def extensions=(value)
335
+ end
336
+
337
+ # Custom properties that start with "x-" such as "x-foo" used to describe
338
+ # extra functionality that is not covered by the standard OpenAPI Specification.
339
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
340
+ sig { void }
341
+ def clear_extensions
342
+ end
343
+
344
+ sig { params(field: String).returns(T.untyped) }
345
+ def [](field)
346
+ end
347
+
348
+ sig { params(field: String, value: T.untyped).void }
349
+ def []=(field, value)
350
+ end
351
+
352
+ sig { returns(T::Hash[Symbol, T.untyped]) }
353
+ def to_h
354
+ end
355
+
356
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Swagger) }
357
+ def self.decode(str)
358
+ end
359
+
360
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Swagger).returns(String) }
361
+ def self.encode(msg)
362
+ end
363
+
364
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Swagger) }
365
+ def self.decode_json(str, **kw)
366
+ end
367
+
368
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Swagger, kw: T.untyped).returns(String) }
369
+ def self.encode_json(msg, **kw)
370
+ end
371
+
372
+ sig { returns(::Google::Protobuf::Descriptor) }
373
+ def self.descriptor
374
+ end
375
+ end
376
+
377
+ # `Operation` is a representation of OpenAPI v2 specification's Operation object.
378
+ #
379
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject
380
+ #
381
+ # Example:
382
+ #
383
+ # service EchoService {
384
+ # rpc Echo(SimpleMessage) returns (SimpleMessage) {
385
+ # option (google.api.http) = {
386
+ # get: "/v1/example/echo/{id}"
387
+ # };
388
+ #
389
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
390
+ # summary: "Get a message.";
391
+ # operation_id: "getMessage";
392
+ # tags: "echo";
393
+ # responses: {
394
+ # key: "200"
395
+ # value: {
396
+ # description: "OK";
397
+ # }
398
+ # }
399
+ # };
400
+ # }
401
+ # }
402
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Operation
403
+ include ::Google::Protobuf::MessageExts
404
+ extend ::Google::Protobuf::MessageExts::ClassMethods
405
+
406
+ sig do
407
+ params(
408
+ tags: T.nilable(T::Array[String]),
409
+ summary: T.nilable(String),
410
+ description: T.nilable(String),
411
+ external_docs: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation),
412
+ operation_id: T.nilable(String),
413
+ consumes: T.nilable(T::Array[String]),
414
+ produces: T.nilable(T::Array[String]),
415
+ responses: T.nilable(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Response)]),
416
+ schemes: T.nilable(T::Array[T.any(Symbol, String, Integer)]),
417
+ deprecated: T.nilable(T::Boolean),
418
+ security: T.nilable(T::Array[T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement)]),
419
+ extensions: T.nilable(T::Hash[String, T.nilable(Google::Protobuf::Value)]),
420
+ parameters: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters)
421
+ ).void
422
+ end
423
+ def initialize(
424
+ tags: [],
425
+ summary: "",
426
+ description: "",
427
+ external_docs: nil,
428
+ operation_id: "",
429
+ consumes: [],
430
+ produces: [],
431
+ responses: ::Google::Protobuf::Map.new(:string, :message, Grpc::Gateway::ProtocGenOpenapiv2::Options::Response),
432
+ schemes: [],
433
+ deprecated: false,
434
+ security: [],
435
+ extensions: ::Google::Protobuf::Map.new(:string, :message, Google::Protobuf::Value),
436
+ parameters: nil
437
+ )
438
+ end
439
+
440
+ # A list of tags for API documentation control. Tags can be used for logical
441
+ # grouping of operations by resources or any other qualifier.
442
+ sig { returns(T::Array[String]) }
443
+ def tags
444
+ end
445
+
446
+ # A list of tags for API documentation control. Tags can be used for logical
447
+ # grouping of operations by resources or any other qualifier.
448
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
449
+ def tags=(value)
450
+ end
451
+
452
+ # A list of tags for API documentation control. Tags can be used for logical
453
+ # grouping of operations by resources or any other qualifier.
454
+ sig { void }
455
+ def clear_tags
456
+ end
457
+
458
+ # A short summary of what the operation does. For maximum readability in the
459
+ # swagger-ui, this field SHOULD be less than 120 characters.
460
+ sig { returns(String) }
461
+ def summary
462
+ end
463
+
464
+ # A short summary of what the operation does. For maximum readability in the
465
+ # swagger-ui, this field SHOULD be less than 120 characters.
466
+ sig { params(value: String).void }
467
+ def summary=(value)
468
+ end
469
+
470
+ # A short summary of what the operation does. For maximum readability in the
471
+ # swagger-ui, this field SHOULD be less than 120 characters.
472
+ sig { void }
473
+ def clear_summary
474
+ end
475
+
476
+ # A verbose explanation of the operation behavior. GFM syntax can be used for
477
+ # rich text representation.
478
+ sig { returns(String) }
479
+ def description
480
+ end
481
+
482
+ # A verbose explanation of the operation behavior. GFM syntax can be used for
483
+ # rich text representation.
484
+ sig { params(value: String).void }
485
+ def description=(value)
486
+ end
487
+
488
+ # A verbose explanation of the operation behavior. GFM syntax can be used for
489
+ # rich text representation.
490
+ sig { void }
491
+ def clear_description
492
+ end
493
+
494
+ # Additional external documentation for this operation.
495
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)) }
496
+ def external_docs
497
+ end
498
+
499
+ # Additional external documentation for this operation.
500
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)).void }
501
+ def external_docs=(value)
502
+ end
503
+
504
+ # Additional external documentation for this operation.
505
+ sig { void }
506
+ def clear_external_docs
507
+ end
508
+
509
+ # Unique string used to identify the operation. The id MUST be unique among
510
+ # all operations described in the API. Tools and libraries MAY use the
511
+ # operationId to uniquely identify an operation, therefore, it is recommended
512
+ # to follow common programming naming conventions.
513
+ sig { returns(String) }
514
+ def operation_id
515
+ end
516
+
517
+ # Unique string used to identify the operation. The id MUST be unique among
518
+ # all operations described in the API. Tools and libraries MAY use the
519
+ # operationId to uniquely identify an operation, therefore, it is recommended
520
+ # to follow common programming naming conventions.
521
+ sig { params(value: String).void }
522
+ def operation_id=(value)
523
+ end
524
+
525
+ # Unique string used to identify the operation. The id MUST be unique among
526
+ # all operations described in the API. Tools and libraries MAY use the
527
+ # operationId to uniquely identify an operation, therefore, it is recommended
528
+ # to follow common programming naming conventions.
529
+ sig { void }
530
+ def clear_operation_id
531
+ end
532
+
533
+ # A list of MIME types the operation can consume. This overrides the consumes
534
+ # definition at the OpenAPI Object. An empty value MAY be used to clear the
535
+ # global definition. Value MUST be as described under Mime Types.
536
+ sig { returns(T::Array[String]) }
537
+ def consumes
538
+ end
539
+
540
+ # A list of MIME types the operation can consume. This overrides the consumes
541
+ # definition at the OpenAPI Object. An empty value MAY be used to clear the
542
+ # global definition. Value MUST be as described under Mime Types.
543
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
544
+ def consumes=(value)
545
+ end
546
+
547
+ # A list of MIME types the operation can consume. This overrides the consumes
548
+ # definition at the OpenAPI Object. An empty value MAY be used to clear the
549
+ # global definition. Value MUST be as described under Mime Types.
550
+ sig { void }
551
+ def clear_consumes
552
+ end
553
+
554
+ # A list of MIME types the operation can produce. This overrides the produces
555
+ # definition at the OpenAPI Object. An empty value MAY be used to clear the
556
+ # global definition. Value MUST be as described under Mime Types.
557
+ sig { returns(T::Array[String]) }
558
+ def produces
559
+ end
560
+
561
+ # A list of MIME types the operation can produce. This overrides the produces
562
+ # definition at the OpenAPI Object. An empty value MAY be used to clear the
563
+ # global definition. Value MUST be as described under Mime Types.
564
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
565
+ def produces=(value)
566
+ end
567
+
568
+ # A list of MIME types the operation can produce. This overrides the produces
569
+ # definition at the OpenAPI Object. An empty value MAY be used to clear the
570
+ # global definition. Value MUST be as described under Mime Types.
571
+ sig { void }
572
+ def clear_produces
573
+ end
574
+
575
+ # The list of possible responses as they are returned from executing this
576
+ # operation.
577
+ sig { returns(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Response)]) }
578
+ def responses
579
+ end
580
+
581
+ # The list of possible responses as they are returned from executing this
582
+ # operation.
583
+ sig { params(value: ::Google::Protobuf::Map).void }
584
+ def responses=(value)
585
+ end
586
+
587
+ # The list of possible responses as they are returned from executing this
588
+ # operation.
589
+ sig { void }
590
+ def clear_responses
591
+ end
592
+
593
+ # The transfer protocol for the operation. Values MUST be from the list:
594
+ # "http", "https", "ws", "wss". The value overrides the OpenAPI Object
595
+ # schemes definition.
596
+ sig { returns(T::Array[T.any(Symbol, Integer)]) }
597
+ def schemes
598
+ end
599
+
600
+ # The transfer protocol for the operation. Values MUST be from the list:
601
+ # "http", "https", "ws", "wss". The value overrides the OpenAPI Object
602
+ # schemes definition.
603
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
604
+ def schemes=(value)
605
+ end
606
+
607
+ # The transfer protocol for the operation. Values MUST be from the list:
608
+ # "http", "https", "ws", "wss". The value overrides the OpenAPI Object
609
+ # schemes definition.
610
+ sig { void }
611
+ def clear_schemes
612
+ end
613
+
614
+ # Declares this operation to be deprecated. Usage of the declared operation
615
+ # should be refrained. Default value is false.
616
+ sig { returns(T::Boolean) }
617
+ def deprecated
618
+ end
619
+
620
+ # Declares this operation to be deprecated. Usage of the declared operation
621
+ # should be refrained. Default value is false.
622
+ sig { params(value: T::Boolean).void }
623
+ def deprecated=(value)
624
+ end
625
+
626
+ # Declares this operation to be deprecated. Usage of the declared operation
627
+ # should be refrained. Default value is false.
628
+ sig { void }
629
+ def clear_deprecated
630
+ end
631
+
632
+ # A declaration of which security schemes are applied for this operation. The
633
+ # list of values describes alternative security schemes that can be used
634
+ # (that is, there is a logical OR between the security requirements). This
635
+ # definition overrides any declared top-level security. To remove a top-level
636
+ # security declaration, an empty array can be used.
637
+ sig { returns(T::Array[T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement)]) }
638
+ def security
639
+ end
640
+
641
+ # A declaration of which security schemes are applied for this operation. The
642
+ # list of values describes alternative security schemes that can be used
643
+ # (that is, there is a logical OR between the security requirements). This
644
+ # definition overrides any declared top-level security. To remove a top-level
645
+ # security declaration, an empty array can be used.
646
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
647
+ def security=(value)
648
+ end
649
+
650
+ # A declaration of which security schemes are applied for this operation. The
651
+ # list of values describes alternative security schemes that can be used
652
+ # (that is, there is a logical OR between the security requirements). This
653
+ # definition overrides any declared top-level security. To remove a top-level
654
+ # security declaration, an empty array can be used.
655
+ sig { void }
656
+ def clear_security
657
+ end
658
+
659
+ # Custom properties that start with "x-" such as "x-foo" used to describe
660
+ # extra functionality that is not covered by the standard OpenAPI Specification.
661
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
662
+ sig { returns(T::Hash[String, T.nilable(Google::Protobuf::Value)]) }
663
+ def extensions
664
+ end
665
+
666
+ # Custom properties that start with "x-" such as "x-foo" used to describe
667
+ # extra functionality that is not covered by the standard OpenAPI Specification.
668
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
669
+ sig { params(value: ::Google::Protobuf::Map).void }
670
+ def extensions=(value)
671
+ end
672
+
673
+ # Custom properties that start with "x-" such as "x-foo" used to describe
674
+ # extra functionality that is not covered by the standard OpenAPI Specification.
675
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
676
+ sig { void }
677
+ def clear_extensions
678
+ end
679
+
680
+ # Custom parameters such as HTTP request headers.
681
+ # See: https://swagger.io/docs/specification/2-0/describing-parameters/
682
+ # and https://swagger.io/specification/v2/#parameter-object.
683
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters)) }
684
+ def parameters
685
+ end
686
+
687
+ # Custom parameters such as HTTP request headers.
688
+ # See: https://swagger.io/docs/specification/2-0/describing-parameters/
689
+ # and https://swagger.io/specification/v2/#parameter-object.
690
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters)).void }
691
+ def parameters=(value)
692
+ end
693
+
694
+ # Custom parameters such as HTTP request headers.
695
+ # See: https://swagger.io/docs/specification/2-0/describing-parameters/
696
+ # and https://swagger.io/specification/v2/#parameter-object.
697
+ sig { void }
698
+ def clear_parameters
699
+ end
700
+
701
+ sig { params(field: String).returns(T.untyped) }
702
+ def [](field)
703
+ end
704
+
705
+ sig { params(field: String, value: T.untyped).void }
706
+ def []=(field, value)
707
+ end
708
+
709
+ sig { returns(T::Hash[Symbol, T.untyped]) }
710
+ def to_h
711
+ end
712
+
713
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Operation) }
714
+ def self.decode(str)
715
+ end
716
+
717
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Operation).returns(String) }
718
+ def self.encode(msg)
719
+ end
720
+
721
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Operation) }
722
+ def self.decode_json(str, **kw)
723
+ end
724
+
725
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Operation, kw: T.untyped).returns(String) }
726
+ def self.encode_json(msg, **kw)
727
+ end
728
+
729
+ sig { returns(::Google::Protobuf::Descriptor) }
730
+ def self.descriptor
731
+ end
732
+ end
733
+
734
+ # `Parameters` is a representation of OpenAPI v2 specification's parameters object.
735
+ # Note: This technically breaks compatibility with the OpenAPI 2 definition structure as we only
736
+ # allow header parameters to be set here since we do not want users specifying custom non-header
737
+ # parameters beyond those inferred from the Protobuf schema.
738
+ # See: https://swagger.io/specification/v2/#parameter-object
739
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters
740
+ include ::Google::Protobuf::MessageExts
741
+ extend ::Google::Protobuf::MessageExts::ClassMethods
742
+
743
+ sig do
744
+ params(
745
+ headers: T.nilable(T::Array[T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter)])
746
+ ).void
747
+ end
748
+ def initialize(
749
+ headers: []
750
+ )
751
+ end
752
+
753
+ # `Headers` is one or more HTTP header parameter.
754
+ # See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
755
+ sig { returns(T::Array[T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter)]) }
756
+ def headers
757
+ end
758
+
759
+ # `Headers` is one or more HTTP header parameter.
760
+ # See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
761
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
762
+ def headers=(value)
763
+ end
764
+
765
+ # `Headers` is one or more HTTP header parameter.
766
+ # See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
767
+ sig { void }
768
+ def clear_headers
769
+ end
770
+
771
+ sig { params(field: String).returns(T.untyped) }
772
+ def [](field)
773
+ end
774
+
775
+ sig { params(field: String, value: T.untyped).void }
776
+ def []=(field, value)
777
+ end
778
+
779
+ sig { returns(T::Hash[Symbol, T.untyped]) }
780
+ def to_h
781
+ end
782
+
783
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters) }
784
+ def self.decode(str)
785
+ end
786
+
787
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters).returns(String) }
788
+ def self.encode(msg)
789
+ end
790
+
791
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters) }
792
+ def self.decode_json(str, **kw)
793
+ end
794
+
795
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters, kw: T.untyped).returns(String) }
796
+ def self.encode_json(msg, **kw)
797
+ end
798
+
799
+ sig { returns(::Google::Protobuf::Descriptor) }
800
+ def self.descriptor
801
+ end
802
+ end
803
+
804
+ # `HeaderParameter` a HTTP header parameter.
805
+ # See: https://swagger.io/specification/v2/#parameter-object
806
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter
807
+ include ::Google::Protobuf::MessageExts
808
+ extend ::Google::Protobuf::MessageExts::ClassMethods
809
+
810
+ sig do
811
+ params(
812
+ name: T.nilable(String),
813
+ description: T.nilable(String),
814
+ type: T.nilable(T.any(Symbol, String, Integer)),
815
+ format: T.nilable(String),
816
+ required: T.nilable(T::Boolean)
817
+ ).void
818
+ end
819
+ def initialize(
820
+ name: "",
821
+ description: "",
822
+ type: :UNKNOWN,
823
+ format: "",
824
+ required: false
825
+ )
826
+ end
827
+
828
+ # `Name` is the header name.
829
+ sig { returns(String) }
830
+ def name
831
+ end
832
+
833
+ # `Name` is the header name.
834
+ sig { params(value: String).void }
835
+ def name=(value)
836
+ end
837
+
838
+ # `Name` is the header name.
839
+ sig { void }
840
+ def clear_name
841
+ end
842
+
843
+ # `Description` is a short description of the header.
844
+ sig { returns(String) }
845
+ def description
846
+ end
847
+
848
+ # `Description` is a short description of the header.
849
+ sig { params(value: String).void }
850
+ def description=(value)
851
+ end
852
+
853
+ # `Description` is a short description of the header.
854
+ sig { void }
855
+ def clear_description
856
+ end
857
+
858
+ # `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
859
+ # See: https://swagger.io/specification/v2/#parameterType.
860
+ sig { returns(T.any(Symbol, Integer)) }
861
+ def type
862
+ end
863
+
864
+ # `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
865
+ # See: https://swagger.io/specification/v2/#parameterType.
866
+ sig { params(value: T.any(Symbol, String, Integer)).void }
867
+ def type=(value)
868
+ end
869
+
870
+ # `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
871
+ # See: https://swagger.io/specification/v2/#parameterType.
872
+ sig { void }
873
+ def clear_type
874
+ end
875
+
876
+ # `Format` The extending format for the previously mentioned type.
877
+ sig { returns(String) }
878
+ def format
879
+ end
880
+
881
+ # `Format` The extending format for the previously mentioned type.
882
+ sig { params(value: String).void }
883
+ def format=(value)
884
+ end
885
+
886
+ # `Format` The extending format for the previously mentioned type.
887
+ sig { void }
888
+ def clear_format
889
+ end
890
+
891
+ # `Required` indicates if the header is optional
892
+ sig { returns(T::Boolean) }
893
+ def required
894
+ end
895
+
896
+ # `Required` indicates if the header is optional
897
+ sig { params(value: T::Boolean).void }
898
+ def required=(value)
899
+ end
900
+
901
+ # `Required` indicates if the header is optional
902
+ sig { void }
903
+ def clear_required
904
+ end
905
+
906
+ sig { params(field: String).returns(T.untyped) }
907
+ def [](field)
908
+ end
909
+
910
+ sig { params(field: String, value: T.untyped).void }
911
+ def []=(field, value)
912
+ end
913
+
914
+ sig { returns(T::Hash[Symbol, T.untyped]) }
915
+ def to_h
916
+ end
917
+
918
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter) }
919
+ def self.decode(str)
920
+ end
921
+
922
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter).returns(String) }
923
+ def self.encode(msg)
924
+ end
925
+
926
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter) }
927
+ def self.decode_json(str, **kw)
928
+ end
929
+
930
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter, kw: T.untyped).returns(String) }
931
+ def self.encode_json(msg, **kw)
932
+ end
933
+
934
+ sig { returns(::Google::Protobuf::Descriptor) }
935
+ def self.descriptor
936
+ end
937
+ end
938
+
939
+ # `Header` is a representation of OpenAPI v2 specification's Header object.
940
+ #
941
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject
942
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Header
943
+ include ::Google::Protobuf::MessageExts
944
+ extend ::Google::Protobuf::MessageExts::ClassMethods
945
+
946
+ sig do
947
+ params(
948
+ description: T.nilable(String),
949
+ type: T.nilable(String),
950
+ format: T.nilable(String),
951
+ default: T.nilable(String),
952
+ pattern: T.nilable(String)
953
+ ).void
954
+ end
955
+ def initialize(
956
+ description: "",
957
+ type: "",
958
+ format: "",
959
+ default: "",
960
+ pattern: ""
961
+ )
962
+ end
963
+
964
+ # `Description` is a short description of the header.
965
+ sig { returns(String) }
966
+ def description
967
+ end
968
+
969
+ # `Description` is a short description of the header.
970
+ sig { params(value: String).void }
971
+ def description=(value)
972
+ end
973
+
974
+ # `Description` is a short description of the header.
975
+ sig { void }
976
+ def clear_description
977
+ end
978
+
979
+ # The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
980
+ sig { returns(String) }
981
+ def type
982
+ end
983
+
984
+ # The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
985
+ sig { params(value: String).void }
986
+ def type=(value)
987
+ end
988
+
989
+ # The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
990
+ sig { void }
991
+ def clear_type
992
+ end
993
+
994
+ # `Format` The extending format for the previously mentioned type.
995
+ sig { returns(String) }
996
+ def format
997
+ end
998
+
999
+ # `Format` The extending format for the previously mentioned type.
1000
+ sig { params(value: String).void }
1001
+ def format=(value)
1002
+ end
1003
+
1004
+ # `Format` The extending format for the previously mentioned type.
1005
+ sig { void }
1006
+ def clear_format
1007
+ end
1008
+
1009
+ # `Default` Declares the value of the header that the server will use if none is provided.
1010
+ # See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
1011
+ # Unlike JSON Schema this value MUST conform to the defined type for the header.
1012
+ sig { returns(String) }
1013
+ def default
1014
+ end
1015
+
1016
+ # `Default` Declares the value of the header that the server will use if none is provided.
1017
+ # See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
1018
+ # Unlike JSON Schema this value MUST conform to the defined type for the header.
1019
+ sig { params(value: String).void }
1020
+ def default=(value)
1021
+ end
1022
+
1023
+ # `Default` Declares the value of the header that the server will use if none is provided.
1024
+ # See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
1025
+ # Unlike JSON Schema this value MUST conform to the defined type for the header.
1026
+ sig { void }
1027
+ def clear_default
1028
+ end
1029
+
1030
+ # 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
1031
+ sig { returns(String) }
1032
+ def pattern
1033
+ end
1034
+
1035
+ # 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
1036
+ sig { params(value: String).void }
1037
+ def pattern=(value)
1038
+ end
1039
+
1040
+ # 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
1041
+ sig { void }
1042
+ def clear_pattern
1043
+ end
1044
+
1045
+ sig { params(field: String).returns(T.untyped) }
1046
+ def [](field)
1047
+ end
1048
+
1049
+ sig { params(field: String, value: T.untyped).void }
1050
+ def []=(field, value)
1051
+ end
1052
+
1053
+ sig { returns(T::Hash[Symbol, T.untyped]) }
1054
+ def to_h
1055
+ end
1056
+
1057
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Header) }
1058
+ def self.decode(str)
1059
+ end
1060
+
1061
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Header).returns(String) }
1062
+ def self.encode(msg)
1063
+ end
1064
+
1065
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Header) }
1066
+ def self.decode_json(str, **kw)
1067
+ end
1068
+
1069
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Header, kw: T.untyped).returns(String) }
1070
+ def self.encode_json(msg, **kw)
1071
+ end
1072
+
1073
+ sig { returns(::Google::Protobuf::Descriptor) }
1074
+ def self.descriptor
1075
+ end
1076
+ end
1077
+
1078
+ # `Response` is a representation of OpenAPI v2 specification's Response object.
1079
+ #
1080
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject
1081
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Response
1082
+ include ::Google::Protobuf::MessageExts
1083
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1084
+
1085
+ sig do
1086
+ params(
1087
+ description: T.nilable(String),
1088
+ schema: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema),
1089
+ headers: T.nilable(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Header)]),
1090
+ examples: T.nilable(T::Hash[String, String]),
1091
+ extensions: T.nilable(T::Hash[String, T.nilable(Google::Protobuf::Value)])
1092
+ ).void
1093
+ end
1094
+ def initialize(
1095
+ description: "",
1096
+ schema: nil,
1097
+ headers: ::Google::Protobuf::Map.new(:string, :message, Grpc::Gateway::ProtocGenOpenapiv2::Options::Header),
1098
+ examples: ::Google::Protobuf::Map.new(:string, :string),
1099
+ extensions: ::Google::Protobuf::Map.new(:string, :message, Google::Protobuf::Value)
1100
+ )
1101
+ end
1102
+
1103
+ # `Description` is a short description of the response.
1104
+ # GFM syntax can be used for rich text representation.
1105
+ sig { returns(String) }
1106
+ def description
1107
+ end
1108
+
1109
+ # `Description` is a short description of the response.
1110
+ # GFM syntax can be used for rich text representation.
1111
+ sig { params(value: String).void }
1112
+ def description=(value)
1113
+ end
1114
+
1115
+ # `Description` is a short description of the response.
1116
+ # GFM syntax can be used for rich text representation.
1117
+ sig { void }
1118
+ def clear_description
1119
+ end
1120
+
1121
+ # `Schema` optionally defines the structure of the response.
1122
+ # If `Schema` is not provided, it means there is no content to the response.
1123
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema)) }
1124
+ def schema
1125
+ end
1126
+
1127
+ # `Schema` optionally defines the structure of the response.
1128
+ # If `Schema` is not provided, it means there is no content to the response.
1129
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema)).void }
1130
+ def schema=(value)
1131
+ end
1132
+
1133
+ # `Schema` optionally defines the structure of the response.
1134
+ # If `Schema` is not provided, it means there is no content to the response.
1135
+ sig { void }
1136
+ def clear_schema
1137
+ end
1138
+
1139
+ # `Headers` A list of headers that are sent with the response.
1140
+ # `Header` name is expected to be a string in the canonical format of the MIME header key
1141
+ # See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
1142
+ sig { returns(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Header)]) }
1143
+ def headers
1144
+ end
1145
+
1146
+ # `Headers` A list of headers that are sent with the response.
1147
+ # `Header` name is expected to be a string in the canonical format of the MIME header key
1148
+ # See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
1149
+ sig { params(value: ::Google::Protobuf::Map).void }
1150
+ def headers=(value)
1151
+ end
1152
+
1153
+ # `Headers` A list of headers that are sent with the response.
1154
+ # `Header` name is expected to be a string in the canonical format of the MIME header key
1155
+ # See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
1156
+ sig { void }
1157
+ def clear_headers
1158
+ end
1159
+
1160
+ # `Examples` gives per-mimetype response examples.
1161
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
1162
+ sig { returns(T::Hash[String, String]) }
1163
+ def examples
1164
+ end
1165
+
1166
+ # `Examples` gives per-mimetype response examples.
1167
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
1168
+ sig { params(value: ::Google::Protobuf::Map).void }
1169
+ def examples=(value)
1170
+ end
1171
+
1172
+ # `Examples` gives per-mimetype response examples.
1173
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
1174
+ sig { void }
1175
+ def clear_examples
1176
+ end
1177
+
1178
+ # Custom properties that start with "x-" such as "x-foo" used to describe
1179
+ # extra functionality that is not covered by the standard OpenAPI Specification.
1180
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1181
+ sig { returns(T::Hash[String, T.nilable(Google::Protobuf::Value)]) }
1182
+ def extensions
1183
+ end
1184
+
1185
+ # Custom properties that start with "x-" such as "x-foo" used to describe
1186
+ # extra functionality that is not covered by the standard OpenAPI Specification.
1187
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1188
+ sig { params(value: ::Google::Protobuf::Map).void }
1189
+ def extensions=(value)
1190
+ end
1191
+
1192
+ # Custom properties that start with "x-" such as "x-foo" used to describe
1193
+ # extra functionality that is not covered by the standard OpenAPI Specification.
1194
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1195
+ sig { void }
1196
+ def clear_extensions
1197
+ end
1198
+
1199
+ sig { params(field: String).returns(T.untyped) }
1200
+ def [](field)
1201
+ end
1202
+
1203
+ sig { params(field: String, value: T.untyped).void }
1204
+ def []=(field, value)
1205
+ end
1206
+
1207
+ sig { returns(T::Hash[Symbol, T.untyped]) }
1208
+ def to_h
1209
+ end
1210
+
1211
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Response) }
1212
+ def self.decode(str)
1213
+ end
1214
+
1215
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Response).returns(String) }
1216
+ def self.encode(msg)
1217
+ end
1218
+
1219
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Response) }
1220
+ def self.decode_json(str, **kw)
1221
+ end
1222
+
1223
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Response, kw: T.untyped).returns(String) }
1224
+ def self.encode_json(msg, **kw)
1225
+ end
1226
+
1227
+ sig { returns(::Google::Protobuf::Descriptor) }
1228
+ def self.descriptor
1229
+ end
1230
+ end
1231
+
1232
+ # `Info` is a representation of OpenAPI v2 specification's Info object.
1233
+ #
1234
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject
1235
+ #
1236
+ # Example:
1237
+ #
1238
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
1239
+ # info: {
1240
+ # title: "Echo API";
1241
+ # version: "1.0";
1242
+ # description: "";
1243
+ # contact: {
1244
+ # name: "gRPC-Gateway project";
1245
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway";
1246
+ # email: "none@example.com";
1247
+ # };
1248
+ # license: {
1249
+ # name: "BSD 3-Clause License";
1250
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
1251
+ # };
1252
+ # };
1253
+ # ...
1254
+ # };
1255
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Info
1256
+ include ::Google::Protobuf::MessageExts
1257
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1258
+
1259
+ sig do
1260
+ params(
1261
+ title: T.nilable(String),
1262
+ description: T.nilable(String),
1263
+ terms_of_service: T.nilable(String),
1264
+ contact: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact),
1265
+ license: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::License),
1266
+ version: T.nilable(String),
1267
+ extensions: T.nilable(T::Hash[String, T.nilable(Google::Protobuf::Value)])
1268
+ ).void
1269
+ end
1270
+ def initialize(
1271
+ title: "",
1272
+ description: "",
1273
+ terms_of_service: "",
1274
+ contact: nil,
1275
+ license: nil,
1276
+ version: "",
1277
+ extensions: ::Google::Protobuf::Map.new(:string, :message, Google::Protobuf::Value)
1278
+ )
1279
+ end
1280
+
1281
+ # The title of the application.
1282
+ sig { returns(String) }
1283
+ def title
1284
+ end
1285
+
1286
+ # The title of the application.
1287
+ sig { params(value: String).void }
1288
+ def title=(value)
1289
+ end
1290
+
1291
+ # The title of the application.
1292
+ sig { void }
1293
+ def clear_title
1294
+ end
1295
+
1296
+ # A short description of the application. GFM syntax can be used for rich
1297
+ # text representation.
1298
+ sig { returns(String) }
1299
+ def description
1300
+ end
1301
+
1302
+ # A short description of the application. GFM syntax can be used for rich
1303
+ # text representation.
1304
+ sig { params(value: String).void }
1305
+ def description=(value)
1306
+ end
1307
+
1308
+ # A short description of the application. GFM syntax can be used for rich
1309
+ # text representation.
1310
+ sig { void }
1311
+ def clear_description
1312
+ end
1313
+
1314
+ # The Terms of Service for the API.
1315
+ sig { returns(String) }
1316
+ def terms_of_service
1317
+ end
1318
+
1319
+ # The Terms of Service for the API.
1320
+ sig { params(value: String).void }
1321
+ def terms_of_service=(value)
1322
+ end
1323
+
1324
+ # The Terms of Service for the API.
1325
+ sig { void }
1326
+ def clear_terms_of_service
1327
+ end
1328
+
1329
+ # The contact information for the exposed API.
1330
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact)) }
1331
+ def contact
1332
+ end
1333
+
1334
+ # The contact information for the exposed API.
1335
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact)).void }
1336
+ def contact=(value)
1337
+ end
1338
+
1339
+ # The contact information for the exposed API.
1340
+ sig { void }
1341
+ def clear_contact
1342
+ end
1343
+
1344
+ # The license information for the exposed API.
1345
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::License)) }
1346
+ def license
1347
+ end
1348
+
1349
+ # The license information for the exposed API.
1350
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::License)).void }
1351
+ def license=(value)
1352
+ end
1353
+
1354
+ # The license information for the exposed API.
1355
+ sig { void }
1356
+ def clear_license
1357
+ end
1358
+
1359
+ # Provides the version of the application API (not to be confused
1360
+ # with the specification version).
1361
+ sig { returns(String) }
1362
+ def version
1363
+ end
1364
+
1365
+ # Provides the version of the application API (not to be confused
1366
+ # with the specification version).
1367
+ sig { params(value: String).void }
1368
+ def version=(value)
1369
+ end
1370
+
1371
+ # Provides the version of the application API (not to be confused
1372
+ # with the specification version).
1373
+ sig { void }
1374
+ def clear_version
1375
+ end
1376
+
1377
+ # Custom properties that start with "x-" such as "x-foo" used to describe
1378
+ # extra functionality that is not covered by the standard OpenAPI Specification.
1379
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1380
+ sig { returns(T::Hash[String, T.nilable(Google::Protobuf::Value)]) }
1381
+ def extensions
1382
+ end
1383
+
1384
+ # Custom properties that start with "x-" such as "x-foo" used to describe
1385
+ # extra functionality that is not covered by the standard OpenAPI Specification.
1386
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1387
+ sig { params(value: ::Google::Protobuf::Map).void }
1388
+ def extensions=(value)
1389
+ end
1390
+
1391
+ # Custom properties that start with "x-" such as "x-foo" used to describe
1392
+ # extra functionality that is not covered by the standard OpenAPI Specification.
1393
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1394
+ sig { void }
1395
+ def clear_extensions
1396
+ end
1397
+
1398
+ sig { params(field: String).returns(T.untyped) }
1399
+ def [](field)
1400
+ end
1401
+
1402
+ sig { params(field: String, value: T.untyped).void }
1403
+ def []=(field, value)
1404
+ end
1405
+
1406
+ sig { returns(T::Hash[Symbol, T.untyped]) }
1407
+ def to_h
1408
+ end
1409
+
1410
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Info) }
1411
+ def self.decode(str)
1412
+ end
1413
+
1414
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Info).returns(String) }
1415
+ def self.encode(msg)
1416
+ end
1417
+
1418
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Info) }
1419
+ def self.decode_json(str, **kw)
1420
+ end
1421
+
1422
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Info, kw: T.untyped).returns(String) }
1423
+ def self.encode_json(msg, **kw)
1424
+ end
1425
+
1426
+ sig { returns(::Google::Protobuf::Descriptor) }
1427
+ def self.descriptor
1428
+ end
1429
+ end
1430
+
1431
+ # `Contact` is a representation of OpenAPI v2 specification's Contact object.
1432
+ #
1433
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#contactObject
1434
+ #
1435
+ # Example:
1436
+ #
1437
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
1438
+ # info: {
1439
+ # ...
1440
+ # contact: {
1441
+ # name: "gRPC-Gateway project";
1442
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway";
1443
+ # email: "none@example.com";
1444
+ # };
1445
+ # ...
1446
+ # };
1447
+ # ...
1448
+ # };
1449
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact
1450
+ include ::Google::Protobuf::MessageExts
1451
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1452
+
1453
+ sig do
1454
+ params(
1455
+ name: T.nilable(String),
1456
+ url: T.nilable(String),
1457
+ email: T.nilable(String)
1458
+ ).void
1459
+ end
1460
+ def initialize(
1461
+ name: "",
1462
+ url: "",
1463
+ email: ""
1464
+ )
1465
+ end
1466
+
1467
+ # The identifying name of the contact person/organization.
1468
+ sig { returns(String) }
1469
+ def name
1470
+ end
1471
+
1472
+ # The identifying name of the contact person/organization.
1473
+ sig { params(value: String).void }
1474
+ def name=(value)
1475
+ end
1476
+
1477
+ # The identifying name of the contact person/organization.
1478
+ sig { void }
1479
+ def clear_name
1480
+ end
1481
+
1482
+ # The URL pointing to the contact information. MUST be in the format of a
1483
+ # URL.
1484
+ sig { returns(String) }
1485
+ def url
1486
+ end
1487
+
1488
+ # The URL pointing to the contact information. MUST be in the format of a
1489
+ # URL.
1490
+ sig { params(value: String).void }
1491
+ def url=(value)
1492
+ end
1493
+
1494
+ # The URL pointing to the contact information. MUST be in the format of a
1495
+ # URL.
1496
+ sig { void }
1497
+ def clear_url
1498
+ end
1499
+
1500
+ # The email address of the contact person/organization. MUST be in the format
1501
+ # of an email address.
1502
+ sig { returns(String) }
1503
+ def email
1504
+ end
1505
+
1506
+ # The email address of the contact person/organization. MUST be in the format
1507
+ # of an email address.
1508
+ sig { params(value: String).void }
1509
+ def email=(value)
1510
+ end
1511
+
1512
+ # The email address of the contact person/organization. MUST be in the format
1513
+ # of an email address.
1514
+ sig { void }
1515
+ def clear_email
1516
+ end
1517
+
1518
+ sig { params(field: String).returns(T.untyped) }
1519
+ def [](field)
1520
+ end
1521
+
1522
+ sig { params(field: String, value: T.untyped).void }
1523
+ def []=(field, value)
1524
+ end
1525
+
1526
+ sig { returns(T::Hash[Symbol, T.untyped]) }
1527
+ def to_h
1528
+ end
1529
+
1530
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact) }
1531
+ def self.decode(str)
1532
+ end
1533
+
1534
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact).returns(String) }
1535
+ def self.encode(msg)
1536
+ end
1537
+
1538
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact) }
1539
+ def self.decode_json(str, **kw)
1540
+ end
1541
+
1542
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact, kw: T.untyped).returns(String) }
1543
+ def self.encode_json(msg, **kw)
1544
+ end
1545
+
1546
+ sig { returns(::Google::Protobuf::Descriptor) }
1547
+ def self.descriptor
1548
+ end
1549
+ end
1550
+
1551
+ # `License` is a representation of OpenAPI v2 specification's License object.
1552
+ #
1553
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#licenseObject
1554
+ #
1555
+ # Example:
1556
+ #
1557
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
1558
+ # info: {
1559
+ # ...
1560
+ # license: {
1561
+ # name: "BSD 3-Clause License";
1562
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
1563
+ # };
1564
+ # ...
1565
+ # };
1566
+ # ...
1567
+ # };
1568
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::License
1569
+ include ::Google::Protobuf::MessageExts
1570
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1571
+
1572
+ sig do
1573
+ params(
1574
+ name: T.nilable(String),
1575
+ url: T.nilable(String)
1576
+ ).void
1577
+ end
1578
+ def initialize(
1579
+ name: "",
1580
+ url: ""
1581
+ )
1582
+ end
1583
+
1584
+ # The license name used for the API.
1585
+ sig { returns(String) }
1586
+ def name
1587
+ end
1588
+
1589
+ # The license name used for the API.
1590
+ sig { params(value: String).void }
1591
+ def name=(value)
1592
+ end
1593
+
1594
+ # The license name used for the API.
1595
+ sig { void }
1596
+ def clear_name
1597
+ end
1598
+
1599
+ # A URL to the license used for the API. MUST be in the format of a URL.
1600
+ sig { returns(String) }
1601
+ def url
1602
+ end
1603
+
1604
+ # A URL to the license used for the API. MUST be in the format of a URL.
1605
+ sig { params(value: String).void }
1606
+ def url=(value)
1607
+ end
1608
+
1609
+ # A URL to the license used for the API. MUST be in the format of a URL.
1610
+ sig { void }
1611
+ def clear_url
1612
+ end
1613
+
1614
+ sig { params(field: String).returns(T.untyped) }
1615
+ def [](field)
1616
+ end
1617
+
1618
+ sig { params(field: String, value: T.untyped).void }
1619
+ def []=(field, value)
1620
+ end
1621
+
1622
+ sig { returns(T::Hash[Symbol, T.untyped]) }
1623
+ def to_h
1624
+ end
1625
+
1626
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::License) }
1627
+ def self.decode(str)
1628
+ end
1629
+
1630
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::License).returns(String) }
1631
+ def self.encode(msg)
1632
+ end
1633
+
1634
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::License) }
1635
+ def self.decode_json(str, **kw)
1636
+ end
1637
+
1638
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::License, kw: T.untyped).returns(String) }
1639
+ def self.encode_json(msg, **kw)
1640
+ end
1641
+
1642
+ sig { returns(::Google::Protobuf::Descriptor) }
1643
+ def self.descriptor
1644
+ end
1645
+ end
1646
+
1647
+ # `ExternalDocumentation` is a representation of OpenAPI v2 specification's
1648
+ # ExternalDocumentation object.
1649
+ #
1650
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject
1651
+ #
1652
+ # Example:
1653
+ #
1654
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
1655
+ # ...
1656
+ # external_docs: {
1657
+ # description: "More about gRPC-Gateway";
1658
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway";
1659
+ # }
1660
+ # ...
1661
+ # };
1662
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation
1663
+ include ::Google::Protobuf::MessageExts
1664
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1665
+
1666
+ sig do
1667
+ params(
1668
+ description: T.nilable(String),
1669
+ url: T.nilable(String)
1670
+ ).void
1671
+ end
1672
+ def initialize(
1673
+ description: "",
1674
+ url: ""
1675
+ )
1676
+ end
1677
+
1678
+ # A short description of the target documentation. GFM syntax can be used for
1679
+ # rich text representation.
1680
+ sig { returns(String) }
1681
+ def description
1682
+ end
1683
+
1684
+ # A short description of the target documentation. GFM syntax can be used for
1685
+ # rich text representation.
1686
+ sig { params(value: String).void }
1687
+ def description=(value)
1688
+ end
1689
+
1690
+ # A short description of the target documentation. GFM syntax can be used for
1691
+ # rich text representation.
1692
+ sig { void }
1693
+ def clear_description
1694
+ end
1695
+
1696
+ # The URL for the target documentation. Value MUST be in the format
1697
+ # of a URL.
1698
+ sig { returns(String) }
1699
+ def url
1700
+ end
1701
+
1702
+ # The URL for the target documentation. Value MUST be in the format
1703
+ # of a URL.
1704
+ sig { params(value: String).void }
1705
+ def url=(value)
1706
+ end
1707
+
1708
+ # The URL for the target documentation. Value MUST be in the format
1709
+ # of a URL.
1710
+ sig { void }
1711
+ def clear_url
1712
+ end
1713
+
1714
+ sig { params(field: String).returns(T.untyped) }
1715
+ def [](field)
1716
+ end
1717
+
1718
+ sig { params(field: String, value: T.untyped).void }
1719
+ def []=(field, value)
1720
+ end
1721
+
1722
+ sig { returns(T::Hash[Symbol, T.untyped]) }
1723
+ def to_h
1724
+ end
1725
+
1726
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation) }
1727
+ def self.decode(str)
1728
+ end
1729
+
1730
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation).returns(String) }
1731
+ def self.encode(msg)
1732
+ end
1733
+
1734
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation) }
1735
+ def self.decode_json(str, **kw)
1736
+ end
1737
+
1738
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation, kw: T.untyped).returns(String) }
1739
+ def self.encode_json(msg, **kw)
1740
+ end
1741
+
1742
+ sig { returns(::Google::Protobuf::Descriptor) }
1743
+ def self.descriptor
1744
+ end
1745
+ end
1746
+
1747
+ # `Schema` is a representation of OpenAPI v2 specification's Schema object.
1748
+ #
1749
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
1750
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema
1751
+ include ::Google::Protobuf::MessageExts
1752
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1753
+
1754
+ sig do
1755
+ params(
1756
+ json_schema: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema),
1757
+ discriminator: T.nilable(String),
1758
+ read_only: T.nilable(T::Boolean),
1759
+ external_docs: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation),
1760
+ example: T.nilable(String)
1761
+ ).void
1762
+ end
1763
+ def initialize(
1764
+ json_schema: nil,
1765
+ discriminator: "",
1766
+ read_only: false,
1767
+ external_docs: nil,
1768
+ example: ""
1769
+ )
1770
+ end
1771
+
1772
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema)) }
1773
+ def json_schema
1774
+ end
1775
+
1776
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema)).void }
1777
+ def json_schema=(value)
1778
+ end
1779
+
1780
+ sig { void }
1781
+ def clear_json_schema
1782
+ end
1783
+
1784
+ # Adds support for polymorphism. The discriminator is the schema property
1785
+ # name that is used to differentiate between other schema that inherit this
1786
+ # schema. The property name used MUST be defined at this schema and it MUST
1787
+ # be in the required property list. When used, the value MUST be the name of
1788
+ # this schema or any schema that inherits it.
1789
+ sig { returns(String) }
1790
+ def discriminator
1791
+ end
1792
+
1793
+ # Adds support for polymorphism. The discriminator is the schema property
1794
+ # name that is used to differentiate between other schema that inherit this
1795
+ # schema. The property name used MUST be defined at this schema and it MUST
1796
+ # be in the required property list. When used, the value MUST be the name of
1797
+ # this schema or any schema that inherits it.
1798
+ sig { params(value: String).void }
1799
+ def discriminator=(value)
1800
+ end
1801
+
1802
+ # Adds support for polymorphism. The discriminator is the schema property
1803
+ # name that is used to differentiate between other schema that inherit this
1804
+ # schema. The property name used MUST be defined at this schema and it MUST
1805
+ # be in the required property list. When used, the value MUST be the name of
1806
+ # this schema or any schema that inherits it.
1807
+ sig { void }
1808
+ def clear_discriminator
1809
+ end
1810
+
1811
+ # Relevant only for Schema "properties" definitions. Declares the property as
1812
+ # "read only". This means that it MAY be sent as part of a response but MUST
1813
+ # NOT be sent as part of the request. Properties marked as readOnly being
1814
+ # true SHOULD NOT be in the required list of the defined schema. Default
1815
+ # value is false.
1816
+ sig { returns(T::Boolean) }
1817
+ def read_only
1818
+ end
1819
+
1820
+ # Relevant only for Schema "properties" definitions. Declares the property as
1821
+ # "read only". This means that it MAY be sent as part of a response but MUST
1822
+ # NOT be sent as part of the request. Properties marked as readOnly being
1823
+ # true SHOULD NOT be in the required list of the defined schema. Default
1824
+ # value is false.
1825
+ sig { params(value: T::Boolean).void }
1826
+ def read_only=(value)
1827
+ end
1828
+
1829
+ # Relevant only for Schema "properties" definitions. Declares the property as
1830
+ # "read only". This means that it MAY be sent as part of a response but MUST
1831
+ # NOT be sent as part of the request. Properties marked as readOnly being
1832
+ # true SHOULD NOT be in the required list of the defined schema. Default
1833
+ # value is false.
1834
+ sig { void }
1835
+ def clear_read_only
1836
+ end
1837
+
1838
+ # Additional external documentation for this schema.
1839
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)) }
1840
+ def external_docs
1841
+ end
1842
+
1843
+ # Additional external documentation for this schema.
1844
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)).void }
1845
+ def external_docs=(value)
1846
+ end
1847
+
1848
+ # Additional external documentation for this schema.
1849
+ sig { void }
1850
+ def clear_external_docs
1851
+ end
1852
+
1853
+ # A free-form property to include an example of an instance for this schema in JSON.
1854
+ # This is copied verbatim to the output.
1855
+ sig { returns(String) }
1856
+ def example
1857
+ end
1858
+
1859
+ # A free-form property to include an example of an instance for this schema in JSON.
1860
+ # This is copied verbatim to the output.
1861
+ sig { params(value: String).void }
1862
+ def example=(value)
1863
+ end
1864
+
1865
+ # A free-form property to include an example of an instance for this schema in JSON.
1866
+ # This is copied verbatim to the output.
1867
+ sig { void }
1868
+ def clear_example
1869
+ end
1870
+
1871
+ sig { params(field: String).returns(T.untyped) }
1872
+ def [](field)
1873
+ end
1874
+
1875
+ sig { params(field: String, value: T.untyped).void }
1876
+ def []=(field, value)
1877
+ end
1878
+
1879
+ sig { returns(T::Hash[Symbol, T.untyped]) }
1880
+ def to_h
1881
+ end
1882
+
1883
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema) }
1884
+ def self.decode(str)
1885
+ end
1886
+
1887
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema).returns(String) }
1888
+ def self.encode(msg)
1889
+ end
1890
+
1891
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema) }
1892
+ def self.decode_json(str, **kw)
1893
+ end
1894
+
1895
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema, kw: T.untyped).returns(String) }
1896
+ def self.encode_json(msg, **kw)
1897
+ end
1898
+
1899
+ sig { returns(::Google::Protobuf::Descriptor) }
1900
+ def self.descriptor
1901
+ end
1902
+ end
1903
+
1904
+ # `EnumSchema` is subset of fields from the OpenAPI v2 specification's Schema object.
1905
+ # Only fields that are applicable to Enums are included
1906
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
1907
+ #
1908
+ # Example:
1909
+ #
1910
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_enum) = {
1911
+ # ...
1912
+ # title: "MyEnum";
1913
+ # description:"This is my nice enum";
1914
+ # example: "ZERO";
1915
+ # required: true;
1916
+ # ...
1917
+ # };
1918
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::EnumSchema
1919
+ include ::Google::Protobuf::MessageExts
1920
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1921
+
1922
+ sig do
1923
+ params(
1924
+ description: T.nilable(String),
1925
+ default: T.nilable(String),
1926
+ title: T.nilable(String),
1927
+ required: T.nilable(T::Boolean),
1928
+ read_only: T.nilable(T::Boolean),
1929
+ external_docs: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation),
1930
+ example: T.nilable(String),
1931
+ ref: T.nilable(String),
1932
+ extensions: T.nilable(T::Hash[String, T.nilable(Google::Protobuf::Value)])
1933
+ ).void
1934
+ end
1935
+ def initialize(
1936
+ description: "",
1937
+ default: "",
1938
+ title: "",
1939
+ required: false,
1940
+ read_only: false,
1941
+ external_docs: nil,
1942
+ example: "",
1943
+ ref: "",
1944
+ extensions: ::Google::Protobuf::Map.new(:string, :message, Google::Protobuf::Value)
1945
+ )
1946
+ end
1947
+
1948
+ # A short description of the schema.
1949
+ sig { returns(String) }
1950
+ def description
1951
+ end
1952
+
1953
+ # A short description of the schema.
1954
+ sig { params(value: String).void }
1955
+ def description=(value)
1956
+ end
1957
+
1958
+ # A short description of the schema.
1959
+ sig { void }
1960
+ def clear_description
1961
+ end
1962
+
1963
+ sig { returns(String) }
1964
+ def default
1965
+ end
1966
+
1967
+ sig { params(value: String).void }
1968
+ def default=(value)
1969
+ end
1970
+
1971
+ sig { void }
1972
+ def clear_default
1973
+ end
1974
+
1975
+ # The title of the schema.
1976
+ sig { returns(String) }
1977
+ def title
1978
+ end
1979
+
1980
+ # The title of the schema.
1981
+ sig { params(value: String).void }
1982
+ def title=(value)
1983
+ end
1984
+
1985
+ # The title of the schema.
1986
+ sig { void }
1987
+ def clear_title
1988
+ end
1989
+
1990
+ sig { returns(T::Boolean) }
1991
+ def required
1992
+ end
1993
+
1994
+ sig { params(value: T::Boolean).void }
1995
+ def required=(value)
1996
+ end
1997
+
1998
+ sig { void }
1999
+ def clear_required
2000
+ end
2001
+
2002
+ sig { returns(T::Boolean) }
2003
+ def read_only
2004
+ end
2005
+
2006
+ sig { params(value: T::Boolean).void }
2007
+ def read_only=(value)
2008
+ end
2009
+
2010
+ sig { void }
2011
+ def clear_read_only
2012
+ end
2013
+
2014
+ # Additional external documentation for this schema.
2015
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)) }
2016
+ def external_docs
2017
+ end
2018
+
2019
+ # Additional external documentation for this schema.
2020
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)).void }
2021
+ def external_docs=(value)
2022
+ end
2023
+
2024
+ # Additional external documentation for this schema.
2025
+ sig { void }
2026
+ def clear_external_docs
2027
+ end
2028
+
2029
+ sig { returns(String) }
2030
+ def example
2031
+ end
2032
+
2033
+ sig { params(value: String).void }
2034
+ def example=(value)
2035
+ end
2036
+
2037
+ sig { void }
2038
+ def clear_example
2039
+ end
2040
+
2041
+ # Ref is used to define an external reference to include in the message.
2042
+ # This could be a fully qualified proto message reference, and that type must
2043
+ # be imported into the protofile. If no message is identified, the Ref will
2044
+ # be used verbatim in the output.
2045
+ # For example:
2046
+ # `ref: ".google.protobuf.Timestamp"`.
2047
+ sig { returns(String) }
2048
+ def ref
2049
+ end
2050
+
2051
+ # Ref is used to define an external reference to include in the message.
2052
+ # This could be a fully qualified proto message reference, and that type must
2053
+ # be imported into the protofile. If no message is identified, the Ref will
2054
+ # be used verbatim in the output.
2055
+ # For example:
2056
+ # `ref: ".google.protobuf.Timestamp"`.
2057
+ sig { params(value: String).void }
2058
+ def ref=(value)
2059
+ end
2060
+
2061
+ # Ref is used to define an external reference to include in the message.
2062
+ # This could be a fully qualified proto message reference, and that type must
2063
+ # be imported into the protofile. If no message is identified, the Ref will
2064
+ # be used verbatim in the output.
2065
+ # For example:
2066
+ # `ref: ".google.protobuf.Timestamp"`.
2067
+ sig { void }
2068
+ def clear_ref
2069
+ end
2070
+
2071
+ # Custom properties that start with "x-" such as "x-foo" used to describe
2072
+ # extra functionality that is not covered by the standard OpenAPI Specification.
2073
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
2074
+ sig { returns(T::Hash[String, T.nilable(Google::Protobuf::Value)]) }
2075
+ def extensions
2076
+ end
2077
+
2078
+ # Custom properties that start with "x-" such as "x-foo" used to describe
2079
+ # extra functionality that is not covered by the standard OpenAPI Specification.
2080
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
2081
+ sig { params(value: ::Google::Protobuf::Map).void }
2082
+ def extensions=(value)
2083
+ end
2084
+
2085
+ # Custom properties that start with "x-" such as "x-foo" used to describe
2086
+ # extra functionality that is not covered by the standard OpenAPI Specification.
2087
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
2088
+ sig { void }
2089
+ def clear_extensions
2090
+ end
2091
+
2092
+ sig { params(field: String).returns(T.untyped) }
2093
+ def [](field)
2094
+ end
2095
+
2096
+ sig { params(field: String, value: T.untyped).void }
2097
+ def []=(field, value)
2098
+ end
2099
+
2100
+ sig { returns(T::Hash[Symbol, T.untyped]) }
2101
+ def to_h
2102
+ end
2103
+
2104
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::EnumSchema) }
2105
+ def self.decode(str)
2106
+ end
2107
+
2108
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::EnumSchema).returns(String) }
2109
+ def self.encode(msg)
2110
+ end
2111
+
2112
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::EnumSchema) }
2113
+ def self.decode_json(str, **kw)
2114
+ end
2115
+
2116
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::EnumSchema, kw: T.untyped).returns(String) }
2117
+ def self.encode_json(msg, **kw)
2118
+ end
2119
+
2120
+ sig { returns(::Google::Protobuf::Descriptor) }
2121
+ def self.descriptor
2122
+ end
2123
+ end
2124
+
2125
+ # `JSONSchema` represents properties from JSON Schema taken, and as used, in
2126
+ # the OpenAPI v2 spec.
2127
+ #
2128
+ # This includes changes made by OpenAPI v2.
2129
+ #
2130
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
2131
+ #
2132
+ # See also: https://cswr.github.io/JsonSchema/spec/basic_types/,
2133
+ # https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json
2134
+ #
2135
+ # Example:
2136
+ #
2137
+ # message SimpleMessage {
2138
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
2139
+ # json_schema: {
2140
+ # title: "SimpleMessage"
2141
+ # description: "A simple message."
2142
+ # required: ["id"]
2143
+ # }
2144
+ # };
2145
+ #
2146
+ # // Id represents the message identifier.
2147
+ # string id = 1; [
2148
+ # (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
2149
+ # description: "The unique identifier of the simple message."
2150
+ # }];
2151
+ # }
2152
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema
2153
+ include ::Google::Protobuf::MessageExts
2154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2155
+
2156
+ sig do
2157
+ params(
2158
+ ref: T.nilable(String),
2159
+ title: T.nilable(String),
2160
+ description: T.nilable(String),
2161
+ default: T.nilable(String),
2162
+ read_only: T.nilable(T::Boolean),
2163
+ example: T.nilable(String),
2164
+ multiple_of: T.nilable(Float),
2165
+ maximum: T.nilable(Float),
2166
+ exclusive_maximum: T.nilable(T::Boolean),
2167
+ minimum: T.nilable(Float),
2168
+ exclusive_minimum: T.nilable(T::Boolean),
2169
+ max_length: T.nilable(Integer),
2170
+ min_length: T.nilable(Integer),
2171
+ pattern: T.nilable(String),
2172
+ max_items: T.nilable(Integer),
2173
+ min_items: T.nilable(Integer),
2174
+ unique_items: T.nilable(T::Boolean),
2175
+ max_properties: T.nilable(Integer),
2176
+ min_properties: T.nilable(Integer),
2177
+ required: T.nilable(T::Array[String]),
2178
+ array: T.nilable(T::Array[String]),
2179
+ type: T.nilable(T::Array[T.any(Symbol, String, Integer)]),
2180
+ format: T.nilable(String),
2181
+ enum: T.nilable(T::Array[String]),
2182
+ field_configuration: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration),
2183
+ extensions: T.nilable(T::Hash[String, T.nilable(Google::Protobuf::Value)])
2184
+ ).void
2185
+ end
2186
+ def initialize(
2187
+ ref: "",
2188
+ title: "",
2189
+ description: "",
2190
+ default: "",
2191
+ read_only: false,
2192
+ example: "",
2193
+ multiple_of: 0.0,
2194
+ maximum: 0.0,
2195
+ exclusive_maximum: false,
2196
+ minimum: 0.0,
2197
+ exclusive_minimum: false,
2198
+ max_length: 0,
2199
+ min_length: 0,
2200
+ pattern: "",
2201
+ max_items: 0,
2202
+ min_items: 0,
2203
+ unique_items: false,
2204
+ max_properties: 0,
2205
+ min_properties: 0,
2206
+ required: [],
2207
+ array: [],
2208
+ type: [],
2209
+ format: "",
2210
+ enum: [],
2211
+ field_configuration: nil,
2212
+ extensions: ::Google::Protobuf::Map.new(:string, :message, Google::Protobuf::Value)
2213
+ )
2214
+ end
2215
+
2216
+ # Ref is used to define an external reference to include in the message.
2217
+ # This could be a fully qualified proto message reference, and that type must
2218
+ # be imported into the protofile. If no message is identified, the Ref will
2219
+ # be used verbatim in the output.
2220
+ # For example:
2221
+ # `ref: ".google.protobuf.Timestamp"`.
2222
+ sig { returns(String) }
2223
+ def ref
2224
+ end
2225
+
2226
+ # Ref is used to define an external reference to include in the message.
2227
+ # This could be a fully qualified proto message reference, and that type must
2228
+ # be imported into the protofile. If no message is identified, the Ref will
2229
+ # be used verbatim in the output.
2230
+ # For example:
2231
+ # `ref: ".google.protobuf.Timestamp"`.
2232
+ sig { params(value: String).void }
2233
+ def ref=(value)
2234
+ end
2235
+
2236
+ # Ref is used to define an external reference to include in the message.
2237
+ # This could be a fully qualified proto message reference, and that type must
2238
+ # be imported into the protofile. If no message is identified, the Ref will
2239
+ # be used verbatim in the output.
2240
+ # For example:
2241
+ # `ref: ".google.protobuf.Timestamp"`.
2242
+ sig { void }
2243
+ def clear_ref
2244
+ end
2245
+
2246
+ # The title of the schema.
2247
+ sig { returns(String) }
2248
+ def title
2249
+ end
2250
+
2251
+ # The title of the schema.
2252
+ sig { params(value: String).void }
2253
+ def title=(value)
2254
+ end
2255
+
2256
+ # The title of the schema.
2257
+ sig { void }
2258
+ def clear_title
2259
+ end
2260
+
2261
+ # A short description of the schema.
2262
+ sig { returns(String) }
2263
+ def description
2264
+ end
2265
+
2266
+ # A short description of the schema.
2267
+ sig { params(value: String).void }
2268
+ def description=(value)
2269
+ end
2270
+
2271
+ # A short description of the schema.
2272
+ sig { void }
2273
+ def clear_description
2274
+ end
2275
+
2276
+ sig { returns(String) }
2277
+ def default
2278
+ end
2279
+
2280
+ sig { params(value: String).void }
2281
+ def default=(value)
2282
+ end
2283
+
2284
+ sig { void }
2285
+ def clear_default
2286
+ end
2287
+
2288
+ sig { returns(T::Boolean) }
2289
+ def read_only
2290
+ end
2291
+
2292
+ sig { params(value: T::Boolean).void }
2293
+ def read_only=(value)
2294
+ end
2295
+
2296
+ sig { void }
2297
+ def clear_read_only
2298
+ end
2299
+
2300
+ # A free-form property to include a JSON example of this field. This is copied
2301
+ # verbatim to the output swagger.json. Quotes must be escaped.
2302
+ # 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
2303
+ sig { returns(String) }
2304
+ def example
2305
+ end
2306
+
2307
+ # A free-form property to include a JSON example of this field. This is copied
2308
+ # verbatim to the output swagger.json. Quotes must be escaped.
2309
+ # 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
2310
+ sig { params(value: String).void }
2311
+ def example=(value)
2312
+ end
2313
+
2314
+ # A free-form property to include a JSON example of this field. This is copied
2315
+ # verbatim to the output swagger.json. Quotes must be escaped.
2316
+ # 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
2317
+ sig { void }
2318
+ def clear_example
2319
+ end
2320
+
2321
+ sig { returns(Float) }
2322
+ def multiple_of
2323
+ end
2324
+
2325
+ sig { params(value: Float).void }
2326
+ def multiple_of=(value)
2327
+ end
2328
+
2329
+ sig { void }
2330
+ def clear_multiple_of
2331
+ end
2332
+
2333
+ # Maximum represents an inclusive upper limit for a numeric instance. The
2334
+ # value of MUST be a number,
2335
+ sig { returns(Float) }
2336
+ def maximum
2337
+ end
2338
+
2339
+ # Maximum represents an inclusive upper limit for a numeric instance. The
2340
+ # value of MUST be a number,
2341
+ sig { params(value: Float).void }
2342
+ def maximum=(value)
2343
+ end
2344
+
2345
+ # Maximum represents an inclusive upper limit for a numeric instance. The
2346
+ # value of MUST be a number,
2347
+ sig { void }
2348
+ def clear_maximum
2349
+ end
2350
+
2351
+ sig { returns(T::Boolean) }
2352
+ def exclusive_maximum
2353
+ end
2354
+
2355
+ sig { params(value: T::Boolean).void }
2356
+ def exclusive_maximum=(value)
2357
+ end
2358
+
2359
+ sig { void }
2360
+ def clear_exclusive_maximum
2361
+ end
2362
+
2363
+ # minimum represents an inclusive lower limit for a numeric instance. The
2364
+ # value of MUST be a number,
2365
+ sig { returns(Float) }
2366
+ def minimum
2367
+ end
2368
+
2369
+ # minimum represents an inclusive lower limit for a numeric instance. The
2370
+ # value of MUST be a number,
2371
+ sig { params(value: Float).void }
2372
+ def minimum=(value)
2373
+ end
2374
+
2375
+ # minimum represents an inclusive lower limit for a numeric instance. The
2376
+ # value of MUST be a number,
2377
+ sig { void }
2378
+ def clear_minimum
2379
+ end
2380
+
2381
+ sig { returns(T::Boolean) }
2382
+ def exclusive_minimum
2383
+ end
2384
+
2385
+ sig { params(value: T::Boolean).void }
2386
+ def exclusive_minimum=(value)
2387
+ end
2388
+
2389
+ sig { void }
2390
+ def clear_exclusive_minimum
2391
+ end
2392
+
2393
+ sig { returns(Integer) }
2394
+ def max_length
2395
+ end
2396
+
2397
+ sig { params(value: Integer).void }
2398
+ def max_length=(value)
2399
+ end
2400
+
2401
+ sig { void }
2402
+ def clear_max_length
2403
+ end
2404
+
2405
+ sig { returns(Integer) }
2406
+ def min_length
2407
+ end
2408
+
2409
+ sig { params(value: Integer).void }
2410
+ def min_length=(value)
2411
+ end
2412
+
2413
+ sig { void }
2414
+ def clear_min_length
2415
+ end
2416
+
2417
+ sig { returns(String) }
2418
+ def pattern
2419
+ end
2420
+
2421
+ sig { params(value: String).void }
2422
+ def pattern=(value)
2423
+ end
2424
+
2425
+ sig { void }
2426
+ def clear_pattern
2427
+ end
2428
+
2429
+ sig { returns(Integer) }
2430
+ def max_items
2431
+ end
2432
+
2433
+ sig { params(value: Integer).void }
2434
+ def max_items=(value)
2435
+ end
2436
+
2437
+ sig { void }
2438
+ def clear_max_items
2439
+ end
2440
+
2441
+ sig { returns(Integer) }
2442
+ def min_items
2443
+ end
2444
+
2445
+ sig { params(value: Integer).void }
2446
+ def min_items=(value)
2447
+ end
2448
+
2449
+ sig { void }
2450
+ def clear_min_items
2451
+ end
2452
+
2453
+ sig { returns(T::Boolean) }
2454
+ def unique_items
2455
+ end
2456
+
2457
+ sig { params(value: T::Boolean).void }
2458
+ def unique_items=(value)
2459
+ end
2460
+
2461
+ sig { void }
2462
+ def clear_unique_items
2463
+ end
2464
+
2465
+ sig { returns(Integer) }
2466
+ def max_properties
2467
+ end
2468
+
2469
+ sig { params(value: Integer).void }
2470
+ def max_properties=(value)
2471
+ end
2472
+
2473
+ sig { void }
2474
+ def clear_max_properties
2475
+ end
2476
+
2477
+ sig { returns(Integer) }
2478
+ def min_properties
2479
+ end
2480
+
2481
+ sig { params(value: Integer).void }
2482
+ def min_properties=(value)
2483
+ end
2484
+
2485
+ sig { void }
2486
+ def clear_min_properties
2487
+ end
2488
+
2489
+ sig { returns(T::Array[String]) }
2490
+ def required
2491
+ end
2492
+
2493
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
2494
+ def required=(value)
2495
+ end
2496
+
2497
+ sig { void }
2498
+ def clear_required
2499
+ end
2500
+
2501
+ # Items in 'array' must be unique.
2502
+ sig { returns(T::Array[String]) }
2503
+ def array
2504
+ end
2505
+
2506
+ # Items in 'array' must be unique.
2507
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
2508
+ def array=(value)
2509
+ end
2510
+
2511
+ # Items in 'array' must be unique.
2512
+ sig { void }
2513
+ def clear_array
2514
+ end
2515
+
2516
+ sig { returns(T::Array[T.any(Symbol, Integer)]) }
2517
+ def type
2518
+ end
2519
+
2520
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
2521
+ def type=(value)
2522
+ end
2523
+
2524
+ sig { void }
2525
+ def clear_type
2526
+ end
2527
+
2528
+ # `Format`
2529
+ sig { returns(String) }
2530
+ def format
2531
+ end
2532
+
2533
+ # `Format`
2534
+ sig { params(value: String).void }
2535
+ def format=(value)
2536
+ end
2537
+
2538
+ # `Format`
2539
+ sig { void }
2540
+ def clear_format
2541
+ end
2542
+
2543
+ # Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
2544
+ sig { returns(T::Array[String]) }
2545
+ def enum
2546
+ end
2547
+
2548
+ # Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
2549
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
2550
+ def enum=(value)
2551
+ end
2552
+
2553
+ # Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
2554
+ sig { void }
2555
+ def clear_enum
2556
+ end
2557
+
2558
+ # Additional field level properties used when generating the OpenAPI v2 file.
2559
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration)) }
2560
+ def field_configuration
2561
+ end
2562
+
2563
+ # Additional field level properties used when generating the OpenAPI v2 file.
2564
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration)).void }
2565
+ def field_configuration=(value)
2566
+ end
2567
+
2568
+ # Additional field level properties used when generating the OpenAPI v2 file.
2569
+ sig { void }
2570
+ def clear_field_configuration
2571
+ end
2572
+
2573
+ # Custom properties that start with "x-" such as "x-foo" used to describe
2574
+ # extra functionality that is not covered by the standard OpenAPI Specification.
2575
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
2576
+ sig { returns(T::Hash[String, T.nilable(Google::Protobuf::Value)]) }
2577
+ def extensions
2578
+ end
2579
+
2580
+ # Custom properties that start with "x-" such as "x-foo" used to describe
2581
+ # extra functionality that is not covered by the standard OpenAPI Specification.
2582
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
2583
+ sig { params(value: ::Google::Protobuf::Map).void }
2584
+ def extensions=(value)
2585
+ end
2586
+
2587
+ # Custom properties that start with "x-" such as "x-foo" used to describe
2588
+ # extra functionality that is not covered by the standard OpenAPI Specification.
2589
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
2590
+ sig { void }
2591
+ def clear_extensions
2592
+ end
2593
+
2594
+ sig { params(field: String).returns(T.untyped) }
2595
+ def [](field)
2596
+ end
2597
+
2598
+ sig { params(field: String, value: T.untyped).void }
2599
+ def []=(field, value)
2600
+ end
2601
+
2602
+ sig { returns(T::Hash[Symbol, T.untyped]) }
2603
+ def to_h
2604
+ end
2605
+
2606
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema) }
2607
+ def self.decode(str)
2608
+ end
2609
+
2610
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema).returns(String) }
2611
+ def self.encode(msg)
2612
+ end
2613
+
2614
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema) }
2615
+ def self.decode_json(str, **kw)
2616
+ end
2617
+
2618
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema, kw: T.untyped).returns(String) }
2619
+ def self.encode_json(msg, **kw)
2620
+ end
2621
+
2622
+ sig { returns(::Google::Protobuf::Descriptor) }
2623
+ def self.descriptor
2624
+ end
2625
+ end
2626
+
2627
+ # `Tag` is a representation of OpenAPI v2 specification's Tag object.
2628
+ #
2629
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject
2630
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Tag
2631
+ include ::Google::Protobuf::MessageExts
2632
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2633
+
2634
+ sig do
2635
+ params(
2636
+ name: T.nilable(String),
2637
+ description: T.nilable(String),
2638
+ external_docs: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation),
2639
+ extensions: T.nilable(T::Hash[String, T.nilable(Google::Protobuf::Value)])
2640
+ ).void
2641
+ end
2642
+ def initialize(
2643
+ name: "",
2644
+ description: "",
2645
+ external_docs: nil,
2646
+ extensions: ::Google::Protobuf::Map.new(:string, :message, Google::Protobuf::Value)
2647
+ )
2648
+ end
2649
+
2650
+ # The name of the tag. Use it to allow override of the name of a
2651
+ # global Tag object, then use that name to reference the tag throughout the
2652
+ # OpenAPI file.
2653
+ sig { returns(String) }
2654
+ def name
2655
+ end
2656
+
2657
+ # The name of the tag. Use it to allow override of the name of a
2658
+ # global Tag object, then use that name to reference the tag throughout the
2659
+ # OpenAPI file.
2660
+ sig { params(value: String).void }
2661
+ def name=(value)
2662
+ end
2663
+
2664
+ # The name of the tag. Use it to allow override of the name of a
2665
+ # global Tag object, then use that name to reference the tag throughout the
2666
+ # OpenAPI file.
2667
+ sig { void }
2668
+ def clear_name
2669
+ end
2670
+
2671
+ # A short description for the tag. GFM syntax can be used for rich text
2672
+ # representation.
2673
+ sig { returns(String) }
2674
+ def description
2675
+ end
2676
+
2677
+ # A short description for the tag. GFM syntax can be used for rich text
2678
+ # representation.
2679
+ sig { params(value: String).void }
2680
+ def description=(value)
2681
+ end
2682
+
2683
+ # A short description for the tag. GFM syntax can be used for rich text
2684
+ # representation.
2685
+ sig { void }
2686
+ def clear_description
2687
+ end
2688
+
2689
+ # Additional external documentation for this tag.
2690
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)) }
2691
+ def external_docs
2692
+ end
2693
+
2694
+ # Additional external documentation for this tag.
2695
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation)).void }
2696
+ def external_docs=(value)
2697
+ end
2698
+
2699
+ # Additional external documentation for this tag.
2700
+ sig { void }
2701
+ def clear_external_docs
2702
+ end
2703
+
2704
+ # Custom properties that start with "x-" such as "x-foo" used to describe
2705
+ # extra functionality that is not covered by the standard OpenAPI Specification.
2706
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
2707
+ sig { returns(T::Hash[String, T.nilable(Google::Protobuf::Value)]) }
2708
+ def extensions
2709
+ end
2710
+
2711
+ # Custom properties that start with "x-" such as "x-foo" used to describe
2712
+ # extra functionality that is not covered by the standard OpenAPI Specification.
2713
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
2714
+ sig { params(value: ::Google::Protobuf::Map).void }
2715
+ def extensions=(value)
2716
+ end
2717
+
2718
+ # Custom properties that start with "x-" such as "x-foo" used to describe
2719
+ # extra functionality that is not covered by the standard OpenAPI Specification.
2720
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
2721
+ sig { void }
2722
+ def clear_extensions
2723
+ end
2724
+
2725
+ sig { params(field: String).returns(T.untyped) }
2726
+ def [](field)
2727
+ end
2728
+
2729
+ sig { params(field: String, value: T.untyped).void }
2730
+ def []=(field, value)
2731
+ end
2732
+
2733
+ sig { returns(T::Hash[Symbol, T.untyped]) }
2734
+ def to_h
2735
+ end
2736
+
2737
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Tag) }
2738
+ def self.decode(str)
2739
+ end
2740
+
2741
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Tag).returns(String) }
2742
+ def self.encode(msg)
2743
+ end
2744
+
2745
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Tag) }
2746
+ def self.decode_json(str, **kw)
2747
+ end
2748
+
2749
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Tag, kw: T.untyped).returns(String) }
2750
+ def self.encode_json(msg, **kw)
2751
+ end
2752
+
2753
+ sig { returns(::Google::Protobuf::Descriptor) }
2754
+ def self.descriptor
2755
+ end
2756
+ end
2757
+
2758
+ # `SecurityDefinitions` is a representation of OpenAPI v2 specification's
2759
+ # Security Definitions object.
2760
+ #
2761
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityDefinitionsObject
2762
+ #
2763
+ # A declaration of the security schemes available to be used in the
2764
+ # specification. This does not enforce the security schemes on the operations
2765
+ # and only serves to provide the relevant details for each scheme.
2766
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions
2767
+ include ::Google::Protobuf::MessageExts
2768
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2769
+
2770
+ sig do
2771
+ params(
2772
+ security: T.nilable(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme)])
2773
+ ).void
2774
+ end
2775
+ def initialize(
2776
+ security: ::Google::Protobuf::Map.new(:string, :message, Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme)
2777
+ )
2778
+ end
2779
+
2780
+ # A single security scheme definition, mapping a "name" to the scheme it
2781
+ # defines.
2782
+ sig { returns(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme)]) }
2783
+ def security
2784
+ end
2785
+
2786
+ # A single security scheme definition, mapping a "name" to the scheme it
2787
+ # defines.
2788
+ sig { params(value: ::Google::Protobuf::Map).void }
2789
+ def security=(value)
2790
+ end
2791
+
2792
+ # A single security scheme definition, mapping a "name" to the scheme it
2793
+ # defines.
2794
+ sig { void }
2795
+ def clear_security
2796
+ end
2797
+
2798
+ sig { params(field: String).returns(T.untyped) }
2799
+ def [](field)
2800
+ end
2801
+
2802
+ sig { params(field: String, value: T.untyped).void }
2803
+ def []=(field, value)
2804
+ end
2805
+
2806
+ sig { returns(T::Hash[Symbol, T.untyped]) }
2807
+ def to_h
2808
+ end
2809
+
2810
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions) }
2811
+ def self.decode(str)
2812
+ end
2813
+
2814
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions).returns(String) }
2815
+ def self.encode(msg)
2816
+ end
2817
+
2818
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions) }
2819
+ def self.decode_json(str, **kw)
2820
+ end
2821
+
2822
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions, kw: T.untyped).returns(String) }
2823
+ def self.encode_json(msg, **kw)
2824
+ end
2825
+
2826
+ sig { returns(::Google::Protobuf::Descriptor) }
2827
+ def self.descriptor
2828
+ end
2829
+ end
2830
+
2831
+ # `SecurityScheme` is a representation of OpenAPI v2 specification's
2832
+ # Security Scheme object.
2833
+ #
2834
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject
2835
+ #
2836
+ # Allows the definition of a security scheme that can be used by the
2837
+ # operations. Supported schemes are basic authentication, an API key (either as
2838
+ # a header or as a query parameter) and OAuth2's common flows (implicit,
2839
+ # password, application and access code).
2840
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme
2841
+ include ::Google::Protobuf::MessageExts
2842
+ extend ::Google::Protobuf::MessageExts::ClassMethods
2843
+
2844
+ sig do
2845
+ params(
2846
+ type: T.nilable(T.any(Symbol, String, Integer)),
2847
+ description: T.nilable(String),
2848
+ name: T.nilable(String),
2849
+ in: T.nilable(T.any(Symbol, String, Integer)),
2850
+ flow: T.nilable(T.any(Symbol, String, Integer)),
2851
+ authorization_url: T.nilable(String),
2852
+ token_url: T.nilable(String),
2853
+ scopes: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes),
2854
+ extensions: T.nilable(T::Hash[String, T.nilable(Google::Protobuf::Value)])
2855
+ ).void
2856
+ end
2857
+ def initialize(
2858
+ type: :TYPE_INVALID,
2859
+ description: "",
2860
+ name: "",
2861
+ in: :IN_INVALID,
2862
+ flow: :FLOW_INVALID,
2863
+ authorization_url: "",
2864
+ token_url: "",
2865
+ scopes: nil,
2866
+ extensions: ::Google::Protobuf::Map.new(:string, :message, Google::Protobuf::Value)
2867
+ )
2868
+ end
2869
+
2870
+ # The type of the security scheme. Valid values are "basic",
2871
+ # "apiKey" or "oauth2".
2872
+ sig { returns(T.any(Symbol, Integer)) }
2873
+ def type
2874
+ end
2875
+
2876
+ # The type of the security scheme. Valid values are "basic",
2877
+ # "apiKey" or "oauth2".
2878
+ sig { params(value: T.any(Symbol, String, Integer)).void }
2879
+ def type=(value)
2880
+ end
2881
+
2882
+ # The type of the security scheme. Valid values are "basic",
2883
+ # "apiKey" or "oauth2".
2884
+ sig { void }
2885
+ def clear_type
2886
+ end
2887
+
2888
+ # A short description for security scheme.
2889
+ sig { returns(String) }
2890
+ def description
2891
+ end
2892
+
2893
+ # A short description for security scheme.
2894
+ sig { params(value: String).void }
2895
+ def description=(value)
2896
+ end
2897
+
2898
+ # A short description for security scheme.
2899
+ sig { void }
2900
+ def clear_description
2901
+ end
2902
+
2903
+ # The name of the header or query parameter to be used.
2904
+ # Valid for apiKey.
2905
+ sig { returns(String) }
2906
+ def name
2907
+ end
2908
+
2909
+ # The name of the header or query parameter to be used.
2910
+ # Valid for apiKey.
2911
+ sig { params(value: String).void }
2912
+ def name=(value)
2913
+ end
2914
+
2915
+ # The name of the header or query parameter to be used.
2916
+ # Valid for apiKey.
2917
+ sig { void }
2918
+ def clear_name
2919
+ end
2920
+
2921
+ # The location of the API key. Valid values are "query" or
2922
+ # "header".
2923
+ # Valid for apiKey.
2924
+ sig { returns(T.any(Symbol, Integer)) }
2925
+ def in
2926
+ end
2927
+
2928
+ # The location of the API key. Valid values are "query" or
2929
+ # "header".
2930
+ # Valid for apiKey.
2931
+ sig { params(value: T.any(Symbol, String, Integer)).void }
2932
+ def in=(value)
2933
+ end
2934
+
2935
+ # The location of the API key. Valid values are "query" or
2936
+ # "header".
2937
+ # Valid for apiKey.
2938
+ sig { void }
2939
+ def clear_in
2940
+ end
2941
+
2942
+ # The flow used by the OAuth2 security scheme. Valid values are
2943
+ # "implicit", "password", "application" or "accessCode".
2944
+ # Valid for oauth2.
2945
+ sig { returns(T.any(Symbol, Integer)) }
2946
+ def flow
2947
+ end
2948
+
2949
+ # The flow used by the OAuth2 security scheme. Valid values are
2950
+ # "implicit", "password", "application" or "accessCode".
2951
+ # Valid for oauth2.
2952
+ sig { params(value: T.any(Symbol, String, Integer)).void }
2953
+ def flow=(value)
2954
+ end
2955
+
2956
+ # The flow used by the OAuth2 security scheme. Valid values are
2957
+ # "implicit", "password", "application" or "accessCode".
2958
+ # Valid for oauth2.
2959
+ sig { void }
2960
+ def clear_flow
2961
+ end
2962
+
2963
+ # The authorization URL to be used for this flow. This SHOULD be in
2964
+ # the form of a URL.
2965
+ # Valid for oauth2/implicit and oauth2/accessCode.
2966
+ sig { returns(String) }
2967
+ def authorization_url
2968
+ end
2969
+
2970
+ # The authorization URL to be used for this flow. This SHOULD be in
2971
+ # the form of a URL.
2972
+ # Valid for oauth2/implicit and oauth2/accessCode.
2973
+ sig { params(value: String).void }
2974
+ def authorization_url=(value)
2975
+ end
2976
+
2977
+ # The authorization URL to be used for this flow. This SHOULD be in
2978
+ # the form of a URL.
2979
+ # Valid for oauth2/implicit and oauth2/accessCode.
2980
+ sig { void }
2981
+ def clear_authorization_url
2982
+ end
2983
+
2984
+ # The token URL to be used for this flow. This SHOULD be in the
2985
+ # form of a URL.
2986
+ # Valid for oauth2/password, oauth2/application and oauth2/accessCode.
2987
+ sig { returns(String) }
2988
+ def token_url
2989
+ end
2990
+
2991
+ # The token URL to be used for this flow. This SHOULD be in the
2992
+ # form of a URL.
2993
+ # Valid for oauth2/password, oauth2/application and oauth2/accessCode.
2994
+ sig { params(value: String).void }
2995
+ def token_url=(value)
2996
+ end
2997
+
2998
+ # The token URL to be used for this flow. This SHOULD be in the
2999
+ # form of a URL.
3000
+ # Valid for oauth2/password, oauth2/application and oauth2/accessCode.
3001
+ sig { void }
3002
+ def clear_token_url
3003
+ end
3004
+
3005
+ # The available scopes for the OAuth2 security scheme.
3006
+ # Valid for oauth2.
3007
+ sig { returns(T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes)) }
3008
+ def scopes
3009
+ end
3010
+
3011
+ # The available scopes for the OAuth2 security scheme.
3012
+ # Valid for oauth2.
3013
+ sig { params(value: T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes)).void }
3014
+ def scopes=(value)
3015
+ end
3016
+
3017
+ # The available scopes for the OAuth2 security scheme.
3018
+ # Valid for oauth2.
3019
+ sig { void }
3020
+ def clear_scopes
3021
+ end
3022
+
3023
+ # Custom properties that start with "x-" such as "x-foo" used to describe
3024
+ # extra functionality that is not covered by the standard OpenAPI Specification.
3025
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
3026
+ sig { returns(T::Hash[String, T.nilable(Google::Protobuf::Value)]) }
3027
+ def extensions
3028
+ end
3029
+
3030
+ # Custom properties that start with "x-" such as "x-foo" used to describe
3031
+ # extra functionality that is not covered by the standard OpenAPI Specification.
3032
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
3033
+ sig { params(value: ::Google::Protobuf::Map).void }
3034
+ def extensions=(value)
3035
+ end
3036
+
3037
+ # Custom properties that start with "x-" such as "x-foo" used to describe
3038
+ # extra functionality that is not covered by the standard OpenAPI Specification.
3039
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
3040
+ sig { void }
3041
+ def clear_extensions
3042
+ end
3043
+
3044
+ sig { params(field: String).returns(T.untyped) }
3045
+ def [](field)
3046
+ end
3047
+
3048
+ sig { params(field: String, value: T.untyped).void }
3049
+ def []=(field, value)
3050
+ end
3051
+
3052
+ sig { returns(T::Hash[Symbol, T.untyped]) }
3053
+ def to_h
3054
+ end
3055
+
3056
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme) }
3057
+ def self.decode(str)
3058
+ end
3059
+
3060
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme).returns(String) }
3061
+ def self.encode(msg)
3062
+ end
3063
+
3064
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme) }
3065
+ def self.decode_json(str, **kw)
3066
+ end
3067
+
3068
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme, kw: T.untyped).returns(String) }
3069
+ def self.encode_json(msg, **kw)
3070
+ end
3071
+
3072
+ sig { returns(::Google::Protobuf::Descriptor) }
3073
+ def self.descriptor
3074
+ end
3075
+ end
3076
+
3077
+ # `SecurityRequirement` is a representation of OpenAPI v2 specification's
3078
+ # Security Requirement object.
3079
+ #
3080
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityRequirementObject
3081
+ #
3082
+ # Lists the required security schemes to execute this operation. The object can
3083
+ # have multiple security schemes declared in it which are all required (that
3084
+ # is, there is a logical AND between the schemes).
3085
+ #
3086
+ # The name used for each property MUST correspond to a security scheme
3087
+ # declared in the Security Definitions.
3088
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement
3089
+ include ::Google::Protobuf::MessageExts
3090
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3091
+
3092
+ sig do
3093
+ params(
3094
+ security_requirement: T.nilable(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue)])
3095
+ ).void
3096
+ end
3097
+ def initialize(
3098
+ security_requirement: ::Google::Protobuf::Map.new(:string, :message, Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue)
3099
+ )
3100
+ end
3101
+
3102
+ # Each name must correspond to a security scheme which is declared in
3103
+ # the Security Definitions. If the security scheme is of type "oauth2",
3104
+ # then the value is a list of scope names required for the execution.
3105
+ # For other security scheme types, the array MUST be empty.
3106
+ sig { returns(T::Hash[String, T.nilable(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue)]) }
3107
+ def security_requirement
3108
+ end
3109
+
3110
+ # Each name must correspond to a security scheme which is declared in
3111
+ # the Security Definitions. If the security scheme is of type "oauth2",
3112
+ # then the value is a list of scope names required for the execution.
3113
+ # For other security scheme types, the array MUST be empty.
3114
+ sig { params(value: ::Google::Protobuf::Map).void }
3115
+ def security_requirement=(value)
3116
+ end
3117
+
3118
+ # Each name must correspond to a security scheme which is declared in
3119
+ # the Security Definitions. If the security scheme is of type "oauth2",
3120
+ # then the value is a list of scope names required for the execution.
3121
+ # For other security scheme types, the array MUST be empty.
3122
+ sig { void }
3123
+ def clear_security_requirement
3124
+ end
3125
+
3126
+ sig { params(field: String).returns(T.untyped) }
3127
+ def [](field)
3128
+ end
3129
+
3130
+ sig { params(field: String, value: T.untyped).void }
3131
+ def []=(field, value)
3132
+ end
3133
+
3134
+ sig { returns(T::Hash[Symbol, T.untyped]) }
3135
+ def to_h
3136
+ end
3137
+
3138
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement) }
3139
+ def self.decode(str)
3140
+ end
3141
+
3142
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement).returns(String) }
3143
+ def self.encode(msg)
3144
+ end
3145
+
3146
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement) }
3147
+ def self.decode_json(str, **kw)
3148
+ end
3149
+
3150
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement, kw: T.untyped).returns(String) }
3151
+ def self.encode_json(msg, **kw)
3152
+ end
3153
+
3154
+ sig { returns(::Google::Protobuf::Descriptor) }
3155
+ def self.descriptor
3156
+ end
3157
+ end
3158
+
3159
+ # `Scopes` is a representation of OpenAPI v2 specification's Scopes object.
3160
+ #
3161
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#scopesObject
3162
+ #
3163
+ # Lists the available scopes for an OAuth2 security scheme.
3164
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes
3165
+ include ::Google::Protobuf::MessageExts
3166
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3167
+
3168
+ sig do
3169
+ params(
3170
+ scope: T.nilable(T::Hash[String, String])
3171
+ ).void
3172
+ end
3173
+ def initialize(
3174
+ scope: ::Google::Protobuf::Map.new(:string, :string)
3175
+ )
3176
+ end
3177
+
3178
+ # Maps between a name of a scope to a short description of it (as the value
3179
+ # of the property).
3180
+ sig { returns(T::Hash[String, String]) }
3181
+ def scope
3182
+ end
3183
+
3184
+ # Maps between a name of a scope to a short description of it (as the value
3185
+ # of the property).
3186
+ sig { params(value: ::Google::Protobuf::Map).void }
3187
+ def scope=(value)
3188
+ end
3189
+
3190
+ # Maps between a name of a scope to a short description of it (as the value
3191
+ # of the property).
3192
+ sig { void }
3193
+ def clear_scope
3194
+ end
3195
+
3196
+ sig { params(field: String).returns(T.untyped) }
3197
+ def [](field)
3198
+ end
3199
+
3200
+ sig { params(field: String, value: T.untyped).void }
3201
+ def []=(field, value)
3202
+ end
3203
+
3204
+ sig { returns(T::Hash[Symbol, T.untyped]) }
3205
+ def to_h
3206
+ end
3207
+
3208
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes) }
3209
+ def self.decode(str)
3210
+ end
3211
+
3212
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes).returns(String) }
3213
+ def self.encode(msg)
3214
+ end
3215
+
3216
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes) }
3217
+ def self.decode_json(str, **kw)
3218
+ end
3219
+
3220
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes, kw: T.untyped).returns(String) }
3221
+ def self.encode_json(msg, **kw)
3222
+ end
3223
+
3224
+ sig { returns(::Google::Protobuf::Descriptor) }
3225
+ def self.descriptor
3226
+ end
3227
+ end
3228
+
3229
+ # 'FieldConfiguration' provides additional field level properties used when generating the OpenAPI v2 file.
3230
+ # These properties are not defined by OpenAPIv2, but they are used to control the generation.
3231
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration
3232
+ include ::Google::Protobuf::MessageExts
3233
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3234
+
3235
+ sig do
3236
+ params(
3237
+ path_param_name: T.nilable(String)
3238
+ ).void
3239
+ end
3240
+ def initialize(
3241
+ path_param_name: ""
3242
+ )
3243
+ end
3244
+
3245
+ # Alternative parameter name when used as path parameter. If set, this will
3246
+ # be used as the complete parameter name when this field is used as a path
3247
+ # parameter. Use this to avoid having auto generated path parameter names
3248
+ # for overlapping paths.
3249
+ sig { returns(String) }
3250
+ def path_param_name
3251
+ end
3252
+
3253
+ # Alternative parameter name when used as path parameter. If set, this will
3254
+ # be used as the complete parameter name when this field is used as a path
3255
+ # parameter. Use this to avoid having auto generated path parameter names
3256
+ # for overlapping paths.
3257
+ sig { params(value: String).void }
3258
+ def path_param_name=(value)
3259
+ end
3260
+
3261
+ # Alternative parameter name when used as path parameter. If set, this will
3262
+ # be used as the complete parameter name when this field is used as a path
3263
+ # parameter. Use this to avoid having auto generated path parameter names
3264
+ # for overlapping paths.
3265
+ sig { void }
3266
+ def clear_path_param_name
3267
+ end
3268
+
3269
+ sig { params(field: String).returns(T.untyped) }
3270
+ def [](field)
3271
+ end
3272
+
3273
+ sig { params(field: String, value: T.untyped).void }
3274
+ def []=(field, value)
3275
+ end
3276
+
3277
+ sig { returns(T::Hash[Symbol, T.untyped]) }
3278
+ def to_h
3279
+ end
3280
+
3281
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration) }
3282
+ def self.decode(str)
3283
+ end
3284
+
3285
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration).returns(String) }
3286
+ def self.encode(msg)
3287
+ end
3288
+
3289
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration) }
3290
+ def self.decode_json(str, **kw)
3291
+ end
3292
+
3293
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration, kw: T.untyped).returns(String) }
3294
+ def self.encode_json(msg, **kw)
3295
+ end
3296
+
3297
+ sig { returns(::Google::Protobuf::Descriptor) }
3298
+ def self.descriptor
3299
+ end
3300
+ end
3301
+
3302
+ # If the security scheme is of type "oauth2", then the value is a list of
3303
+ # scope names required for the execution. For other security scheme types,
3304
+ # the array MUST be empty.
3305
+ class Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue
3306
+ include ::Google::Protobuf::MessageExts
3307
+ extend ::Google::Protobuf::MessageExts::ClassMethods
3308
+
3309
+ sig do
3310
+ params(
3311
+ scope: T.nilable(T::Array[String])
3312
+ ).void
3313
+ end
3314
+ def initialize(
3315
+ scope: []
3316
+ )
3317
+ end
3318
+
3319
+ sig { returns(T::Array[String]) }
3320
+ def scope
3321
+ end
3322
+
3323
+ sig { params(value: ::Google::Protobuf::RepeatedField).void }
3324
+ def scope=(value)
3325
+ end
3326
+
3327
+ sig { void }
3328
+ def clear_scope
3329
+ end
3330
+
3331
+ sig { params(field: String).returns(T.untyped) }
3332
+ def [](field)
3333
+ end
3334
+
3335
+ sig { params(field: String, value: T.untyped).void }
3336
+ def []=(field, value)
3337
+ end
3338
+
3339
+ sig { returns(T::Hash[Symbol, T.untyped]) }
3340
+ def to_h
3341
+ end
3342
+
3343
+ sig { params(str: String).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue) }
3344
+ def self.decode(str)
3345
+ end
3346
+
3347
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue).returns(String) }
3348
+ def self.encode(msg)
3349
+ end
3350
+
3351
+ sig { params(str: String, kw: T.untyped).returns(Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue) }
3352
+ def self.decode_json(str, **kw)
3353
+ end
3354
+
3355
+ sig { params(msg: Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue, kw: T.untyped).returns(String) }
3356
+ def self.encode_json(msg, **kw)
3357
+ end
3358
+
3359
+ sig { returns(::Google::Protobuf::Descriptor) }
3360
+ def self.descriptor
3361
+ end
3362
+ end
3363
+
3364
+ module Grpc::Gateway::ProtocGenOpenapiv2::Options::Scheme
3365
+ self::UNKNOWN = T.let(0, Integer)
3366
+ self::HTTP = T.let(1, Integer)
3367
+ self::HTTPS = T.let(2, Integer)
3368
+ self::WS = T.let(3, Integer)
3369
+ self::WSS = T.let(4, Integer)
3370
+
3371
+ sig { params(value: Integer).returns(T.nilable(Symbol)) }
3372
+ def self.lookup(value)
3373
+ end
3374
+
3375
+ sig { params(value: Symbol).returns(T.nilable(Integer)) }
3376
+ def self.resolve(value)
3377
+ end
3378
+
3379
+ sig { returns(::Google::Protobuf::EnumDescriptor) }
3380
+ def self.descriptor
3381
+ end
3382
+ end
3383
+
3384
+ module Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type
3385
+ self::UNKNOWN = T.let(0, Integer)
3386
+ self::STRING = T.let(1, Integer)
3387
+ self::NUMBER = T.let(2, Integer)
3388
+ self::INTEGER = T.let(3, Integer)
3389
+ self::BOOLEAN = T.let(4, Integer)
3390
+
3391
+ sig { params(value: Integer).returns(T.nilable(Symbol)) }
3392
+ def self.lookup(value)
3393
+ end
3394
+
3395
+ sig { params(value: Symbol).returns(T.nilable(Integer)) }
3396
+ def self.resolve(value)
3397
+ end
3398
+
3399
+ sig { returns(::Google::Protobuf::EnumDescriptor) }
3400
+ def self.descriptor
3401
+ end
3402
+ end
3403
+
3404
+ module Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::JSONSchemaSimpleTypes
3405
+ self::UNKNOWN = T.let(0, Integer)
3406
+ self::ARRAY = T.let(1, Integer)
3407
+ self::BOOLEAN = T.let(2, Integer)
3408
+ self::INTEGER = T.let(3, Integer)
3409
+ self::NULL = T.let(4, Integer)
3410
+ self::NUMBER = T.let(5, Integer)
3411
+ self::OBJECT = T.let(6, Integer)
3412
+ self::STRING = T.let(7, Integer)
3413
+
3414
+ sig { params(value: Integer).returns(T.nilable(Symbol)) }
3415
+ def self.lookup(value)
3416
+ end
3417
+
3418
+ sig { params(value: Symbol).returns(T.nilable(Integer)) }
3419
+ def self.resolve(value)
3420
+ end
3421
+
3422
+ sig { returns(::Google::Protobuf::EnumDescriptor) }
3423
+ def self.descriptor
3424
+ end
3425
+ end
3426
+
3427
+ module Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type
3428
+ self::TYPE_INVALID = T.let(0, Integer)
3429
+ self::TYPE_BASIC = T.let(1, Integer)
3430
+ self::TYPE_API_KEY = T.let(2, Integer)
3431
+ self::TYPE_OAUTH2 = T.let(3, Integer)
3432
+
3433
+ sig { params(value: Integer).returns(T.nilable(Symbol)) }
3434
+ def self.lookup(value)
3435
+ end
3436
+
3437
+ sig { params(value: Symbol).returns(T.nilable(Integer)) }
3438
+ def self.resolve(value)
3439
+ end
3440
+
3441
+ sig { returns(::Google::Protobuf::EnumDescriptor) }
3442
+ def self.descriptor
3443
+ end
3444
+ end
3445
+
3446
+ module Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In
3447
+ self::IN_INVALID = T.let(0, Integer)
3448
+ self::IN_QUERY = T.let(1, Integer)
3449
+ self::IN_HEADER = T.let(2, Integer)
3450
+
3451
+ sig { params(value: Integer).returns(T.nilable(Symbol)) }
3452
+ def self.lookup(value)
3453
+ end
3454
+
3455
+ sig { params(value: Symbol).returns(T.nilable(Integer)) }
3456
+ def self.resolve(value)
3457
+ end
3458
+
3459
+ sig { returns(::Google::Protobuf::EnumDescriptor) }
3460
+ def self.descriptor
3461
+ end
3462
+ end
3463
+
3464
+ module Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow
3465
+ self::FLOW_INVALID = T.let(0, Integer)
3466
+ self::FLOW_IMPLICIT = T.let(1, Integer)
3467
+ self::FLOW_PASSWORD = T.let(2, Integer)
3468
+ self::FLOW_APPLICATION = T.let(3, Integer)
3469
+ self::FLOW_ACCESS_CODE = T.let(4, Integer)
3470
+
3471
+ sig { params(value: Integer).returns(T.nilable(Symbol)) }
3472
+ def self.lookup(value)
3473
+ end
3474
+
3475
+ sig { params(value: Symbol).returns(T.nilable(Integer)) }
3476
+ def self.resolve(value)
3477
+ end
3478
+
3479
+ sig { returns(::Google::Protobuf::EnumDescriptor) }
3480
+ def self.descriptor
3481
+ end
3482
+ end