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,1691 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # This RBS interface is provided for convenience, on a best-effort basis.
3
+ # The library is the definitive source for the API contract; if the RBS file
4
+ # and the library's behavior differ, the library behavior is authoritative.
5
+ # We welcome fixes to change the RBS file to match.
6
+ # source: protoc-gen-openapiv2/options/openapiv2.proto
7
+
8
+ module Grpc
9
+ module Gateway
10
+ module ProtocGenOpenapiv2
11
+ module Options
12
+ # `Swagger` is a representation of OpenAPI v2 specification's Swagger object.
13
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject
14
+ # Example:
15
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
16
+ # info: {
17
+ # title: "Echo API";
18
+ # version: "1.0";
19
+ # description: "";
20
+ # contact: {
21
+ # name: "gRPC-Gateway project";
22
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway";
23
+ # email: "none@example.com";
24
+ # };
25
+ # license: {
26
+ # name: "BSD 3-Clause License";
27
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
28
+ # };
29
+ # };
30
+ # schemes: HTTPS;
31
+ # consumes: "application/json";
32
+ # produces: "application/json";
33
+ # };
34
+ class Swagger < ::Google::Protobuf::AbstractMessage
35
+
36
+ # Specifies the OpenAPI Specification version being used. It can be
37
+ # used by the OpenAPI UI and other clients to interpret the API listing. The
38
+ # value MUST be "2.0".
39
+ attr_reader swagger(): ::String
40
+ attr_writer swagger(): ::String | ::Symbol
41
+ def clear_swagger: () -> void
42
+
43
+ # Provides metadata about the API. The metadata can be used by the
44
+ # clients if needed.
45
+ attr_accessor info(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Info?
46
+ def has_info?: () -> bool
47
+ def clear_info: () -> void
48
+
49
+ # The host (name or ip) serving the API. This MUST be the host only and does
50
+ # not include the scheme nor sub-paths. It MAY include a port. If the host is
51
+ # not included, the host serving the documentation is to be used (including
52
+ # the port). The host does not support path templating.
53
+ attr_reader host(): ::String
54
+ attr_writer host(): ::String | ::Symbol
55
+ def clear_host: () -> void
56
+
57
+ # The base path on which the API is served, which is relative to the host. If
58
+ # it is not included, the API is served directly under the host. The value
59
+ # MUST start with a leading slash (/). The basePath does not support path
60
+ # templating.
61
+ # Note that using `base_path` does not change the endpoint paths that are
62
+ # generated in the resulting OpenAPI file. If you wish to use `base_path`
63
+ # with relatively generated OpenAPI paths, the `base_path` prefix must be
64
+ # manually removed from your `google.api.http` paths and your code changed to
65
+ # serve the API from the `base_path`.
66
+ attr_reader base_path(): ::String
67
+ attr_writer base_path(): ::String | ::Symbol
68
+ def clear_base_path: () -> void
69
+
70
+ # The transfer protocol of the API. Values MUST be from the list: "http",
71
+ # "https", "ws", "wss". If the schemes is not included, the default scheme to
72
+ # be used is the one used to access the OpenAPI definition itself.
73
+ attr_accessor schemes(): ::Google::Protobuf::RepeatedField
74
+ attr_reader schemes_const(): ::Array[::Integer]
75
+ def clear_schemes: () -> void
76
+
77
+ # A list of MIME types the APIs can consume. This is global to all APIs but
78
+ # can be overridden on specific API calls. Value MUST be as described under
79
+ # Mime Types.
80
+ attr_accessor consumes(): ::Google::Protobuf::RepeatedField
81
+ def clear_consumes: () -> void
82
+
83
+ # A list of MIME types the APIs can produce. This is global to all APIs but
84
+ # can be overridden on specific API calls. Value MUST be as described under
85
+ # Mime Types.
86
+ attr_accessor produces(): ::Google::Protobuf::RepeatedField
87
+ def clear_produces: () -> void
88
+
89
+ # An object to hold responses that can be used across operations. This
90
+ # property does not define global responses for all operations.
91
+ attr_accessor responses(): ::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response]
92
+ def clear_responses: () -> void
93
+
94
+ # Security scheme definitions that can be used across the specification.
95
+ attr_accessor security_definitions(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions?
96
+ def has_security_definitions?: () -> bool
97
+ def clear_security_definitions: () -> void
98
+
99
+ # A declaration of which security schemes are applied for the API as a whole.
100
+ # The list of values describes alternative security schemes that can be used
101
+ # (that is, there is a logical OR between the security requirements).
102
+ # Individual operations can override this definition.
103
+ attr_accessor security(): ::Google::Protobuf::RepeatedField
104
+ def clear_security: () -> void
105
+
106
+ # A list of tags for API documentation control. Tags can be used for logical
107
+ # grouping of operations by resources or any other qualifier.
108
+ attr_accessor tags(): ::Google::Protobuf::RepeatedField
109
+ def clear_tags: () -> void
110
+
111
+ # Additional external documentation.
112
+ attr_accessor external_docs(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
113
+ def has_external_docs?: () -> bool
114
+ def clear_external_docs: () -> void
115
+
116
+ # Custom properties that start with "x-" such as "x-foo" used to describe
117
+ # extra functionality that is not covered by the standard OpenAPI Specification.
118
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
119
+ attr_accessor extensions(): ::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]
120
+ def clear_extensions: () -> void
121
+
122
+ type init_map = {
123
+ swagger: (::String | ::Symbol)?,
124
+ "swagger" => (::String | ::Symbol)?,
125
+ info: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Info | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Info::init_map)?,
126
+ "info" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Info | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Info::init_map)?,
127
+ host: (::String | ::Symbol)?,
128
+ "host" => (::String | ::Symbol)?,
129
+ base_path: (::String | ::Symbol)?,
130
+ "base_path" => (::String | ::Symbol)?,
131
+ schemes: ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scheme::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scheme::strings | ::Integer | ::Float]?,
132
+ "schemes" => ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scheme::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scheme::strings | ::Integer | ::Float]?,
133
+ consumes: ::Array[::String | ::Symbol]?,
134
+ "consumes" => ::Array[::String | ::Symbol]?,
135
+ produces: ::Array[::String | ::Symbol]?,
136
+ "produces" => ::Array[::String | ::Symbol]?,
137
+ responses: ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response]?,
138
+ "responses" => ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response]?,
139
+ security_definitions: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions::init_map)?,
140
+ "security_definitions" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions::init_map)?,
141
+ security: ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement]?,
142
+ "security" => ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement]?,
143
+ tags: ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::Tag]?,
144
+ "tags" => ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::Tag]?,
145
+ external_docs: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
146
+ "external_docs" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
147
+ extensions: ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
148
+ "extensions" => ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
149
+ }
150
+
151
+ def initialize: (?init_map initial_value) -> void
152
+
153
+ def []:
154
+ ("swagger" name) -> ::String
155
+ | ("info" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Info?
156
+ | ("host" name) -> ::String
157
+ | ("base_path" name) -> ::String
158
+ | ("schemes" name) -> (::Google::Protobuf::RepeatedField)
159
+ | ("consumes" name) -> (::Google::Protobuf::RepeatedField)
160
+ | ("produces" name) -> (::Google::Protobuf::RepeatedField)
161
+ | ("responses" name) -> (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response])
162
+ | ("security_definitions" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions?
163
+ | ("security" name) -> ::Google::Protobuf::RepeatedField
164
+ | ("tags" name) -> ::Google::Protobuf::RepeatedField
165
+ | ("external_docs" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
166
+ | ("extensions" name) -> (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value])
167
+
168
+ def []=:
169
+ ("swagger" name, (::String | ::Symbol) value) -> void
170
+ | ("info" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Info? value) -> void
171
+ | ("host" name, (::String | ::Symbol) value) -> void
172
+ | ("base_path" name, (::String | ::Symbol) value) -> void
173
+ | ("schemes" name, (::Google::Protobuf::RepeatedField) value) -> void
174
+ | ("consumes" name, (::Google::Protobuf::RepeatedField) value) -> void
175
+ | ("produces" name, (::Google::Protobuf::RepeatedField) value) -> void
176
+ | ("responses" name, (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response]) value) -> void
177
+ | ("security_definitions" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityDefinitions? value) -> void
178
+ | ("security" name, ::Google::Protobuf::RepeatedField value) -> void
179
+ | ("tags" name, ::Google::Protobuf::RepeatedField value) -> void
180
+ | ("external_docs" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation? value) -> void
181
+ | ("extensions" name, (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]) value) -> void
182
+ end
183
+
184
+ # `Operation` is a representation of OpenAPI v2 specification's Operation object.
185
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject
186
+ # Example:
187
+ # service EchoService {
188
+ # rpc Echo(SimpleMessage) returns (SimpleMessage) {
189
+ # option (google.api.http) = {
190
+ # get: "/v1/example/echo/{id}"
191
+ # };
192
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
193
+ # summary: "Get a message.";
194
+ # operation_id: "getMessage";
195
+ # tags: "echo";
196
+ # responses: {
197
+ # key: "200"
198
+ # value: {
199
+ # description: "OK";
200
+ # }
201
+ # }
202
+ # };
203
+ # }
204
+ # }
205
+ class Operation < ::Google::Protobuf::AbstractMessage
206
+
207
+ # A list of tags for API documentation control. Tags can be used for logical
208
+ # grouping of operations by resources or any other qualifier.
209
+ attr_accessor tags(): ::Google::Protobuf::RepeatedField
210
+ def clear_tags: () -> void
211
+
212
+ # A short summary of what the operation does. For maximum readability in the
213
+ # swagger-ui, this field SHOULD be less than 120 characters.
214
+ attr_reader summary(): ::String
215
+ attr_writer summary(): ::String | ::Symbol
216
+ def clear_summary: () -> void
217
+
218
+ # A verbose explanation of the operation behavior. GFM syntax can be used for
219
+ # rich text representation.
220
+ attr_reader description(): ::String
221
+ attr_writer description(): ::String | ::Symbol
222
+ def clear_description: () -> void
223
+
224
+ # Additional external documentation for this operation.
225
+ attr_accessor external_docs(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
226
+ def has_external_docs?: () -> bool
227
+ def clear_external_docs: () -> void
228
+
229
+ # Unique string used to identify the operation. The id MUST be unique among
230
+ # all operations described in the API. Tools and libraries MAY use the
231
+ # operationId to uniquely identify an operation, therefore, it is recommended
232
+ # to follow common programming naming conventions.
233
+ attr_reader operation_id(): ::String
234
+ attr_writer operation_id(): ::String | ::Symbol
235
+ def clear_operation_id: () -> void
236
+
237
+ # A list of MIME types the operation can consume. This overrides the consumes
238
+ # definition at the OpenAPI Object. An empty value MAY be used to clear the
239
+ # global definition. Value MUST be as described under Mime Types.
240
+ attr_accessor consumes(): ::Google::Protobuf::RepeatedField
241
+ def clear_consumes: () -> void
242
+
243
+ # A list of MIME types the operation can produce. This overrides the produces
244
+ # definition at the OpenAPI Object. An empty value MAY be used to clear the
245
+ # global definition. Value MUST be as described under Mime Types.
246
+ attr_accessor produces(): ::Google::Protobuf::RepeatedField
247
+ def clear_produces: () -> void
248
+
249
+ # The list of possible responses as they are returned from executing this
250
+ # operation.
251
+ attr_accessor responses(): ::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response]
252
+ def clear_responses: () -> void
253
+
254
+ # The transfer protocol for the operation. Values MUST be from the list:
255
+ # "http", "https", "ws", "wss". The value overrides the OpenAPI Object
256
+ # schemes definition.
257
+ attr_accessor schemes(): ::Google::Protobuf::RepeatedField
258
+ attr_reader schemes_const(): ::Array[::Integer]
259
+ def clear_schemes: () -> void
260
+
261
+ # Declares this operation to be deprecated. Usage of the declared operation
262
+ # should be refrained. Default value is false.
263
+ attr_accessor deprecated(): bool
264
+ def clear_deprecated: () -> void
265
+
266
+ # A declaration of which security schemes are applied for this operation. The
267
+ # list of values describes alternative security schemes that can be used
268
+ # (that is, there is a logical OR between the security requirements). This
269
+ # definition overrides any declared top-level security. To remove a top-level
270
+ # security declaration, an empty array can be used.
271
+ attr_accessor security(): ::Google::Protobuf::RepeatedField
272
+ def clear_security: () -> void
273
+
274
+ # Custom properties that start with "x-" such as "x-foo" used to describe
275
+ # extra functionality that is not covered by the standard OpenAPI Specification.
276
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
277
+ attr_accessor extensions(): ::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]
278
+ def clear_extensions: () -> void
279
+
280
+ # Custom parameters such as HTTP request headers.
281
+ # See: https://swagger.io/docs/specification/2-0/describing-parameters/
282
+ # and https://swagger.io/specification/v2/#parameter-object.
283
+ attr_accessor parameters(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters?
284
+ def has_parameters?: () -> bool
285
+ def clear_parameters: () -> void
286
+
287
+ type init_map = {
288
+ tags: ::Array[::String | ::Symbol]?,
289
+ "tags" => ::Array[::String | ::Symbol]?,
290
+ summary: (::String | ::Symbol)?,
291
+ "summary" => (::String | ::Symbol)?,
292
+ description: (::String | ::Symbol)?,
293
+ "description" => (::String | ::Symbol)?,
294
+ external_docs: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
295
+ "external_docs" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
296
+ operation_id: (::String | ::Symbol)?,
297
+ "operation_id" => (::String | ::Symbol)?,
298
+ consumes: ::Array[::String | ::Symbol]?,
299
+ "consumes" => ::Array[::String | ::Symbol]?,
300
+ produces: ::Array[::String | ::Symbol]?,
301
+ "produces" => ::Array[::String | ::Symbol]?,
302
+ responses: ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response]?,
303
+ "responses" => ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response]?,
304
+ schemes: ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scheme::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scheme::strings | ::Integer | ::Float]?,
305
+ "schemes" => ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scheme::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scheme::strings | ::Integer | ::Float]?,
306
+ deprecated: bool?,
307
+ "deprecated" => bool?,
308
+ security: ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement]?,
309
+ "security" => ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement]?,
310
+ extensions: ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
311
+ "extensions" => ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
312
+ parameters: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters::init_map)?,
313
+ "parameters" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters::init_map)?,
314
+ }
315
+
316
+ def initialize: (?init_map initial_value) -> void
317
+
318
+ def []:
319
+ ("tags" name) -> (::Google::Protobuf::RepeatedField)
320
+ | ("summary" name) -> ::String
321
+ | ("description" name) -> ::String
322
+ | ("external_docs" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
323
+ | ("operation_id" name) -> ::String
324
+ | ("consumes" name) -> (::Google::Protobuf::RepeatedField)
325
+ | ("produces" name) -> (::Google::Protobuf::RepeatedField)
326
+ | ("responses" name) -> (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response])
327
+ | ("schemes" name) -> (::Google::Protobuf::RepeatedField)
328
+ | ("deprecated" name) -> bool
329
+ | ("security" name) -> ::Google::Protobuf::RepeatedField
330
+ | ("extensions" name) -> (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value])
331
+ | ("parameters" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters?
332
+
333
+ def []=:
334
+ ("tags" name, (::Google::Protobuf::RepeatedField) value) -> void
335
+ | ("summary" name, (::String | ::Symbol) value) -> void
336
+ | ("description" name, (::String | ::Symbol) value) -> void
337
+ | ("external_docs" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation? value) -> void
338
+ | ("operation_id" name, (::String | ::Symbol) value) -> void
339
+ | ("consumes" name, (::Google::Protobuf::RepeatedField) value) -> void
340
+ | ("produces" name, (::Google::Protobuf::RepeatedField) value) -> void
341
+ | ("responses" name, (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Response]) value) -> void
342
+ | ("schemes" name, (::Google::Protobuf::RepeatedField) value) -> void
343
+ | ("deprecated" name, bool value) -> void
344
+ | ("security" name, ::Google::Protobuf::RepeatedField value) -> void
345
+ | ("extensions" name, (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]) value) -> void
346
+ | ("parameters" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Parameters? value) -> void
347
+ end
348
+
349
+ # `Parameters` is a representation of OpenAPI v2 specification's parameters object.
350
+ # Note: This technically breaks compatibility with the OpenAPI 2 definition structure as we only
351
+ # allow header parameters to be set here since we do not want users specifying custom non-header
352
+ # parameters beyond those inferred from the Protobuf schema.
353
+ # See: https://swagger.io/specification/v2/#parameter-object
354
+ class Parameters < ::Google::Protobuf::AbstractMessage
355
+
356
+ # `Headers` is one or more HTTP header parameter.
357
+ # See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
358
+ attr_accessor headers(): ::Google::Protobuf::RepeatedField
359
+ def clear_headers: () -> void
360
+
361
+ type init_map = {
362
+ headers: ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter]?,
363
+ "headers" => ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter]?,
364
+ }
365
+
366
+ def initialize: (?init_map initial_value) -> void
367
+
368
+ def []:
369
+ ("headers" name) -> ::Google::Protobuf::RepeatedField
370
+
371
+ def []=:
372
+ ("headers" name, ::Google::Protobuf::RepeatedField value) -> void
373
+ end
374
+
375
+ # `HeaderParameter` a HTTP header parameter.
376
+ # See: https://swagger.io/specification/v2/#parameter-object
377
+ class HeaderParameter < ::Google::Protobuf::AbstractMessage
378
+ # `Type` is a supported HTTP header type.
379
+ # See https://swagger.io/specification/v2/#parameterType.
380
+ module Type
381
+
382
+ UNKNOWN: 0
383
+
384
+ STRING: 1
385
+
386
+ NUMBER: 2
387
+
388
+ INTEGER: 3
389
+
390
+ BOOLEAN: 4
391
+
392
+ def self.lookup: (::Integer number) -> ::Symbol
393
+
394
+
395
+ def self.resolve: (::Symbol name) -> ::Integer
396
+
397
+
398
+ type names = :UNKNOWN | :STRING | :NUMBER | :INTEGER | :BOOLEAN
399
+
400
+ type strings = "UNKNOWN" | "STRING" | "NUMBER" | "INTEGER" | "BOOLEAN"
401
+
402
+ type numbers = 0 | 1 | 2 | 3 | 4
403
+ end
404
+
405
+ # `Name` is the header name.
406
+ attr_reader name(): ::String
407
+ attr_writer name(): ::String | ::Symbol
408
+ def clear_name: () -> void
409
+
410
+ # `Description` is a short description of the header.
411
+ attr_reader description(): ::String
412
+ attr_writer description(): ::String | ::Symbol
413
+ def clear_description: () -> void
414
+
415
+ # `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
416
+ # See: https://swagger.io/specification/v2/#parameterType.
417
+ attr_reader type(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::names | ::Integer
418
+ attr_writer type(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::strings | ::Integer | ::Float
419
+ attr_reader type_const(): ::Integer
420
+ def clear_type: () -> void
421
+
422
+ # `Format` The extending format for the previously mentioned type.
423
+ attr_reader format(): ::String
424
+ attr_writer format(): ::String | ::Symbol
425
+ def clear_format: () -> void
426
+
427
+ # `Required` indicates if the header is optional
428
+ attr_accessor required(): bool
429
+ def clear_required: () -> void
430
+
431
+ type init_map = {
432
+ name: (::String | ::Symbol)?,
433
+ "name" => (::String | ::Symbol)?,
434
+ description: (::String | ::Symbol)?,
435
+ "description" => (::String | ::Symbol)?,
436
+ type: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::strings | ::Integer | ::Float)?,
437
+ "type" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::strings | ::Integer | ::Float)?,
438
+ format: (::String | ::Symbol)?,
439
+ "format" => (::String | ::Symbol)?,
440
+ required: bool?,
441
+ "required" => bool?,
442
+ }
443
+
444
+ def initialize: (?init_map initial_value) -> void
445
+
446
+ def []:
447
+ ("name" name) -> ::String
448
+ | ("description" name) -> ::String
449
+ | ("type" name) -> (::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::names | ::Integer)
450
+ | ("format" name) -> ::String
451
+ | ("required" name) -> bool
452
+
453
+ def []=:
454
+ ("name" name, (::String | ::Symbol) value) -> void
455
+ | ("description" name, (::String | ::Symbol) value) -> void
456
+ | ("type" name, (::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::HeaderParameter::Type::strings | ::Integer | ::Float) value) -> void
457
+ | ("format" name, (::String | ::Symbol) value) -> void
458
+ | ("required" name, bool value) -> void
459
+ end
460
+
461
+ # `Header` is a representation of OpenAPI v2 specification's Header object.
462
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject
463
+ class Header < ::Google::Protobuf::AbstractMessage
464
+
465
+ # `Description` is a short description of the header.
466
+ attr_reader description(): ::String
467
+ attr_writer description(): ::String | ::Symbol
468
+ def clear_description: () -> void
469
+
470
+ # The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
471
+ attr_reader type(): ::String
472
+ attr_writer type(): ::String | ::Symbol
473
+ def clear_type: () -> void
474
+
475
+ # `Format` The extending format for the previously mentioned type.
476
+ attr_reader format(): ::String
477
+ attr_writer format(): ::String | ::Symbol
478
+ def clear_format: () -> void
479
+
480
+ # `Default` Declares the value of the header that the server will use if none is provided.
481
+ # See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
482
+ # Unlike JSON Schema this value MUST conform to the defined type for the header.
483
+ attr_reader default(): ::String
484
+ attr_writer default(): ::String | ::Symbol
485
+ def clear_default: () -> void
486
+
487
+ # 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
488
+ attr_reader pattern(): ::String
489
+ attr_writer pattern(): ::String | ::Symbol
490
+ def clear_pattern: () -> void
491
+
492
+ type init_map = {
493
+ description: (::String | ::Symbol)?,
494
+ "description" => (::String | ::Symbol)?,
495
+ type: (::String | ::Symbol)?,
496
+ "type" => (::String | ::Symbol)?,
497
+ format: (::String | ::Symbol)?,
498
+ "format" => (::String | ::Symbol)?,
499
+ default: (::String | ::Symbol)?,
500
+ "default" => (::String | ::Symbol)?,
501
+ pattern: (::String | ::Symbol)?,
502
+ "pattern" => (::String | ::Symbol)?,
503
+ }
504
+
505
+ def initialize: (?init_map initial_value) -> void
506
+
507
+ def []:
508
+ ("description" name) -> ::String
509
+ | ("type" name) -> ::String
510
+ | ("format" name) -> ::String
511
+ | ("default" name) -> ::String
512
+ | ("pattern" name) -> ::String
513
+
514
+ def []=:
515
+ ("description" name, (::String | ::Symbol) value) -> void
516
+ | ("type" name, (::String | ::Symbol) value) -> void
517
+ | ("format" name, (::String | ::Symbol) value) -> void
518
+ | ("default" name, (::String | ::Symbol) value) -> void
519
+ | ("pattern" name, (::String | ::Symbol) value) -> void
520
+ end
521
+
522
+ # `Response` is a representation of OpenAPI v2 specification's Response object.
523
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject
524
+ class Response < ::Google::Protobuf::AbstractMessage
525
+
526
+ # `Description` is a short description of the response.
527
+ # GFM syntax can be used for rich text representation.
528
+ attr_reader description(): ::String
529
+ attr_writer description(): ::String | ::Symbol
530
+ def clear_description: () -> void
531
+
532
+ # `Schema` optionally defines the structure of the response.
533
+ # If `Schema` is not provided, it means there is no content to the response.
534
+ attr_accessor schema(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema?
535
+ def has_schema?: () -> bool
536
+ def clear_schema: () -> void
537
+
538
+ # `Headers` A list of headers that are sent with the response.
539
+ # `Header` name is expected to be a string in the canonical format of the MIME header key
540
+ # See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
541
+ attr_accessor headers(): ::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Header]
542
+ def clear_headers: () -> void
543
+
544
+ # `Examples` gives per-mimetype response examples.
545
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
546
+ attr_accessor examples(): ::Google::Protobuf::Map[::String, ::String]
547
+ def clear_examples: () -> void
548
+
549
+ # Custom properties that start with "x-" such as "x-foo" used to describe
550
+ # extra functionality that is not covered by the standard OpenAPI Specification.
551
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
552
+ attr_accessor extensions(): ::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]
553
+ def clear_extensions: () -> void
554
+
555
+ type init_map = {
556
+ description: (::String | ::Symbol)?,
557
+ "description" => (::String | ::Symbol)?,
558
+ schema: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema::init_map)?,
559
+ "schema" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema::init_map)?,
560
+ headers: ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Header]?,
561
+ "headers" => ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Header]?,
562
+ examples: ::Hash[::String | ::Symbol, ::String | ::Symbol]?,
563
+ "examples" => ::Hash[::String | ::Symbol, ::String | ::Symbol]?,
564
+ extensions: ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
565
+ "extensions" => ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
566
+ }
567
+
568
+ def initialize: (?init_map initial_value) -> void
569
+
570
+ def []:
571
+ ("description" name) -> ::String
572
+ | ("schema" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema?
573
+ | ("headers" name) -> (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Header])
574
+ | ("examples" name) -> (::Google::Protobuf::Map[::String, ::String])
575
+ | ("extensions" name) -> (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value])
576
+
577
+ def []=:
578
+ ("description" name, (::String | ::Symbol) value) -> void
579
+ | ("schema" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Schema? value) -> void
580
+ | ("headers" name, (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Header]) value) -> void
581
+ | ("examples" name, (::Google::Protobuf::Map[::String, ::String]) value) -> void
582
+ | ("extensions" name, (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]) value) -> void
583
+ end
584
+
585
+ # `Info` is a representation of OpenAPI v2 specification's Info object.
586
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject
587
+ # Example:
588
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
589
+ # info: {
590
+ # title: "Echo API";
591
+ # version: "1.0";
592
+ # description: "";
593
+ # contact: {
594
+ # name: "gRPC-Gateway project";
595
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway";
596
+ # email: "none@example.com";
597
+ # };
598
+ # license: {
599
+ # name: "BSD 3-Clause License";
600
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
601
+ # };
602
+ # };
603
+ # ...
604
+ # };
605
+ class Info < ::Google::Protobuf::AbstractMessage
606
+
607
+ # The title of the application.
608
+ attr_reader title(): ::String
609
+ attr_writer title(): ::String | ::Symbol
610
+ def clear_title: () -> void
611
+
612
+ # A short description of the application. GFM syntax can be used for rich
613
+ # text representation.
614
+ attr_reader description(): ::String
615
+ attr_writer description(): ::String | ::Symbol
616
+ def clear_description: () -> void
617
+
618
+ # The Terms of Service for the API.
619
+ attr_reader terms_of_service(): ::String
620
+ attr_writer terms_of_service(): ::String | ::Symbol
621
+ def clear_terms_of_service: () -> void
622
+
623
+ # The contact information for the exposed API.
624
+ attr_accessor contact(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact?
625
+ def has_contact?: () -> bool
626
+ def clear_contact: () -> void
627
+
628
+ # The license information for the exposed API.
629
+ attr_accessor license(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::License?
630
+ def has_license?: () -> bool
631
+ def clear_license: () -> void
632
+
633
+ # Provides the version of the application API (not to be confused
634
+ # with the specification version).
635
+ attr_reader version(): ::String
636
+ attr_writer version(): ::String | ::Symbol
637
+ def clear_version: () -> void
638
+
639
+ # Custom properties that start with "x-" such as "x-foo" used to describe
640
+ # extra functionality that is not covered by the standard OpenAPI Specification.
641
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
642
+ attr_accessor extensions(): ::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]
643
+ def clear_extensions: () -> void
644
+
645
+ type init_map = {
646
+ title: (::String | ::Symbol)?,
647
+ "title" => (::String | ::Symbol)?,
648
+ description: (::String | ::Symbol)?,
649
+ "description" => (::String | ::Symbol)?,
650
+ terms_of_service: (::String | ::Symbol)?,
651
+ "terms_of_service" => (::String | ::Symbol)?,
652
+ contact: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact::init_map)?,
653
+ "contact" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact::init_map)?,
654
+ license: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::License | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::License::init_map)?,
655
+ "license" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::License | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::License::init_map)?,
656
+ version: (::String | ::Symbol)?,
657
+ "version" => (::String | ::Symbol)?,
658
+ extensions: ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
659
+ "extensions" => ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
660
+ }
661
+
662
+ def initialize: (?init_map initial_value) -> void
663
+
664
+ def []:
665
+ ("title" name) -> ::String
666
+ | ("description" name) -> ::String
667
+ | ("terms_of_service" name) -> ::String
668
+ | ("contact" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact?
669
+ | ("license" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::License?
670
+ | ("version" name) -> ::String
671
+ | ("extensions" name) -> (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value])
672
+
673
+ def []=:
674
+ ("title" name, (::String | ::Symbol) value) -> void
675
+ | ("description" name, (::String | ::Symbol) value) -> void
676
+ | ("terms_of_service" name, (::String | ::Symbol) value) -> void
677
+ | ("contact" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Contact? value) -> void
678
+ | ("license" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::License? value) -> void
679
+ | ("version" name, (::String | ::Symbol) value) -> void
680
+ | ("extensions" name, (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]) value) -> void
681
+ end
682
+
683
+ # `Contact` is a representation of OpenAPI v2 specification's Contact object.
684
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#contactObject
685
+ # Example:
686
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
687
+ # info: {
688
+ # ...
689
+ # contact: {
690
+ # name: "gRPC-Gateway project";
691
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway";
692
+ # email: "none@example.com";
693
+ # };
694
+ # ...
695
+ # };
696
+ # ...
697
+ # };
698
+ class Contact < ::Google::Protobuf::AbstractMessage
699
+
700
+ # The identifying name of the contact person/organization.
701
+ attr_reader name(): ::String
702
+ attr_writer name(): ::String | ::Symbol
703
+ def clear_name: () -> void
704
+
705
+ # The URL pointing to the contact information. MUST be in the format of a
706
+ # URL.
707
+ attr_reader url(): ::String
708
+ attr_writer url(): ::String | ::Symbol
709
+ def clear_url: () -> void
710
+
711
+ # The email address of the contact person/organization. MUST be in the format
712
+ # of an email address.
713
+ attr_reader email(): ::String
714
+ attr_writer email(): ::String | ::Symbol
715
+ def clear_email: () -> void
716
+
717
+ type init_map = {
718
+ name: (::String | ::Symbol)?,
719
+ "name" => (::String | ::Symbol)?,
720
+ url: (::String | ::Symbol)?,
721
+ "url" => (::String | ::Symbol)?,
722
+ email: (::String | ::Symbol)?,
723
+ "email" => (::String | ::Symbol)?,
724
+ }
725
+
726
+ def initialize: (?init_map initial_value) -> void
727
+
728
+ def []:
729
+ ("name" name) -> ::String
730
+ | ("url" name) -> ::String
731
+ | ("email" name) -> ::String
732
+
733
+ def []=:
734
+ ("name" name, (::String | ::Symbol) value) -> void
735
+ | ("url" name, (::String | ::Symbol) value) -> void
736
+ | ("email" name, (::String | ::Symbol) value) -> void
737
+ end
738
+
739
+ # `License` is a representation of OpenAPI v2 specification's License object.
740
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#licenseObject
741
+ # Example:
742
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
743
+ # info: {
744
+ # ...
745
+ # license: {
746
+ # name: "BSD 3-Clause License";
747
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
748
+ # };
749
+ # ...
750
+ # };
751
+ # ...
752
+ # };
753
+ class License < ::Google::Protobuf::AbstractMessage
754
+
755
+ # The license name used for the API.
756
+ attr_reader name(): ::String
757
+ attr_writer name(): ::String | ::Symbol
758
+ def clear_name: () -> void
759
+
760
+ # A URL to the license used for the API. MUST be in the format of a URL.
761
+ attr_reader url(): ::String
762
+ attr_writer url(): ::String | ::Symbol
763
+ def clear_url: () -> void
764
+
765
+ type init_map = {
766
+ name: (::String | ::Symbol)?,
767
+ "name" => (::String | ::Symbol)?,
768
+ url: (::String | ::Symbol)?,
769
+ "url" => (::String | ::Symbol)?,
770
+ }
771
+
772
+ def initialize: (?init_map initial_value) -> void
773
+
774
+ def []:
775
+ ("name" name) -> ::String
776
+ | ("url" name) -> ::String
777
+
778
+ def []=:
779
+ ("name" name, (::String | ::Symbol) value) -> void
780
+ | ("url" name, (::String | ::Symbol) value) -> void
781
+ end
782
+
783
+ # `ExternalDocumentation` is a representation of OpenAPI v2 specification's
784
+ # ExternalDocumentation object.
785
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject
786
+ # Example:
787
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
788
+ # ...
789
+ # external_docs: {
790
+ # description: "More about gRPC-Gateway";
791
+ # url: "https://github.com/grpc-ecosystem/grpc-gateway";
792
+ # }
793
+ # ...
794
+ # };
795
+ class ExternalDocumentation < ::Google::Protobuf::AbstractMessage
796
+
797
+ # A short description of the target documentation. GFM syntax can be used for
798
+ # rich text representation.
799
+ attr_reader description(): ::String
800
+ attr_writer description(): ::String | ::Symbol
801
+ def clear_description: () -> void
802
+
803
+ # The URL for the target documentation. Value MUST be in the format
804
+ # of a URL.
805
+ attr_reader url(): ::String
806
+ attr_writer url(): ::String | ::Symbol
807
+ def clear_url: () -> void
808
+
809
+ type init_map = {
810
+ description: (::String | ::Symbol)?,
811
+ "description" => (::String | ::Symbol)?,
812
+ url: (::String | ::Symbol)?,
813
+ "url" => (::String | ::Symbol)?,
814
+ }
815
+
816
+ def initialize: (?init_map initial_value) -> void
817
+
818
+ def []:
819
+ ("description" name) -> ::String
820
+ | ("url" name) -> ::String
821
+
822
+ def []=:
823
+ ("description" name, (::String | ::Symbol) value) -> void
824
+ | ("url" name, (::String | ::Symbol) value) -> void
825
+ end
826
+
827
+ # `Schema` is a representation of OpenAPI v2 specification's Schema object.
828
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
829
+ class Schema < ::Google::Protobuf::AbstractMessage
830
+
831
+ attr_accessor json_schema(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema?
832
+ def has_json_schema?: () -> bool
833
+ def clear_json_schema: () -> void
834
+
835
+ # Adds support for polymorphism. The discriminator is the schema property
836
+ # name that is used to differentiate between other schema that inherit this
837
+ # schema. The property name used MUST be defined at this schema and it MUST
838
+ # be in the required property list. When used, the value MUST be the name of
839
+ # this schema or any schema that inherits it.
840
+ attr_reader discriminator(): ::String
841
+ attr_writer discriminator(): ::String | ::Symbol
842
+ def clear_discriminator: () -> void
843
+
844
+ # Relevant only for Schema "properties" definitions. Declares the property as
845
+ # "read only". This means that it MAY be sent as part of a response but MUST
846
+ # NOT be sent as part of the request. Properties marked as readOnly being
847
+ # true SHOULD NOT be in the required list of the defined schema. Default
848
+ # value is false.
849
+ attr_accessor read_only(): bool
850
+ def clear_read_only: () -> void
851
+
852
+ # Additional external documentation for this schema.
853
+ attr_accessor external_docs(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
854
+ def has_external_docs?: () -> bool
855
+ def clear_external_docs: () -> void
856
+
857
+ # A free-form property to include an example of an instance for this schema in JSON.
858
+ # This is copied verbatim to the output.
859
+ attr_reader example(): ::String
860
+ attr_writer example(): ::String | ::Symbol
861
+ def clear_example: () -> void
862
+
863
+ type init_map = {
864
+ json_schema: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::init_map)?,
865
+ "json_schema" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::init_map)?,
866
+ discriminator: (::String | ::Symbol)?,
867
+ "discriminator" => (::String | ::Symbol)?,
868
+ read_only: bool?,
869
+ "read_only" => bool?,
870
+ external_docs: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
871
+ "external_docs" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
872
+ example: (::String | ::Symbol)?,
873
+ "example" => (::String | ::Symbol)?,
874
+ }
875
+
876
+ def initialize: (?init_map initial_value) -> void
877
+
878
+ def []:
879
+ ("json_schema" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema?
880
+ | ("discriminator" name) -> ::String
881
+ | ("read_only" name) -> bool
882
+ | ("external_docs" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
883
+ | ("example" name) -> ::String
884
+
885
+ def []=:
886
+ ("json_schema" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema? value) -> void
887
+ | ("discriminator" name, (::String | ::Symbol) value) -> void
888
+ | ("read_only" name, bool value) -> void
889
+ | ("external_docs" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation? value) -> void
890
+ | ("example" name, (::String | ::Symbol) value) -> void
891
+ end
892
+
893
+ # `EnumSchema` is subset of fields from the OpenAPI v2 specification's Schema object.
894
+ # Only fields that are applicable to Enums are included
895
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
896
+ # Example:
897
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_enum) = {
898
+ # ...
899
+ # title: "MyEnum";
900
+ # description:"This is my nice enum";
901
+ # example: "ZERO";
902
+ # required: true;
903
+ # ...
904
+ # };
905
+ class EnumSchema < ::Google::Protobuf::AbstractMessage
906
+
907
+ # A short description of the schema.
908
+ attr_reader description(): ::String
909
+ attr_writer description(): ::String | ::Symbol
910
+ def clear_description: () -> void
911
+
912
+ attr_reader default(): ::String
913
+ attr_writer default(): ::String | ::Symbol
914
+ def clear_default: () -> void
915
+
916
+ # The title of the schema.
917
+ attr_reader title(): ::String
918
+ attr_writer title(): ::String | ::Symbol
919
+ def clear_title: () -> void
920
+
921
+ attr_accessor required(): bool
922
+ def clear_required: () -> void
923
+
924
+ attr_accessor read_only(): bool
925
+ def clear_read_only: () -> void
926
+
927
+ # Additional external documentation for this schema.
928
+ attr_accessor external_docs(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
929
+ def has_external_docs?: () -> bool
930
+ def clear_external_docs: () -> void
931
+
932
+ attr_reader example(): ::String
933
+ attr_writer example(): ::String | ::Symbol
934
+ def clear_example: () -> void
935
+
936
+ # Ref is used to define an external reference to include in the message.
937
+ # This could be a fully qualified proto message reference, and that type must
938
+ # be imported into the protofile. If no message is identified, the Ref will
939
+ # be used verbatim in the output.
940
+ # For example:
941
+ # `ref: ".google.protobuf.Timestamp"`.
942
+ attr_reader ref(): ::String
943
+ attr_writer ref(): ::String | ::Symbol
944
+ def clear_ref: () -> void
945
+
946
+ # Custom properties that start with "x-" such as "x-foo" used to describe
947
+ # extra functionality that is not covered by the standard OpenAPI Specification.
948
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
949
+ attr_accessor extensions(): ::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]
950
+ def clear_extensions: () -> void
951
+
952
+ type init_map = {
953
+ description: (::String | ::Symbol)?,
954
+ "description" => (::String | ::Symbol)?,
955
+ default: (::String | ::Symbol)?,
956
+ "default" => (::String | ::Symbol)?,
957
+ title: (::String | ::Symbol)?,
958
+ "title" => (::String | ::Symbol)?,
959
+ required: bool?,
960
+ "required" => bool?,
961
+ read_only: bool?,
962
+ "read_only" => bool?,
963
+ external_docs: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
964
+ "external_docs" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
965
+ example: (::String | ::Symbol)?,
966
+ "example" => (::String | ::Symbol)?,
967
+ ref: (::String | ::Symbol)?,
968
+ "ref" => (::String | ::Symbol)?,
969
+ extensions: ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
970
+ "extensions" => ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
971
+ }
972
+
973
+ def initialize: (?init_map initial_value) -> void
974
+
975
+ def []:
976
+ ("description" name) -> ::String
977
+ | ("default" name) -> ::String
978
+ | ("title" name) -> ::String
979
+ | ("required" name) -> bool
980
+ | ("read_only" name) -> bool
981
+ | ("external_docs" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
982
+ | ("example" name) -> ::String
983
+ | ("ref" name) -> ::String
984
+ | ("extensions" name) -> (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value])
985
+
986
+ def []=:
987
+ ("description" name, (::String | ::Symbol) value) -> void
988
+ | ("default" name, (::String | ::Symbol) value) -> void
989
+ | ("title" name, (::String | ::Symbol) value) -> void
990
+ | ("required" name, bool value) -> void
991
+ | ("read_only" name, bool value) -> void
992
+ | ("external_docs" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation? value) -> void
993
+ | ("example" name, (::String | ::Symbol) value) -> void
994
+ | ("ref" name, (::String | ::Symbol) value) -> void
995
+ | ("extensions" name, (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]) value) -> void
996
+ end
997
+
998
+ # `JSONSchema` represents properties from JSON Schema taken, and as used, in
999
+ # the OpenAPI v2 spec.
1000
+ # This includes changes made by OpenAPI v2.
1001
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
1002
+ # See also: https://cswr.github.io/JsonSchema/spec/basic_types/,
1003
+ # https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json
1004
+ # Example:
1005
+ # message SimpleMessage {
1006
+ # option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
1007
+ # json_schema: {
1008
+ # title: "SimpleMessage"
1009
+ # description: "A simple message."
1010
+ # required: ["id"]
1011
+ # }
1012
+ # };
1013
+ # // Id represents the message identifier.
1014
+ # string id = 1; [
1015
+ # (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
1016
+ # description: "The unique identifier of the simple message."
1017
+ # }];
1018
+ # }
1019
+ class JSONSchema < ::Google::Protobuf::AbstractMessage
1020
+ # 'FieldConfiguration' provides additional field level properties used when generating the OpenAPI v2 file.
1021
+ # These properties are not defined by OpenAPIv2, but they are used to control the generation.
1022
+ class FieldConfiguration < ::Google::Protobuf::AbstractMessage
1023
+
1024
+ # Alternative parameter name when used as path parameter. If set, this will
1025
+ # be used as the complete parameter name when this field is used as a path
1026
+ # parameter. Use this to avoid having auto generated path parameter names
1027
+ # for overlapping paths.
1028
+ attr_reader path_param_name(): ::String
1029
+ attr_writer path_param_name(): ::String | ::Symbol
1030
+ def clear_path_param_name: () -> void
1031
+
1032
+ type init_map = {
1033
+ path_param_name: (::String | ::Symbol)?,
1034
+ "path_param_name" => (::String | ::Symbol)?,
1035
+ }
1036
+
1037
+ def initialize: (?init_map initial_value) -> void
1038
+
1039
+ def []:
1040
+ ("path_param_name" name) -> ::String
1041
+
1042
+ def []=:
1043
+ ("path_param_name" name, (::String | ::Symbol) value) -> void
1044
+ end
1045
+
1046
+ module JSONSchemaSimpleTypes
1047
+
1048
+ UNKNOWN: 0
1049
+
1050
+ ARRAY: 1
1051
+
1052
+ BOOLEAN: 2
1053
+
1054
+ INTEGER: 3
1055
+
1056
+ NULL: 4
1057
+
1058
+ NUMBER: 5
1059
+
1060
+ OBJECT: 6
1061
+
1062
+ STRING: 7
1063
+
1064
+ def self.lookup: (::Integer number) -> ::Symbol
1065
+
1066
+
1067
+ def self.resolve: (::Symbol name) -> ::Integer
1068
+
1069
+
1070
+ type names = :UNKNOWN | :ARRAY | :BOOLEAN | :INTEGER | :NULL | :NUMBER | :OBJECT | :STRING
1071
+
1072
+ type strings = "UNKNOWN" | "ARRAY" | "BOOLEAN" | "INTEGER" | "NULL" | "NUMBER" | "OBJECT" | "STRING"
1073
+
1074
+ type numbers = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7
1075
+ end
1076
+
1077
+ # Ref is used to define an external reference to include in the message.
1078
+ # This could be a fully qualified proto message reference, and that type must
1079
+ # be imported into the protofile. If no message is identified, the Ref will
1080
+ # be used verbatim in the output.
1081
+ # For example:
1082
+ # `ref: ".google.protobuf.Timestamp"`.
1083
+ attr_reader ref(): ::String
1084
+ attr_writer ref(): ::String | ::Symbol
1085
+ def clear_ref: () -> void
1086
+
1087
+ # The title of the schema.
1088
+ attr_reader title(): ::String
1089
+ attr_writer title(): ::String | ::Symbol
1090
+ def clear_title: () -> void
1091
+
1092
+ # A short description of the schema.
1093
+ attr_reader description(): ::String
1094
+ attr_writer description(): ::String | ::Symbol
1095
+ def clear_description: () -> void
1096
+
1097
+ attr_reader default(): ::String
1098
+ attr_writer default(): ::String | ::Symbol
1099
+ def clear_default: () -> void
1100
+
1101
+ attr_accessor read_only(): bool
1102
+ def clear_read_only: () -> void
1103
+
1104
+ # A free-form property to include a JSON example of this field. This is copied
1105
+ # verbatim to the output swagger.json. Quotes must be escaped.
1106
+ # 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
1107
+ attr_reader example(): ::String
1108
+ attr_writer example(): ::String | ::Symbol
1109
+ def clear_example: () -> void
1110
+
1111
+ attr_reader multiple_of(): ::Float
1112
+ attr_writer multiple_of(): ::Float | ::Integer
1113
+ def clear_multiple_of: () -> void
1114
+
1115
+ # Maximum represents an inclusive upper limit for a numeric instance. The
1116
+ # value of MUST be a number,
1117
+ attr_reader maximum(): ::Float
1118
+ attr_writer maximum(): ::Float | ::Integer
1119
+ def clear_maximum: () -> void
1120
+
1121
+ attr_accessor exclusive_maximum(): bool
1122
+ def clear_exclusive_maximum: () -> void
1123
+
1124
+ # minimum represents an inclusive lower limit for a numeric instance. The
1125
+ # value of MUST be a number,
1126
+ attr_reader minimum(): ::Float
1127
+ attr_writer minimum(): ::Float | ::Integer
1128
+ def clear_minimum: () -> void
1129
+
1130
+ attr_accessor exclusive_minimum(): bool
1131
+ def clear_exclusive_minimum: () -> void
1132
+
1133
+ attr_reader max_length(): ::Integer
1134
+ attr_writer max_length(): ::Integer | ::Float
1135
+ def clear_max_length: () -> void
1136
+
1137
+ attr_reader min_length(): ::Integer
1138
+ attr_writer min_length(): ::Integer | ::Float
1139
+ def clear_min_length: () -> void
1140
+
1141
+ attr_reader pattern(): ::String
1142
+ attr_writer pattern(): ::String | ::Symbol
1143
+ def clear_pattern: () -> void
1144
+
1145
+ attr_reader max_items(): ::Integer
1146
+ attr_writer max_items(): ::Integer | ::Float
1147
+ def clear_max_items: () -> void
1148
+
1149
+ attr_reader min_items(): ::Integer
1150
+ attr_writer min_items(): ::Integer | ::Float
1151
+ def clear_min_items: () -> void
1152
+
1153
+ attr_accessor unique_items(): bool
1154
+ def clear_unique_items: () -> void
1155
+
1156
+ attr_reader max_properties(): ::Integer
1157
+ attr_writer max_properties(): ::Integer | ::Float
1158
+ def clear_max_properties: () -> void
1159
+
1160
+ attr_reader min_properties(): ::Integer
1161
+ attr_writer min_properties(): ::Integer | ::Float
1162
+ def clear_min_properties: () -> void
1163
+
1164
+ attr_accessor required(): ::Google::Protobuf::RepeatedField
1165
+ def clear_required: () -> void
1166
+
1167
+ # Items in 'array' must be unique.
1168
+ attr_accessor array(): ::Google::Protobuf::RepeatedField
1169
+ def clear_array: () -> void
1170
+
1171
+ attr_accessor type(): ::Google::Protobuf::RepeatedField
1172
+ attr_reader type_const(): ::Array[::Integer]
1173
+ def clear_type: () -> void
1174
+
1175
+ # `Format`
1176
+ attr_reader format(): ::String
1177
+ attr_writer format(): ::String | ::Symbol
1178
+ def clear_format: () -> void
1179
+
1180
+ # Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
1181
+ attr_accessor enum(): ::Google::Protobuf::RepeatedField
1182
+ def clear_enum: () -> void
1183
+
1184
+ # Additional field level properties used when generating the OpenAPI v2 file.
1185
+ attr_accessor field_configuration(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration?
1186
+ def has_field_configuration?: () -> bool
1187
+ def clear_field_configuration: () -> void
1188
+
1189
+ # Custom properties that start with "x-" such as "x-foo" used to describe
1190
+ # extra functionality that is not covered by the standard OpenAPI Specification.
1191
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1192
+ attr_accessor extensions(): ::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]
1193
+ def clear_extensions: () -> void
1194
+
1195
+ type init_map = {
1196
+ ref: (::String | ::Symbol)?,
1197
+ "ref" => (::String | ::Symbol)?,
1198
+ title: (::String | ::Symbol)?,
1199
+ "title" => (::String | ::Symbol)?,
1200
+ description: (::String | ::Symbol)?,
1201
+ "description" => (::String | ::Symbol)?,
1202
+ default: (::String | ::Symbol)?,
1203
+ "default" => (::String | ::Symbol)?,
1204
+ read_only: bool?,
1205
+ "read_only" => bool?,
1206
+ example: (::String | ::Symbol)?,
1207
+ "example" => (::String | ::Symbol)?,
1208
+ multiple_of: (::Float | ::Integer)?,
1209
+ "multiple_of" => (::Float | ::Integer)?,
1210
+ maximum: (::Float | ::Integer)?,
1211
+ "maximum" => (::Float | ::Integer)?,
1212
+ exclusive_maximum: bool?,
1213
+ "exclusive_maximum" => bool?,
1214
+ minimum: (::Float | ::Integer)?,
1215
+ "minimum" => (::Float | ::Integer)?,
1216
+ exclusive_minimum: bool?,
1217
+ "exclusive_minimum" => bool?,
1218
+ max_length: (::Integer | ::Float)?,
1219
+ "max_length" => (::Integer | ::Float)?,
1220
+ min_length: (::Integer | ::Float)?,
1221
+ "min_length" => (::Integer | ::Float)?,
1222
+ pattern: (::String | ::Symbol)?,
1223
+ "pattern" => (::String | ::Symbol)?,
1224
+ max_items: (::Integer | ::Float)?,
1225
+ "max_items" => (::Integer | ::Float)?,
1226
+ min_items: (::Integer | ::Float)?,
1227
+ "min_items" => (::Integer | ::Float)?,
1228
+ unique_items: bool?,
1229
+ "unique_items" => bool?,
1230
+ max_properties: (::Integer | ::Float)?,
1231
+ "max_properties" => (::Integer | ::Float)?,
1232
+ min_properties: (::Integer | ::Float)?,
1233
+ "min_properties" => (::Integer | ::Float)?,
1234
+ required: ::Array[::String | ::Symbol]?,
1235
+ "required" => ::Array[::String | ::Symbol]?,
1236
+ array: ::Array[::String | ::Symbol]?,
1237
+ "array" => ::Array[::String | ::Symbol]?,
1238
+ type: ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::JSONSchemaSimpleTypes::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::JSONSchemaSimpleTypes::strings | ::Integer | ::Float]?,
1239
+ "type" => ::Array[::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::JSONSchemaSimpleTypes::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::JSONSchemaSimpleTypes::strings | ::Integer | ::Float]?,
1240
+ format: (::String | ::Symbol)?,
1241
+ "format" => (::String | ::Symbol)?,
1242
+ enum: ::Array[::String | ::Symbol]?,
1243
+ "enum" => ::Array[::String | ::Symbol]?,
1244
+ field_configuration: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration::init_map)?,
1245
+ "field_configuration" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration::init_map)?,
1246
+ extensions: ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
1247
+ "extensions" => ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
1248
+ }
1249
+
1250
+ def initialize: (?init_map initial_value) -> void
1251
+
1252
+ def []:
1253
+ ("ref" name) -> ::String
1254
+ | ("title" name) -> ::String
1255
+ | ("description" name) -> ::String
1256
+ | ("default" name) -> ::String
1257
+ | ("read_only" name) -> bool
1258
+ | ("example" name) -> ::String
1259
+ | ("multiple_of" name) -> ::Float
1260
+ | ("maximum" name) -> ::Float
1261
+ | ("exclusive_maximum" name) -> bool
1262
+ | ("minimum" name) -> ::Float
1263
+ | ("exclusive_minimum" name) -> bool
1264
+ | ("max_length" name) -> ::Integer
1265
+ | ("min_length" name) -> ::Integer
1266
+ | ("pattern" name) -> ::String
1267
+ | ("max_items" name) -> ::Integer
1268
+ | ("min_items" name) -> ::Integer
1269
+ | ("unique_items" name) -> bool
1270
+ | ("max_properties" name) -> ::Integer
1271
+ | ("min_properties" name) -> ::Integer
1272
+ | ("required" name) -> (::Google::Protobuf::RepeatedField)
1273
+ | ("array" name) -> (::Google::Protobuf::RepeatedField)
1274
+ | ("type" name) -> (::Google::Protobuf::RepeatedField)
1275
+ | ("format" name) -> ::String
1276
+ | ("enum" name) -> (::Google::Protobuf::RepeatedField)
1277
+ | ("field_configuration" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration?
1278
+ | ("extensions" name) -> (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value])
1279
+
1280
+ def []=:
1281
+ ("ref" name, (::String | ::Symbol) value) -> void
1282
+ | ("title" name, (::String | ::Symbol) value) -> void
1283
+ | ("description" name, (::String | ::Symbol) value) -> void
1284
+ | ("default" name, (::String | ::Symbol) value) -> void
1285
+ | ("read_only" name, bool value) -> void
1286
+ | ("example" name, (::String | ::Symbol) value) -> void
1287
+ | ("multiple_of" name, (::Float | ::Integer) value) -> void
1288
+ | ("maximum" name, (::Float | ::Integer) value) -> void
1289
+ | ("exclusive_maximum" name, bool value) -> void
1290
+ | ("minimum" name, (::Float | ::Integer) value) -> void
1291
+ | ("exclusive_minimum" name, bool value) -> void
1292
+ | ("max_length" name, (::Integer | ::Float) value) -> void
1293
+ | ("min_length" name, (::Integer | ::Float) value) -> void
1294
+ | ("pattern" name, (::String | ::Symbol) value) -> void
1295
+ | ("max_items" name, (::Integer | ::Float) value) -> void
1296
+ | ("min_items" name, (::Integer | ::Float) value) -> void
1297
+ | ("unique_items" name, bool value) -> void
1298
+ | ("max_properties" name, (::Integer | ::Float) value) -> void
1299
+ | ("min_properties" name, (::Integer | ::Float) value) -> void
1300
+ | ("required" name, (::Google::Protobuf::RepeatedField) value) -> void
1301
+ | ("array" name, (::Google::Protobuf::RepeatedField) value) -> void
1302
+ | ("type" name, (::Google::Protobuf::RepeatedField) value) -> void
1303
+ | ("format" name, (::String | ::Symbol) value) -> void
1304
+ | ("enum" name, (::Google::Protobuf::RepeatedField) value) -> void
1305
+ | ("field_configuration" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::JSONSchema::FieldConfiguration? value) -> void
1306
+ | ("extensions" name, (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]) value) -> void
1307
+ end
1308
+
1309
+ # `Tag` is a representation of OpenAPI v2 specification's Tag object.
1310
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject
1311
+ class Tag < ::Google::Protobuf::AbstractMessage
1312
+
1313
+ # The name of the tag. Use it to allow override of the name of a
1314
+ # global Tag object, then use that name to reference the tag throughout the
1315
+ # OpenAPI file.
1316
+ attr_reader name(): ::String
1317
+ attr_writer name(): ::String | ::Symbol
1318
+ def clear_name: () -> void
1319
+
1320
+ # A short description for the tag. GFM syntax can be used for rich text
1321
+ # representation.
1322
+ attr_reader description(): ::String
1323
+ attr_writer description(): ::String | ::Symbol
1324
+ def clear_description: () -> void
1325
+
1326
+ # Additional external documentation for this tag.
1327
+ attr_accessor external_docs(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
1328
+ def has_external_docs?: () -> bool
1329
+ def clear_external_docs: () -> void
1330
+
1331
+ # Custom properties that start with "x-" such as "x-foo" used to describe
1332
+ # extra functionality that is not covered by the standard OpenAPI Specification.
1333
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1334
+ attr_accessor extensions(): ::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]
1335
+ def clear_extensions: () -> void
1336
+
1337
+ type init_map = {
1338
+ name: (::String | ::Symbol)?,
1339
+ "name" => (::String | ::Symbol)?,
1340
+ description: (::String | ::Symbol)?,
1341
+ "description" => (::String | ::Symbol)?,
1342
+ external_docs: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
1343
+ "external_docs" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation::init_map)?,
1344
+ extensions: ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
1345
+ "extensions" => ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
1346
+ }
1347
+
1348
+ def initialize: (?init_map initial_value) -> void
1349
+
1350
+ def []:
1351
+ ("name" name) -> ::String
1352
+ | ("description" name) -> ::String
1353
+ | ("external_docs" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation?
1354
+ | ("extensions" name) -> (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value])
1355
+
1356
+ def []=:
1357
+ ("name" name, (::String | ::Symbol) value) -> void
1358
+ | ("description" name, (::String | ::Symbol) value) -> void
1359
+ | ("external_docs" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::ExternalDocumentation? value) -> void
1360
+ | ("extensions" name, (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]) value) -> void
1361
+ end
1362
+
1363
+ # `SecurityDefinitions` is a representation of OpenAPI v2 specification's
1364
+ # Security Definitions object.
1365
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityDefinitionsObject
1366
+ # A declaration of the security schemes available to be used in the
1367
+ # specification. This does not enforce the security schemes on the operations
1368
+ # and only serves to provide the relevant details for each scheme.
1369
+ class SecurityDefinitions < ::Google::Protobuf::AbstractMessage
1370
+
1371
+ # A single security scheme definition, mapping a "name" to the scheme it
1372
+ # defines.
1373
+ attr_accessor security(): ::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme]
1374
+ def clear_security: () -> void
1375
+
1376
+ type init_map = {
1377
+ security: ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme]?,
1378
+ "security" => ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme]?,
1379
+ }
1380
+
1381
+ def initialize: (?init_map initial_value) -> void
1382
+
1383
+ def []:
1384
+ ("security" name) -> (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme])
1385
+
1386
+ def []=:
1387
+ ("security" name, (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme]) value) -> void
1388
+ end
1389
+
1390
+ # `SecurityScheme` is a representation of OpenAPI v2 specification's
1391
+ # Security Scheme object.
1392
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject
1393
+ # Allows the definition of a security scheme that can be used by the
1394
+ # operations. Supported schemes are basic authentication, an API key (either as
1395
+ # a header or as a query parameter) and OAuth2's common flows (implicit,
1396
+ # password, application and access code).
1397
+ class SecurityScheme < ::Google::Protobuf::AbstractMessage
1398
+ # The type of the security scheme. Valid values are "basic",
1399
+ # "apiKey" or "oauth2".
1400
+ module Type
1401
+
1402
+ TYPE_INVALID: 0
1403
+
1404
+ TYPE_BASIC: 1
1405
+
1406
+ TYPE_API_KEY: 2
1407
+
1408
+ TYPE_OAUTH2: 3
1409
+
1410
+ def self.lookup: (::Integer number) -> ::Symbol
1411
+
1412
+
1413
+ def self.resolve: (::Symbol name) -> ::Integer
1414
+
1415
+
1416
+ type names = :TYPE_INVALID | :TYPE_BASIC | :TYPE_API_KEY | :TYPE_OAUTH2
1417
+
1418
+ type strings = "TYPE_INVALID" | "TYPE_BASIC" | "TYPE_API_KEY" | "TYPE_OAUTH2"
1419
+
1420
+ type numbers = 0 | 1 | 2 | 3
1421
+ end
1422
+
1423
+ # The location of the API key. Valid values are "query" or "header".
1424
+ module In
1425
+
1426
+ IN_INVALID: 0
1427
+
1428
+ IN_QUERY: 1
1429
+
1430
+ IN_HEADER: 2
1431
+
1432
+ def self.lookup: (::Integer number) -> ::Symbol
1433
+
1434
+
1435
+ def self.resolve: (::Symbol name) -> ::Integer
1436
+
1437
+
1438
+ type names = :IN_INVALID | :IN_QUERY | :IN_HEADER
1439
+
1440
+ type strings = "IN_INVALID" | "IN_QUERY" | "IN_HEADER"
1441
+
1442
+ type numbers = 0 | 1 | 2
1443
+ end
1444
+
1445
+ # The flow used by the OAuth2 security scheme. Valid values are
1446
+ # "implicit", "password", "application" or "accessCode".
1447
+ module Flow
1448
+
1449
+ FLOW_INVALID: 0
1450
+
1451
+ FLOW_IMPLICIT: 1
1452
+
1453
+ FLOW_PASSWORD: 2
1454
+
1455
+ FLOW_APPLICATION: 3
1456
+
1457
+ FLOW_ACCESS_CODE: 4
1458
+
1459
+ def self.lookup: (::Integer number) -> ::Symbol
1460
+
1461
+
1462
+ def self.resolve: (::Symbol name) -> ::Integer
1463
+
1464
+
1465
+ type names = :FLOW_INVALID | :FLOW_IMPLICIT | :FLOW_PASSWORD | :FLOW_APPLICATION | :FLOW_ACCESS_CODE
1466
+
1467
+ type strings = "FLOW_INVALID" | "FLOW_IMPLICIT" | "FLOW_PASSWORD" | "FLOW_APPLICATION" | "FLOW_ACCESS_CODE"
1468
+
1469
+ type numbers = 0 | 1 | 2 | 3 | 4
1470
+ end
1471
+
1472
+ # The type of the security scheme. Valid values are "basic",
1473
+ # "apiKey" or "oauth2".
1474
+ attr_reader type(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::names | ::Integer
1475
+ attr_writer type(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::strings | ::Integer | ::Float
1476
+ attr_reader type_const(): ::Integer
1477
+ def clear_type: () -> void
1478
+
1479
+ # A short description for security scheme.
1480
+ attr_reader description(): ::String
1481
+ attr_writer description(): ::String | ::Symbol
1482
+ def clear_description: () -> void
1483
+
1484
+ # The name of the header or query parameter to be used.
1485
+ # Valid for apiKey.
1486
+ attr_reader name(): ::String
1487
+ attr_writer name(): ::String | ::Symbol
1488
+ def clear_name: () -> void
1489
+
1490
+ # The location of the API key. Valid values are "query" or
1491
+ # "header".
1492
+ # Valid for apiKey.
1493
+ attr_reader in(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::names | ::Integer
1494
+ attr_writer in(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::strings | ::Integer | ::Float
1495
+ attr_reader in_const(): ::Integer
1496
+ def clear_in: () -> void
1497
+
1498
+ # The flow used by the OAuth2 security scheme. Valid values are
1499
+ # "implicit", "password", "application" or "accessCode".
1500
+ # Valid for oauth2.
1501
+ attr_reader flow(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::names | ::Integer
1502
+ attr_writer flow(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::strings | ::Integer | ::Float
1503
+ attr_reader flow_const(): ::Integer
1504
+ def clear_flow: () -> void
1505
+
1506
+ # The authorization URL to be used for this flow. This SHOULD be in
1507
+ # the form of a URL.
1508
+ # Valid for oauth2/implicit and oauth2/accessCode.
1509
+ attr_reader authorization_url(): ::String
1510
+ attr_writer authorization_url(): ::String | ::Symbol
1511
+ def clear_authorization_url: () -> void
1512
+
1513
+ # The token URL to be used for this flow. This SHOULD be in the
1514
+ # form of a URL.
1515
+ # Valid for oauth2/password, oauth2/application and oauth2/accessCode.
1516
+ attr_reader token_url(): ::String
1517
+ attr_writer token_url(): ::String | ::Symbol
1518
+ def clear_token_url: () -> void
1519
+
1520
+ # The available scopes for the OAuth2 security scheme.
1521
+ # Valid for oauth2.
1522
+ attr_accessor scopes(): ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes?
1523
+ def has_scopes?: () -> bool
1524
+ def clear_scopes: () -> void
1525
+
1526
+ # Custom properties that start with "x-" such as "x-foo" used to describe
1527
+ # extra functionality that is not covered by the standard OpenAPI Specification.
1528
+ # See: https://swagger.io/docs/specification/2-0/swagger-extensions/
1529
+ attr_accessor extensions(): ::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]
1530
+ def clear_extensions: () -> void
1531
+
1532
+ type init_map = {
1533
+ type: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::strings | ::Integer | ::Float)?,
1534
+ "type" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::strings | ::Integer | ::Float)?,
1535
+ description: (::String | ::Symbol)?,
1536
+ "description" => (::String | ::Symbol)?,
1537
+ name: (::String | ::Symbol)?,
1538
+ "name" => (::String | ::Symbol)?,
1539
+ in: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::strings | ::Integer | ::Float)?,
1540
+ "in" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::strings | ::Integer | ::Float)?,
1541
+ flow: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::strings | ::Integer | ::Float)?,
1542
+ "flow" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::strings | ::Integer | ::Float)?,
1543
+ authorization_url: (::String | ::Symbol)?,
1544
+ "authorization_url" => (::String | ::Symbol)?,
1545
+ token_url: (::String | ::Symbol)?,
1546
+ "token_url" => (::String | ::Symbol)?,
1547
+ scopes: (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes::init_map)?,
1548
+ "scopes" => (::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes::init_map)?,
1549
+ extensions: ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
1550
+ "extensions" => ::Hash[::String | ::Symbol, ::Google::Protobuf::Value]?,
1551
+ }
1552
+
1553
+ def initialize: (?init_map initial_value) -> void
1554
+
1555
+ def []:
1556
+ ("type" name) -> (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::names | ::Integer)
1557
+ | ("description" name) -> ::String
1558
+ | ("name" name) -> ::String
1559
+ | ("in" name) -> (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::names | ::Integer)
1560
+ | ("flow" name) -> (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::names | ::Integer)
1561
+ | ("authorization_url" name) -> ::String
1562
+ | ("token_url" name) -> ::String
1563
+ | ("scopes" name) -> ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes?
1564
+ | ("extensions" name) -> (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value])
1565
+
1566
+ def []=:
1567
+ ("type" name, (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Type::strings | ::Integer | ::Float) value) -> void
1568
+ | ("description" name, (::String | ::Symbol) value) -> void
1569
+ | ("name" name, (::String | ::Symbol) value) -> void
1570
+ | ("in" name, (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::In::strings | ::Integer | ::Float) value) -> void
1571
+ | ("flow" name, (::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::names | ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityScheme::Flow::strings | ::Integer | ::Float) value) -> void
1572
+ | ("authorization_url" name, (::String | ::Symbol) value) -> void
1573
+ | ("token_url" name, (::String | ::Symbol) value) -> void
1574
+ | ("scopes" name, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::Scopes? value) -> void
1575
+ | ("extensions" name, (::Google::Protobuf::Map[::String, ::Google::Protobuf::Value]) value) -> void
1576
+ end
1577
+
1578
+ # `SecurityRequirement` is a representation of OpenAPI v2 specification's
1579
+ # Security Requirement object.
1580
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityRequirementObject
1581
+ # Lists the required security schemes to execute this operation. The object can
1582
+ # have multiple security schemes declared in it which are all required (that
1583
+ # is, there is a logical AND between the schemes).
1584
+ # The name used for each property MUST correspond to a security scheme
1585
+ # declared in the Security Definitions.
1586
+ class SecurityRequirement < ::Google::Protobuf::AbstractMessage
1587
+ # If the security scheme is of type "oauth2", then the value is a list of
1588
+ # scope names required for the execution. For other security scheme types,
1589
+ # the array MUST be empty.
1590
+ class SecurityRequirementValue < ::Google::Protobuf::AbstractMessage
1591
+
1592
+ attr_accessor scope(): ::Google::Protobuf::RepeatedField
1593
+ def clear_scope: () -> void
1594
+
1595
+ type init_map = {
1596
+ scope: ::Array[::String | ::Symbol]?,
1597
+ "scope" => ::Array[::String | ::Symbol]?,
1598
+ }
1599
+
1600
+ def initialize: (?init_map initial_value) -> void
1601
+
1602
+ def []:
1603
+ ("scope" name) -> (::Google::Protobuf::RepeatedField)
1604
+
1605
+ def []=:
1606
+ ("scope" name, (::Google::Protobuf::RepeatedField) value) -> void
1607
+ end
1608
+
1609
+ # Each name must correspond to a security scheme which is declared in
1610
+ # the Security Definitions. If the security scheme is of type "oauth2",
1611
+ # then the value is a list of scope names required for the execution.
1612
+ # For other security scheme types, the array MUST be empty.
1613
+ attr_accessor security_requirement(): ::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue]
1614
+ def clear_security_requirement: () -> void
1615
+
1616
+ type init_map = {
1617
+ security_requirement: ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue]?,
1618
+ "security_requirement" => ::Hash[::String | ::Symbol, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue]?,
1619
+ }
1620
+
1621
+ def initialize: (?init_map initial_value) -> void
1622
+
1623
+ def []:
1624
+ ("security_requirement" name) -> (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue])
1625
+
1626
+ def []=:
1627
+ ("security_requirement" name, (::Google::Protobuf::Map[::String, ::Grpc::Gateway::ProtocGenOpenapiv2::Options::SecurityRequirement::SecurityRequirementValue]) value) -> void
1628
+ end
1629
+
1630
+ # `Scopes` is a representation of OpenAPI v2 specification's Scopes object.
1631
+ # See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#scopesObject
1632
+ # Lists the available scopes for an OAuth2 security scheme.
1633
+ class Scopes < ::Google::Protobuf::AbstractMessage
1634
+
1635
+ # Maps between a name of a scope to a short description of it (as the value
1636
+ # of the property).
1637
+ attr_accessor scope(): ::Google::Protobuf::Map[::String, ::String]
1638
+ def clear_scope: () -> void
1639
+
1640
+ type init_map = {
1641
+ scope: ::Hash[::String | ::Symbol, ::String | ::Symbol]?,
1642
+ "scope" => ::Hash[::String | ::Symbol, ::String | ::Symbol]?,
1643
+ }
1644
+
1645
+ def initialize: (?init_map initial_value) -> void
1646
+
1647
+ def []:
1648
+ ("scope" name) -> (::Google::Protobuf::Map[::String, ::String])
1649
+
1650
+ def []=:
1651
+ ("scope" name, (::Google::Protobuf::Map[::String, ::String]) value) -> void
1652
+ end
1653
+
1654
+ # Scheme describes the schemes supported by the OpenAPI Swagger
1655
+ # and Operation objects.
1656
+ module Scheme
1657
+
1658
+ UNKNOWN: 0
1659
+
1660
+ HTTP: 1
1661
+
1662
+ HTTPS: 2
1663
+
1664
+ WS: 3
1665
+
1666
+ WSS: 4
1667
+
1668
+ def self.lookup: (::Integer number) -> ::Symbol
1669
+
1670
+
1671
+ def self.resolve: (::Symbol name) -> ::Integer
1672
+
1673
+
1674
+ type names = :UNKNOWN | :HTTP | :HTTPS | :WS | :WSS
1675
+
1676
+ type strings = "UNKNOWN" | "HTTP" | "HTTPS" | "WS" | "WSS"
1677
+
1678
+ type numbers = 0 | 1 | 2 | 3 | 4
1679
+ end
1680
+ end
1681
+ end
1682
+ end
1683
+ end
1684
+
1685
+ module Google
1686
+ module Protobuf
1687
+ class DescriptorPool
1688
+ def lookup: (::String name) -> ::Google::Protobuf::Descriptor
1689
+ end
1690
+ end
1691
+ end