@alphauspkgs/blue-sdk-ts 1.0.1

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 (265) hide show
  1. package/README.md +32 -0
  2. package/admin/v1/admin_pb.js +239 -0
  3. package/admin/v1/admin_pb.ts +1604 -0
  4. package/admin/v1/client.js +9 -0
  5. package/admin/v1/client.ts +7 -0
  6. package/api/account_pb.js +22 -0
  7. package/api/account_pb.ts +132 -0
  8. package/api/accountgroup_pb.js +18 -0
  9. package/api/accountgroup_pb.ts +56 -0
  10. package/api/adjustment_pb.js +26 -0
  11. package/api/adjustment_pb.ts +102 -0
  12. package/api/apiclient_pb.js +16 -0
  13. package/api/apiclient_pb.ts +66 -0
  14. package/api/audit_pb.js +21 -0
  15. package/api/audit_pb.ts +70 -0
  16. package/api/aws/breakeven_pb.js +21 -0
  17. package/api/aws/breakeven_pb.ts +93 -0
  18. package/api/aws/calculator_pb.js +31 -0
  19. package/api/aws/calculator_pb.ts +138 -0
  20. package/api/aws/cost_pb.js +22 -0
  21. package/api/aws/cost_pb.ts +315 -0
  22. package/api/aws/recommendation_pb.js +36 -0
  23. package/api/aws/recommendation_pb.ts +338 -0
  24. package/api/aws/reduction_pb.js +31 -0
  25. package/api/aws/reduction_pb.ts +416 -0
  26. package/api/azure/cost_pb.js +21 -0
  27. package/api/azure/cost_pb.ts +268 -0
  28. package/api/azureea/cost_pb.js +16 -0
  29. package/api/azureea/cost_pb.ts +141 -0
  30. package/api/budget_pb.js +57 -0
  31. package/api/budget_pb.ts +293 -0
  32. package/api/costtag_pb.js +17 -0
  33. package/api/costtag_pb.ts +77 -0
  34. package/api/cover/accountaccess_pb.js +46 -0
  35. package/api/cover/accountaccess_pb.ts +334 -0
  36. package/api/cover/alert_pb.js +36 -0
  37. package/api/cover/alert_pb.ts +183 -0
  38. package/api/cover/applyrecommendation_pb.js +41 -0
  39. package/api/cover/applyrecommendation_pb.ts +133 -0
  40. package/api/cover/asset_pb.js +26 -0
  41. package/api/cover/asset_pb.ts +305 -0
  42. package/api/cover/attribute_pb.js +21 -0
  43. package/api/cover/attribute_pb.ts +58 -0
  44. package/api/cover/budget_pb.js +42 -0
  45. package/api/cover/budget_pb.ts +275 -0
  46. package/api/cover/costforecast_pb.js +16 -0
  47. package/api/cover/costforecast_pb.ts +81 -0
  48. package/api/cover/costgroup_pb.js +89 -0
  49. package/api/cover/costgroup_pb.ts +473 -0
  50. package/api/cover/discountplan_pb.js +31 -0
  51. package/api/cover/discountplan_pb.ts +461 -0
  52. package/api/cover/discountrecommendation_pb.js +96 -0
  53. package/api/cover/discountrecommendation_pb.ts +500 -0
  54. package/api/cover/insightreport_pb.js +26 -0
  55. package/api/cover/insightreport_pb.ts +167 -0
  56. package/api/cover/optimizationrecommendation_pb.js +262 -0
  57. package/api/cover/optimizationrecommendation_pb.ts +1964 -0
  58. package/api/cover/recommendation/aws_pb.js +407 -0
  59. package/api/cover/recommendation/aws_pb.ts +2418 -0
  60. package/api/cover/recommendation/azurecsp_pb.js +16 -0
  61. package/api/cover/recommendation/azurecsp_pb.ts +27 -0
  62. package/api/cover/recommendation/gcp_pb.js +27 -0
  63. package/api/cover/recommendation/gcp_pb.ts +91 -0
  64. package/api/cover/recommendation/octoaws_pb.js +22 -0
  65. package/api/cover/recommendation/octoaws_pb.ts +55 -0
  66. package/api/cover/recommendation/octoazurecsp_pb.js +16 -0
  67. package/api/cover/recommendation/octoazurecsp_pb.ts +27 -0
  68. package/api/cover/recommendation/octogcp_pb.js +16 -0
  69. package/api/cover/recommendation/octogcp_pb.ts +27 -0
  70. package/api/cover/recommendation/recommendation_pb.js +27 -0
  71. package/api/cover/recommendation/recommendation_pb.ts +190 -0
  72. package/api/cover/rightsizingrecommendation_pb.js +21 -0
  73. package/api/cover/rightsizingrecommendation_pb.ts +133 -0
  74. package/api/cover/unitcost_pb.js +82 -0
  75. package/api/cover/unitcost_pb.ts +576 -0
  76. package/api/cover/user_pb.js +26 -0
  77. package/api/cover/user_pb.ts +330 -0
  78. package/api/cover/view_pb.js +53 -0
  79. package/api/cover/view_pb.ts +393 -0
  80. package/api/coverage_pb.js +31 -0
  81. package/api/coverage_pb.ts +132 -0
  82. package/api/forecast_pb.js +61 -0
  83. package/api/forecast_pb.ts +346 -0
  84. package/api/gcp/cost_pb.js +16 -0
  85. package/api/gcp/cost_pb.ts +128 -0
  86. package/api/grouprootuser_pb.js +21 -0
  87. package/api/grouprootuser_pb.ts +390 -0
  88. package/api/invoice_pb.js +96 -0
  89. package/api/invoice_pb.ts +905 -0
  90. package/api/keyvalue_pb.js +21 -0
  91. package/api/keyvalue_pb.ts +72 -0
  92. package/api/notification_pb.js +46 -0
  93. package/api/notification_pb.ts +232 -0
  94. package/api/pricing/details_pb.js +17 -0
  95. package/api/pricing/details_pb.ts +172 -0
  96. package/api/rbac_pb.js +31 -0
  97. package/api/rbac_pb.ts +142 -0
  98. package/api/ripple/accessgroup_pb.js +16 -0
  99. package/api/ripple/accessgroup_pb.ts +48 -0
  100. package/api/ripple/billinggroup_pb.js +16 -0
  101. package/api/ripple/billinggroup_pb.ts +154 -0
  102. package/api/ripple/customfield_pb.js +16 -0
  103. package/api/ripple/customfield_pb.ts +49 -0
  104. package/api/ripple/customizedbillingservice_pb.js +175 -0
  105. package/api/ripple/customizedbillingservice_pb.ts +455 -0
  106. package/api/ripple/duedate_pb.js +16 -0
  107. package/api/ripple/duedate_pb.ts +58 -0
  108. package/api/ripple/exchangerate_pb.js +41 -0
  109. package/api/ripple/exchangerate_pb.ts +205 -0
  110. package/api/ripple/invoicelayout_pb.js +46 -0
  111. package/api/ripple/invoicelayout_pb.ts +547 -0
  112. package/api/ripple/org_pb.js +16 -0
  113. package/api/ripple/org_pb.ts +51 -0
  114. package/api/ripple/payer_pb.js +18 -0
  115. package/api/ripple/payer_pb.ts +60 -0
  116. package/api/ripple/reseller_pb.js +21 -0
  117. package/api/ripple/reseller_pb.ts +168 -0
  118. package/api/ripple/rounding_pb.js +46 -0
  119. package/api/ripple/rounding_pb.ts +69 -0
  120. package/api/ripple/untaggedgroup_pb.js +28 -0
  121. package/api/ripple/untaggedgroup_pb.ts +151 -0
  122. package/api/ripple/v1/accountsupportplan_pb.js +59 -0
  123. package/api/ripple/v1/accountsupportplan_pb.ts +98 -0
  124. package/api/ripple/v1/adjustmententry_pb.js +31 -0
  125. package/api/ripple/v1/adjustmententry_pb.ts +275 -0
  126. package/api/ripple/v1/dashboard_pb.js +61 -0
  127. package/api/ripple/v1/dashboard_pb.ts +661 -0
  128. package/api/ripple/v1/export_pb.js +16 -0
  129. package/api/ripple/v1/export_pb.ts +49 -0
  130. package/api/ripple/v1/invoiceservicediscounts_pb.js +48 -0
  131. package/api/ripple/v1/invoiceservicediscounts_pb.ts +298 -0
  132. package/api/ripple/yearmonth_pb.js +16 -0
  133. package/api/ripple/yearmonth_pb.ts +35 -0
  134. package/api/user_pb.js +26 -0
  135. package/api/user_pb.ts +124 -0
  136. package/api/utilization_pb.js +21 -0
  137. package/api/utilization_pb.ts +78 -0
  138. package/api/wave/adjustment_pb.js +16 -0
  139. package/api/wave/adjustment_pb.ts +105 -0
  140. package/api/wave/budget_pb.js +27 -0
  141. package/api/wave/budget_pb.ts +122 -0
  142. package/billing/v1/billing_pb.js +952 -0
  143. package/billing/v1/billing_pb.ts +7570 -0
  144. package/billing/v1/client.js +9 -0
  145. package/billing/v1/client.ts +7 -0
  146. package/conn/conn.js +38 -0
  147. package/conn/conn.ts +46 -0
  148. package/cost/v1/client.js +9 -0
  149. package/cost/v1/client.ts +7 -0
  150. package/cost/v1/cost_pb.js +721 -0
  151. package/cost/v1/cost_pb.ts +5845 -0
  152. package/cover/v1/client.js +9 -0
  153. package/cover/v1/client.ts +7 -0
  154. package/cover/v1/cover_pb.js +2085 -0
  155. package/cover/v1/cover_pb.ts +12883 -0
  156. package/flow/v1/client.js +9 -0
  157. package/flow/v1/client.ts +7 -0
  158. package/flow/v1/flow_pb.js +265 -0
  159. package/flow/v1/flow_pb.ts +2496 -0
  160. package/google/api/annotations_pb.js +29 -0
  161. package/google/api/annotations_pb.ts +39 -0
  162. package/google/api/auth_pb.js +47 -0
  163. package/google/api/auth_pb.ts +295 -0
  164. package/google/api/backend_pb.js +31 -0
  165. package/google/api/backend_pb.ts +97 -0
  166. package/google/api/billing_pb.js +32 -0
  167. package/google/api/billing_pb.ts +104 -0
  168. package/google/api/client_pb.js +101 -0
  169. package/google/api/client_pb.ts +114 -0
  170. package/google/api/config_change_pb.js +71 -0
  171. package/google/api/config_change_pb.ts +161 -0
  172. package/google/api/consumer_pb.js +73 -0
  173. package/google/api/consumer_pb.ts +156 -0
  174. package/google/api/context_pb.js +31 -0
  175. package/google/api/context_pb.ts +105 -0
  176. package/google/api/control_pb.js +26 -0
  177. package/google/api/control_pb.ts +52 -0
  178. package/google/api/distribution_pb.js +58 -0
  179. package/google/api/distribution_pb.ts +388 -0
  180. package/google/api/documentation_pb.js +36 -0
  181. package/google/api/documentation_pb.ts +238 -0
  182. package/google/api/endpoint_pb.js +27 -0
  183. package/google/api/endpoint_pb.ts +105 -0
  184. package/google/api/field_behavior_pb.js +103 -0
  185. package/google/api/field_behavior_pb.ts +119 -0
  186. package/google/api/http_pb.js +36 -0
  187. package/google/api/http_pb.ts +420 -0
  188. package/google/api/httpbody_pb.js +27 -0
  189. package/google/api/httpbody_pb.ts +103 -0
  190. package/google/api/label_pb.js +56 -0
  191. package/google/api/label_pb.ts +97 -0
  192. package/google/api/launch_stage_pb.js +92 -0
  193. package/google/api/launch_stage_pb.ts +105 -0
  194. package/google/api/log_pb.js +27 -0
  195. package/google/api/log_pb.ts +86 -0
  196. package/google/api/logging_pb.js +32 -0
  197. package/google/api/logging_pb.ts +124 -0
  198. package/google/api/metric_pb.js +128 -0
  199. package/google/api/metric_pb.ts +322 -0
  200. package/google/api/monitored_resource_pb.js +38 -0
  201. package/google/api/monitored_resource_pb.ts +188 -0
  202. package/google/api/monitoring_pb.js +32 -0
  203. package/google/api/monitoring_pb.ts +130 -0
  204. package/google/api/quota_pb.js +37 -0
  205. package/google/api/quota_pb.ts +351 -0
  206. package/google/api/resource_pb.js +118 -0
  207. package/google/api/resource_pb.ts +410 -0
  208. package/google/api/service_pb.js +45 -0
  209. package/google/api/service_pb.ts +302 -0
  210. package/google/api/source_info_pb.js +27 -0
  211. package/google/api/source_info_pb.ts +51 -0
  212. package/google/api/system_parameter_pb.js +36 -0
  213. package/google/api/system_parameter_pb.ts +157 -0
  214. package/google/api/usage_pb.js +32 -0
  215. package/google/api/usage_pb.ts +141 -0
  216. package/google/longrunning/operations_pb.js +90 -0
  217. package/google/longrunning/operations_pb.ts +434 -0
  218. package/google/rpc/code_pb.js +244 -0
  219. package/google/rpc/code_pb.ts +268 -0
  220. package/google/rpc/context/attribute_context_pb.js +57 -0
  221. package/google/rpc/context/attribute_context_pb.ts +532 -0
  222. package/google/rpc/error_details_pb.js +92 -0
  223. package/google/rpc/error_details_pb.ts +513 -0
  224. package/google/rpc/status_pb.js +27 -0
  225. package/google/rpc/status_pb.ts +74 -0
  226. package/iam/v1/client.js +9 -0
  227. package/iam/v1/client.ts +8 -0
  228. package/iam/v1/iam_pb.js +285 -0
  229. package/iam/v1/iam_pb.ts +1698 -0
  230. package/kvstore/v1/kvstore_pb.js +40 -0
  231. package/kvstore/v1/kvstore_pb.ts +155 -0
  232. package/operations/v1/operations_pb.js +52 -0
  233. package/operations/v1/operations_pb.ts +235 -0
  234. package/org/v1/client.js +9 -0
  235. package/org/v1/client.ts +7 -0
  236. package/org/v1/org_pb.js +61 -0
  237. package/org/v1/org_pb.ts +321 -0
  238. package/package.json +22 -0
  239. package/preferences/v1/client.js +9 -0
  240. package/preferences/v1/client.ts +8 -0
  241. package/preferences/v1/preferences_pb.js +29 -0
  242. package/preferences/v1/preferences_pb.ts +63 -0
  243. package/pricing/v1/client.js +9 -0
  244. package/pricing/v1/client.ts +7 -0
  245. package/pricing/v1/pricing_pb.js +60 -0
  246. package/pricing/v1/pricing_pb.ts +311 -0
  247. package/prism/v1/client.js +9 -0
  248. package/prism/v1/client.ts +7 -0
  249. package/prism/v1/prism_pb.js +250 -0
  250. package/prism/v1/prism_pb.ts +1396 -0
  251. package/protoc-gen-openapiv2/options/annotations_pb.js +58 -0
  252. package/protoc-gen-openapiv2/options/annotations_pb.ts +72 -0
  253. package/protoc-gen-openapiv2/options/openapiv2_pb.js +253 -0
  254. package/protoc-gen-openapiv2/options/openapiv2_pb.ts +1313 -0
  255. package/protos/entity_pb.js +17 -0
  256. package/protos/entity_pb.ts +49 -0
  257. package/protos/message_pb.js +16 -0
  258. package/protos/message_pb.ts +40 -0
  259. package/protos/operation_pb.js +33 -0
  260. package/protos/operation_pb.ts +198 -0
  261. package/tsconfig.json +12 -0
  262. package/vortex/v1/client.js +9 -0
  263. package/vortex/v1/client.ts +7 -0
  264. package/vortex/v1/vortex_pb.js +65 -0
  265. package/vortex/v1/vortex_pb.ts +280 -0
@@ -0,0 +1,1313 @@
1
+ // @generated by protoc-gen-es v2.7.0 with parameter "target=ts"
2
+ // @generated from file protoc-gen-openapiv2/options/openapiv2.proto (package grpc.gateway.protoc_gen_openapiv2.options, syntax proto3)
3
+ /* eslint-disable */
4
+
5
+ import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
6
+ import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
7
+ import type { Value } from "@bufbuild/protobuf/wkt";
8
+ import { file_google_protobuf_struct } from "@bufbuild/protobuf/wkt";
9
+ import type { Message } from "@bufbuild/protobuf";
10
+
11
+ /**
12
+ * Describes the file protoc-gen-openapiv2/options/openapiv2.proto.
13
+ */
14
+ export const file_protoc_gen_openapiv2_options_openapiv2: GenFile = /*@__PURE__*/
15
+ fileDesc("Cixwcm90b2MtZ2VuLW9wZW5hcGl2Mi9vcHRpb25zL29wZW5hcGl2Mi5wcm90bxIpZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMi3QYKB1N3YWdnZXISDwoHc3dhZ2dlchgBIAEoCRI9CgRpbmZvGAIgASgLMi8uZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuSW5mbxIMCgRob3N0GAMgASgJEhEKCWJhc2VfcGF0aBgEIAEoCRJCCgdzY2hlbWVzGAUgAygOMjEuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2NoZW1lEhAKCGNvbnN1bWVzGAYgAygJEhAKCHByb2R1Y2VzGAcgAygJElQKCXJlc3BvbnNlcxgKIAMoCzJBLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlN3YWdnZXIuUmVzcG9uc2VzRW50cnkSXAoUc2VjdXJpdHlfZGVmaW5pdGlvbnMYCyABKAsyPi5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TZWN1cml0eURlZmluaXRpb25zElAKCHNlY3VyaXR5GAwgAygLMj4uZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2VjdXJpdHlSZXF1aXJlbWVudBJXCg1leHRlcm5hbF9kb2NzGA4gASgLMkAuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuRXh0ZXJuYWxEb2N1bWVudGF0aW9uElYKCmV4dGVuc2lvbnMYDyADKAsyQi5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5Td2FnZ2VyLkV4dGVuc2lvbnNFbnRyeRplCg5SZXNwb25zZXNFbnRyeRILCgNrZXkYASABKAkSQgoFdmFsdWUYAiABKAsyMy5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5SZXNwb25zZToCOAEaSQoPRXh0ZW5zaW9uc0VudHJ5EgsKA2tleRgBIAEoCRIlCgV2YWx1ZRgCIAEoCzIWLmdvb2dsZS5wcm90b2J1Zi5WYWx1ZToCOAFKBAgIEAlKBAgJEApKBAgNEA4i5gUKCU9wZXJhdGlvbhIMCgR0YWdzGAEgAygJEg8KB3N1bW1hcnkYAiABKAkSEwoLZGVzY3JpcHRpb24YAyABKAkSVwoNZXh0ZXJuYWxfZG9jcxgEIAEoCzJALmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLkV4dGVybmFsRG9jdW1lbnRhdGlvbhIUCgxvcGVyYXRpb25faWQYBSABKAkSEAoIY29uc3VtZXMYBiADKAkSEAoIcHJvZHVjZXMYByADKAkSVgoJcmVzcG9uc2VzGAkgAygLMkMuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuT3BlcmF0aW9uLlJlc3BvbnNlc0VudHJ5EkIKB3NjaGVtZXMYCiADKA4yMS5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TY2hlbWUSEgoKZGVwcmVjYXRlZBgLIAEoCBJQCghzZWN1cml0eRgMIAMoCzI+LmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlNlY3VyaXR5UmVxdWlyZW1lbnQSWAoKZXh0ZW5zaW9ucxgNIAMoCzJELmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLk9wZXJhdGlvbi5FeHRlbnNpb25zRW50cnkaZQoOUmVzcG9uc2VzRW50cnkSCwoDa2V5GAEgASgJEkIKBXZhbHVlGAIgASgLMjMuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuUmVzcG9uc2U6AjgBGkkKD0V4dGVuc2lvbnNFbnRyeRILCgNrZXkYASABKAkSJQoFdmFsdWUYAiABKAsyFi5nb29nbGUucHJvdG9idWYuVmFsdWU6AjgBSgQICBAJIqsBCgZIZWFkZXISEwoLZGVzY3JpcHRpb24YASABKAkSDAoEdHlwZRgCIAEoCRIOCgZmb3JtYXQYAyABKAkSDwoHZGVmYXVsdBgGIAEoCRIPCgdwYXR0ZXJuGA0gASgJSgQIBBAFSgQIBRAGSgQIBxAISgQICBAJSgQICRAKSgQIChALSgQICxAMSgQIDBANSgQIDhAPSgQIDxAQSgQIEBARSgQIERASSgQIEhATIsIECghSZXNwb25zZRITCgtkZXNjcmlwdGlvbhgBIAEoCRJBCgZzY2hlbWEYAiABKAsyMS5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TY2hlbWESUQoHaGVhZGVycxgDIAMoCzJALmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlJlc3BvbnNlLkhlYWRlcnNFbnRyeRJTCghleGFtcGxlcxgEIAMoCzJBLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlJlc3BvbnNlLkV4YW1wbGVzRW50cnkSVwoKZXh0ZW5zaW9ucxgFIAMoCzJDLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlJlc3BvbnNlLkV4dGVuc2lvbnNFbnRyeRphCgxIZWFkZXJzRW50cnkSCwoDa2V5GAEgASgJEkAKBXZhbHVlGAIgASgLMjEuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuSGVhZGVyOgI4ARovCg1FeGFtcGxlc0VudHJ5EgsKA2tleRgBIAEoCRINCgV2YWx1ZRgCIAEoCToCOAEaSQoPRXh0ZW5zaW9uc0VudHJ5EgsKA2tleRgBIAEoCRIlCgV2YWx1ZRgCIAEoCzIWLmdvb2dsZS5wcm90b2J1Zi5WYWx1ZToCOAEi/wIKBEluZm8SDQoFdGl0bGUYASABKAkSEwoLZGVzY3JpcHRpb24YAiABKAkSGAoQdGVybXNfb2Zfc2VydmljZRgDIAEoCRJDCgdjb250YWN0GAQgASgLMjIuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuQ29udGFjdBJDCgdsaWNlbnNlGAUgASgLMjIuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuTGljZW5zZRIPCgd2ZXJzaW9uGAYgASgJElMKCmV4dGVuc2lvbnMYByADKAsyPy5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5JbmZvLkV4dGVuc2lvbnNFbnRyeRpJCg9FeHRlbnNpb25zRW50cnkSCwoDa2V5GAEgASgJEiUKBXZhbHVlGAIgASgLMhYuZ29vZ2xlLnByb3RvYnVmLlZhbHVlOgI4ASIzCgdDb250YWN0EgwKBG5hbWUYASABKAkSCwoDdXJsGAIgASgJEg0KBWVtYWlsGAMgASgJIiQKB0xpY2Vuc2USDAoEbmFtZRgBIAEoCRILCgN1cmwYAiABKAkiOQoVRXh0ZXJuYWxEb2N1bWVudGF0aW9uEhMKC2Rlc2NyaXB0aW9uGAEgASgJEgsKA3VybBgCIAEoCSLuAQoGU2NoZW1hEkoKC2pzb25fc2NoZW1hGAEgASgLMjUuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuSlNPTlNjaGVtYRIVCg1kaXNjcmltaW5hdG9yGAIgASgJEhEKCXJlYWRfb25seRgDIAEoCBJXCg1leHRlcm5hbF9kb2NzGAUgASgLMkAuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuRXh0ZXJuYWxEb2N1bWVudGF0aW9uEg8KB2V4YW1wbGUYBiABKAlKBAgEEAUi5QUKCkpTT05TY2hlbWESCwoDcmVmGAMgASgJEg0KBXRpdGxlGAUgASgJEhMKC2Rlc2NyaXB0aW9uGAYgASgJEg8KB2RlZmF1bHQYByABKAkSEQoJcmVhZF9vbmx5GAggASgIEg8KB2V4YW1wbGUYCSABKAkSEwoLbXVsdGlwbGVfb2YYCiABKAESDwoHbWF4aW11bRgLIAEoARIZChFleGNsdXNpdmVfbWF4aW11bRgMIAEoCBIPCgdtaW5pbXVtGA0gASgBEhkKEWV4Y2x1c2l2ZV9taW5pbXVtGA4gASgIEhIKCm1heF9sZW5ndGgYDyABKAQSEgoKbWluX2xlbmd0aBgQIAEoBBIPCgdwYXR0ZXJuGBEgASgJEhEKCW1heF9pdGVtcxgUIAEoBBIRCgltaW5faXRlbXMYFSABKAQSFAoMdW5pcXVlX2l0ZW1zGBYgASgIEhYKDm1heF9wcm9wZXJ0aWVzGBggASgEEhYKDm1pbl9wcm9wZXJ0aWVzGBkgASgEEhAKCHJlcXVpcmVkGBogAygJEg0KBWFycmF5GCIgAygJElkKBHR5cGUYIyADKA4ySy5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5KU09OU2NoZW1hLkpTT05TY2hlbWFTaW1wbGVUeXBlcxIOCgZmb3JtYXQYJCABKAkSDAoEZW51bRguIAMoCSJ3ChVKU09OU2NoZW1hU2ltcGxlVHlwZXMSCwoHVU5LTk9XThAAEgkKBUFSUkFZEAESCwoHQk9PTEVBThACEgsKB0lOVEVHRVIQAxIICgROVUxMEAQSCgoGTlVNQkVSEAUSCgoGT0JKRUNUEAYSCgoGU1RSSU5HEAdKBAgBEAJKBAgCEANKBAgEEAVKBAgSEBNKBAgTEBRKBAgXEBhKBAgbEBxKBAgcEB1KBAgdEB5KBAgeECJKBAglECpKBAgqECtKBAgrEC4ieQoDVGFnEhMKC2Rlc2NyaXB0aW9uGAIgASgJElcKDWV4dGVybmFsX2RvY3MYAyABKAsyQC5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5FeHRlcm5hbERvY3VtZW50YXRpb25KBAgBEAIi4QEKE1NlY3VyaXR5RGVmaW5pdGlvbnMSXgoIc2VjdXJpdHkYASADKAsyTC5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TZWN1cml0eURlZmluaXRpb25zLlNlY3VyaXR5RW50cnkaagoNU2VjdXJpdHlFbnRyeRILCgNrZXkYASABKAkSSAoFdmFsdWUYAiABKAsyOS5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TZWN1cml0eVNjaGVtZToCOAEioAYKDlNlY3VyaXR5U2NoZW1lEkwKBHR5cGUYASABKA4yPi5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TZWN1cml0eVNjaGVtZS5UeXBlEhMKC2Rlc2NyaXB0aW9uGAIgASgJEgwKBG5hbWUYAyABKAkSSAoCaW4YBCABKA4yPC5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TZWN1cml0eVNjaGVtZS5JbhJMCgRmbG93GAUgASgOMj4uZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2VjdXJpdHlTY2hlbWUuRmxvdxIZChFhdXRob3JpemF0aW9uX3VybBgGIAEoCRIRCgl0b2tlbl91cmwYByABKAkSQQoGc2NvcGVzGAggASgLMjEuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2NvcGVzEl0KCmV4dGVuc2lvbnMYCSADKAsySS5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TZWN1cml0eVNjaGVtZS5FeHRlbnNpb25zRW50cnkaSQoPRXh0ZW5zaW9uc0VudHJ5EgsKA2tleRgBIAEoCRIlCgV2YWx1ZRgCIAEoCzIWLmdvb2dsZS5wcm90b2J1Zi5WYWx1ZToCOAEiSwoEVHlwZRIQCgxUWVBFX0lOVkFMSUQQABIOCgpUWVBFX0JBU0lDEAESEAoMVFlQRV9BUElfS0VZEAISDwoLVFlQRV9PQVVUSDIQAyIxCgJJbhIOCgpJTl9JTlZBTElEEAASDAoISU5fUVVFUlkQARINCglJTl9IRUFERVIQAiJqCgRGbG93EhAKDEZMT1dfSU5WQUxJRBAAEhEKDUZMT1dfSU1QTElDSVQQARIRCg1GTE9XX1BBU1NXT1JEEAISFAoQRkxPV19BUFBMSUNBVElPThADEhQKEEZMT1dfQUNDRVNTX0NPREUQBCLNAgoTU2VjdXJpdHlSZXF1aXJlbWVudBJ1ChRzZWN1cml0eV9yZXF1aXJlbWVudBgBIAMoCzJXLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlNlY3VyaXR5UmVxdWlyZW1lbnQuU2VjdXJpdHlSZXF1aXJlbWVudEVudHJ5GikKGFNlY3VyaXR5UmVxdWlyZW1lbnRWYWx1ZRINCgVzY29wZRgBIAMoCRqTAQoYU2VjdXJpdHlSZXF1aXJlbWVudEVudHJ5EgsKA2tleRgBIAEoCRJmCgV2YWx1ZRgCIAEoCzJXLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlNlY3VyaXR5UmVxdWlyZW1lbnQuU2VjdXJpdHlSZXF1aXJlbWVudFZhbHVlOgI4ASKDAQoGU2NvcGVzEksKBXNjb3BlGAEgAygLMjwuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2NvcGVzLlNjb3BlRW50cnkaLAoKU2NvcGVFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBKjsKBlNjaGVtZRILCgdVTktOT1dOEAASCAoESFRUUBABEgkKBUhUVFBTEAISBgoCV1MQAxIHCgNXU1MQBEJIWkZnaXRodWIuY29tL2dycGMtZWNvc3lzdGVtL2dycGMtZ2F0ZXdheS92Mi9wcm90b2MtZ2VuLW9wZW5hcGl2Mi9vcHRpb25zYgZwcm90bzM", [file_google_protobuf_struct]);
16
+
17
+ /**
18
+ * `Swagger` is a representation of OpenAPI v2 specification's Swagger object.
19
+ *
20
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject
21
+ *
22
+ * Example:
23
+ *
24
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
25
+ * info: {
26
+ * title: "Echo API";
27
+ * version: "1.0";
28
+ * description: ";
29
+ * contact: {
30
+ * name: "gRPC-Gateway project";
31
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway";
32
+ * email: "none@example.com";
33
+ * };
34
+ * license: {
35
+ * name: "BSD 3-Clause License";
36
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
37
+ * };
38
+ * };
39
+ * schemes: HTTPS;
40
+ * consumes: "application/json";
41
+ * produces: "application/json";
42
+ * };
43
+ *
44
+ *
45
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Swagger
46
+ */
47
+ export type Swagger = Message<"grpc.gateway.protoc_gen_openapiv2.options.Swagger"> & {
48
+ /**
49
+ * Specifies the OpenAPI Specification version being used. It can be
50
+ * used by the OpenAPI UI and other clients to interpret the API listing. The
51
+ * value MUST be "2.0".
52
+ *
53
+ * @generated from field: string swagger = 1;
54
+ */
55
+ swagger: string;
56
+
57
+ /**
58
+ * Provides metadata about the API. The metadata can be used by the
59
+ * clients if needed.
60
+ *
61
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
62
+ */
63
+ info?: Info;
64
+
65
+ /**
66
+ * The host (name or ip) serving the API. This MUST be the host only and does
67
+ * not include the scheme nor sub-paths. It MAY include a port. If the host is
68
+ * not included, the host serving the documentation is to be used (including
69
+ * the port). The host does not support path templating.
70
+ *
71
+ * @generated from field: string host = 3;
72
+ */
73
+ host: string;
74
+
75
+ /**
76
+ * The base path on which the API is served, which is relative to the host. If
77
+ * it is not included, the API is served directly under the host. The value
78
+ * MUST start with a leading slash (/). The basePath does not support path
79
+ * templating.
80
+ * Note that using `base_path` does not change the endpoint paths that are
81
+ * generated in the resulting OpenAPI file. If you wish to use `base_path`
82
+ * with relatively generated OpenAPI paths, the `base_path` prefix must be
83
+ * manually removed from your `google.api.http` paths and your code changed to
84
+ * serve the API from the `base_path`.
85
+ *
86
+ * @generated from field: string base_path = 4;
87
+ */
88
+ basePath: string;
89
+
90
+ /**
91
+ * The transfer protocol of the API. Values MUST be from the list: "http",
92
+ * "https", "ws", "wss". If the schemes is not included, the default scheme to
93
+ * be used is the one used to access the OpenAPI definition itself.
94
+ *
95
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
96
+ */
97
+ schemes: Scheme[];
98
+
99
+ /**
100
+ * A list of MIME types the APIs can consume. This is global to all APIs but
101
+ * can be overridden on specific API calls. Value MUST be as described under
102
+ * Mime Types.
103
+ *
104
+ * @generated from field: repeated string consumes = 6;
105
+ */
106
+ consumes: string[];
107
+
108
+ /**
109
+ * A list of MIME types the APIs can produce. This is global to all APIs but
110
+ * can be overridden on specific API calls. Value MUST be as described under
111
+ * Mime Types.
112
+ *
113
+ * @generated from field: repeated string produces = 7;
114
+ */
115
+ produces: string[];
116
+
117
+ /**
118
+ * An object to hold responses that can be used across operations. This
119
+ * property does not define global responses for all operations.
120
+ *
121
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
122
+ */
123
+ responses: { [key: string]: Response };
124
+
125
+ /**
126
+ * Security scheme definitions that can be used across the specification.
127
+ *
128
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
129
+ */
130
+ securityDefinitions?: SecurityDefinitions;
131
+
132
+ /**
133
+ * A declaration of which security schemes are applied for the API as a whole.
134
+ * The list of values describes alternative security schemes that can be used
135
+ * (that is, there is a logical OR between the security requirements).
136
+ * Individual operations can override this definition.
137
+ *
138
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
139
+ */
140
+ security: SecurityRequirement[];
141
+
142
+ /**
143
+ * Additional external documentation.
144
+ *
145
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
146
+ */
147
+ externalDocs?: ExternalDocumentation;
148
+
149
+ /**
150
+ * @generated from field: map<string, google.protobuf.Value> extensions = 15;
151
+ */
152
+ extensions: { [key: string]: Value };
153
+ };
154
+
155
+ /**
156
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Swagger.
157
+ * Use `create(SwaggerSchema)` to create a new message.
158
+ */
159
+ export const SwaggerSchema: GenMessage<Swagger> = /*@__PURE__*/
160
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 0);
161
+
162
+ /**
163
+ * `Operation` is a representation of OpenAPI v2 specification's Operation object.
164
+ *
165
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject
166
+ *
167
+ * Example:
168
+ *
169
+ * service EchoService {
170
+ * rpc Echo(SimpleMessage) returns (SimpleMessage) {
171
+ * option (google.api.http) = {
172
+ * get: "/v1/example/echo/{id}"
173
+ * };
174
+ *
175
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
176
+ * summary: "Get a message.";
177
+ * operation_id: "getMessage";
178
+ * tags: "echo";
179
+ * responses: {
180
+ * key: "200"
181
+ * value: {
182
+ * description: "OK";
183
+ * }
184
+ * }
185
+ * };
186
+ * }
187
+ * }
188
+ *
189
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Operation
190
+ */
191
+ export type Operation = Message<"grpc.gateway.protoc_gen_openapiv2.options.Operation"> & {
192
+ /**
193
+ * A list of tags for API documentation control. Tags can be used for logical
194
+ * grouping of operations by resources or any other qualifier.
195
+ *
196
+ * @generated from field: repeated string tags = 1;
197
+ */
198
+ tags: string[];
199
+
200
+ /**
201
+ * A short summary of what the operation does. For maximum readability in the
202
+ * swagger-ui, this field SHOULD be less than 120 characters.
203
+ *
204
+ * @generated from field: string summary = 2;
205
+ */
206
+ summary: string;
207
+
208
+ /**
209
+ * A verbose explanation of the operation behavior. GFM syntax can be used for
210
+ * rich text representation.
211
+ *
212
+ * @generated from field: string description = 3;
213
+ */
214
+ description: string;
215
+
216
+ /**
217
+ * Additional external documentation for this operation.
218
+ *
219
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4;
220
+ */
221
+ externalDocs?: ExternalDocumentation;
222
+
223
+ /**
224
+ * Unique string used to identify the operation. The id MUST be unique among
225
+ * all operations described in the API. Tools and libraries MAY use the
226
+ * operationId to uniquely identify an operation, therefore, it is recommended
227
+ * to follow common programming naming conventions.
228
+ *
229
+ * @generated from field: string operation_id = 5;
230
+ */
231
+ operationId: string;
232
+
233
+ /**
234
+ * A list of MIME types the operation can consume. This overrides the consumes
235
+ * definition at the OpenAPI Object. An empty value MAY be used to clear the
236
+ * global definition. Value MUST be as described under Mime Types.
237
+ *
238
+ * @generated from field: repeated string consumes = 6;
239
+ */
240
+ consumes: string[];
241
+
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
+ *
247
+ * @generated from field: repeated string produces = 7;
248
+ */
249
+ produces: string[];
250
+
251
+ /**
252
+ * The list of possible responses as they are returned from executing this
253
+ * operation.
254
+ *
255
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 9;
256
+ */
257
+ responses: { [key: string]: Response };
258
+
259
+ /**
260
+ * The transfer protocol for the operation. Values MUST be from the list:
261
+ * "http", "https", "ws", "wss". The value overrides the OpenAPI Object
262
+ * schemes definition.
263
+ *
264
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10;
265
+ */
266
+ schemes: Scheme[];
267
+
268
+ /**
269
+ * Declares this operation to be deprecated. Usage of the declared operation
270
+ * should be refrained. Default value is false.
271
+ *
272
+ * @generated from field: bool deprecated = 11;
273
+ */
274
+ deprecated: boolean;
275
+
276
+ /**
277
+ * A declaration of which security schemes are applied for this operation. The
278
+ * list of values describes alternative security schemes that can be used
279
+ * (that is, there is a logical OR between the security requirements). This
280
+ * definition overrides any declared top-level security. To remove a top-level
281
+ * security declaration, an empty array can be used.
282
+ *
283
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
284
+ */
285
+ security: SecurityRequirement[];
286
+
287
+ /**
288
+ * @generated from field: map<string, google.protobuf.Value> extensions = 13;
289
+ */
290
+ extensions: { [key: string]: Value };
291
+ };
292
+
293
+ /**
294
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Operation.
295
+ * Use `create(OperationSchema)` to create a new message.
296
+ */
297
+ export const OperationSchema: GenMessage<Operation> = /*@__PURE__*/
298
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 1);
299
+
300
+ /**
301
+ * `Header` is a representation of OpenAPI v2 specification's Header object.
302
+ *
303
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject
304
+ *
305
+ *
306
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Header
307
+ */
308
+ export type Header = Message<"grpc.gateway.protoc_gen_openapiv2.options.Header"> & {
309
+ /**
310
+ * `Description` is a short description of the header.
311
+ *
312
+ * @generated from field: string description = 1;
313
+ */
314
+ description: string;
315
+
316
+ /**
317
+ * The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported.
318
+ *
319
+ * @generated from field: string type = 2;
320
+ */
321
+ type: string;
322
+
323
+ /**
324
+ * `Format` The extending format for the previously mentioned type.
325
+ *
326
+ * @generated from field: string format = 3;
327
+ */
328
+ format: string;
329
+
330
+ /**
331
+ * `Default` Declares the value of the header that the server will use if none is provided.
332
+ * See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2.
333
+ * Unlike JSON Schema this value MUST conform to the defined type for the header.
334
+ *
335
+ * @generated from field: string default = 6;
336
+ */
337
+ default: string;
338
+
339
+ /**
340
+ * 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
341
+ *
342
+ * @generated from field: string pattern = 13;
343
+ */
344
+ pattern: string;
345
+ };
346
+
347
+ /**
348
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Header.
349
+ * Use `create(HeaderSchema)` to create a new message.
350
+ */
351
+ export const HeaderSchema: GenMessage<Header> = /*@__PURE__*/
352
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 2);
353
+
354
+ /**
355
+ * `Response` is a representation of OpenAPI v2 specification's Response object.
356
+ *
357
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject
358
+ *
359
+ *
360
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Response
361
+ */
362
+ export type Response = Message<"grpc.gateway.protoc_gen_openapiv2.options.Response"> & {
363
+ /**
364
+ * `Description` is a short description of the response.
365
+ * GFM syntax can be used for rich text representation.
366
+ *
367
+ * @generated from field: string description = 1;
368
+ */
369
+ description: string;
370
+
371
+ /**
372
+ * `Schema` optionally defines the structure of the response.
373
+ * If `Schema` is not provided, it means there is no content to the response.
374
+ *
375
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
376
+ */
377
+ schema?: Schema;
378
+
379
+ /**
380
+ * `Headers` A list of headers that are sent with the response.
381
+ * `Header` name is expected to be a string in the canonical format of the MIME header key
382
+ * See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
383
+ *
384
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
385
+ */
386
+ headers: { [key: string]: Header };
387
+
388
+ /**
389
+ * `Examples` gives per-mimetype response examples.
390
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
391
+ *
392
+ * @generated from field: map<string, string> examples = 4;
393
+ */
394
+ examples: { [key: string]: string };
395
+
396
+ /**
397
+ * @generated from field: map<string, google.protobuf.Value> extensions = 5;
398
+ */
399
+ extensions: { [key: string]: Value };
400
+ };
401
+
402
+ /**
403
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Response.
404
+ * Use `create(ResponseSchema)` to create a new message.
405
+ */
406
+ export const ResponseSchema: GenMessage<Response> = /*@__PURE__*/
407
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 3);
408
+
409
+ /**
410
+ * `Info` is a representation of OpenAPI v2 specification's Info object.
411
+ *
412
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject
413
+ *
414
+ * Example:
415
+ *
416
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
417
+ * info: {
418
+ * title: "Echo API";
419
+ * version: "1.0";
420
+ * description: ";
421
+ * contact: {
422
+ * name: "gRPC-Gateway project";
423
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway";
424
+ * email: "none@example.com";
425
+ * };
426
+ * license: {
427
+ * name: "BSD 3-Clause License";
428
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
429
+ * };
430
+ * };
431
+ * ...
432
+ * };
433
+ *
434
+ *
435
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Info
436
+ */
437
+ export type Info = Message<"grpc.gateway.protoc_gen_openapiv2.options.Info"> & {
438
+ /**
439
+ * The title of the application.
440
+ *
441
+ * @generated from field: string title = 1;
442
+ */
443
+ title: string;
444
+
445
+ /**
446
+ * A short description of the application. GFM syntax can be used for rich
447
+ * text representation.
448
+ *
449
+ * @generated from field: string description = 2;
450
+ */
451
+ description: string;
452
+
453
+ /**
454
+ * The Terms of Service for the API.
455
+ *
456
+ * @generated from field: string terms_of_service = 3;
457
+ */
458
+ termsOfService: string;
459
+
460
+ /**
461
+ * The contact information for the exposed API.
462
+ *
463
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;
464
+ */
465
+ contact?: Contact;
466
+
467
+ /**
468
+ * The license information for the exposed API.
469
+ *
470
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.License license = 5;
471
+ */
472
+ license?: License;
473
+
474
+ /**
475
+ * Provides the version of the application API (not to be confused
476
+ * with the specification version).
477
+ *
478
+ * @generated from field: string version = 6;
479
+ */
480
+ version: string;
481
+
482
+ /**
483
+ * @generated from field: map<string, google.protobuf.Value> extensions = 7;
484
+ */
485
+ extensions: { [key: string]: Value };
486
+ };
487
+
488
+ /**
489
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Info.
490
+ * Use `create(InfoSchema)` to create a new message.
491
+ */
492
+ export const InfoSchema: GenMessage<Info> = /*@__PURE__*/
493
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 4);
494
+
495
+ /**
496
+ * `Contact` is a representation of OpenAPI v2 specification's Contact object.
497
+ *
498
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#contactObject
499
+ *
500
+ * Example:
501
+ *
502
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
503
+ * info: {
504
+ * ...
505
+ * contact: {
506
+ * name: "gRPC-Gateway project";
507
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway";
508
+ * email: "none@example.com";
509
+ * };
510
+ * ...
511
+ * };
512
+ * ...
513
+ * };
514
+ *
515
+ *
516
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Contact
517
+ */
518
+ export type Contact = Message<"grpc.gateway.protoc_gen_openapiv2.options.Contact"> & {
519
+ /**
520
+ * The identifying name of the contact person/organization.
521
+ *
522
+ * @generated from field: string name = 1;
523
+ */
524
+ name: string;
525
+
526
+ /**
527
+ * The URL pointing to the contact information. MUST be in the format of a
528
+ * URL.
529
+ *
530
+ * @generated from field: string url = 2;
531
+ */
532
+ url: string;
533
+
534
+ /**
535
+ * The email address of the contact person/organization. MUST be in the format
536
+ * of an email address.
537
+ *
538
+ * @generated from field: string email = 3;
539
+ */
540
+ email: string;
541
+ };
542
+
543
+ /**
544
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Contact.
545
+ * Use `create(ContactSchema)` to create a new message.
546
+ */
547
+ export const ContactSchema: GenMessage<Contact> = /*@__PURE__*/
548
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 5);
549
+
550
+ /**
551
+ * `License` is a representation of OpenAPI v2 specification's License object.
552
+ *
553
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#licenseObject
554
+ *
555
+ * Example:
556
+ *
557
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
558
+ * info: {
559
+ * ...
560
+ * license: {
561
+ * name: "BSD 3-Clause License";
562
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
563
+ * };
564
+ * ...
565
+ * };
566
+ * ...
567
+ * };
568
+ *
569
+ *
570
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.License
571
+ */
572
+ export type License = Message<"grpc.gateway.protoc_gen_openapiv2.options.License"> & {
573
+ /**
574
+ * The license name used for the API.
575
+ *
576
+ * @generated from field: string name = 1;
577
+ */
578
+ name: string;
579
+
580
+ /**
581
+ * A URL to the license used for the API. MUST be in the format of a URL.
582
+ *
583
+ * @generated from field: string url = 2;
584
+ */
585
+ url: string;
586
+ };
587
+
588
+ /**
589
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.License.
590
+ * Use `create(LicenseSchema)` to create a new message.
591
+ */
592
+ export const LicenseSchema: GenMessage<License> = /*@__PURE__*/
593
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 6);
594
+
595
+ /**
596
+ * `ExternalDocumentation` is a representation of OpenAPI v2 specification's
597
+ * ExternalDocumentation object.
598
+ *
599
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject
600
+ *
601
+ * Example:
602
+ *
603
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
604
+ * ...
605
+ * external_docs: {
606
+ * description: "More about gRPC-Gateway";
607
+ * url: "https://github.com/grpc-ecosystem/grpc-gateway";
608
+ * }
609
+ * ...
610
+ * };
611
+ *
612
+ *
613
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation
614
+ */
615
+ export type ExternalDocumentation = Message<"grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation"> & {
616
+ /**
617
+ * A short description of the target documentation. GFM syntax can be used for
618
+ * rich text representation.
619
+ *
620
+ * @generated from field: string description = 1;
621
+ */
622
+ description: string;
623
+
624
+ /**
625
+ * The URL for the target documentation. Value MUST be in the format
626
+ * of a URL.
627
+ *
628
+ * @generated from field: string url = 2;
629
+ */
630
+ url: string;
631
+ };
632
+
633
+ /**
634
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation.
635
+ * Use `create(ExternalDocumentationSchema)` to create a new message.
636
+ */
637
+ export const ExternalDocumentationSchema: GenMessage<ExternalDocumentation> = /*@__PURE__*/
638
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 7);
639
+
640
+ /**
641
+ * `Schema` is a representation of OpenAPI v2 specification's Schema object.
642
+ *
643
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
644
+ *
645
+ *
646
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Schema
647
+ */
648
+ export type Schema = Message<"grpc.gateway.protoc_gen_openapiv2.options.Schema"> & {
649
+ /**
650
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;
651
+ */
652
+ jsonSchema?: JSONSchema;
653
+
654
+ /**
655
+ * Adds support for polymorphism. The discriminator is the schema property
656
+ * name that is used to differentiate between other schema that inherit this
657
+ * schema. The property name used MUST be defined at this schema and it MUST
658
+ * be in the required property list. When used, the value MUST be the name of
659
+ * this schema or any schema that inherits it.
660
+ *
661
+ * @generated from field: string discriminator = 2;
662
+ */
663
+ discriminator: string;
664
+
665
+ /**
666
+ * Relevant only for Schema "properties" definitions. Declares the property as
667
+ * "read only". This means that it MAY be sent as part of a response but MUST
668
+ * NOT be sent as part of the request. Properties marked as readOnly being
669
+ * true SHOULD NOT be in the required list of the defined schema. Default
670
+ * value is false.
671
+ *
672
+ * @generated from field: bool read_only = 3;
673
+ */
674
+ readOnly: boolean;
675
+
676
+ /**
677
+ * Additional external documentation for this schema.
678
+ *
679
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5;
680
+ */
681
+ externalDocs?: ExternalDocumentation;
682
+
683
+ /**
684
+ * A free-form property to include an example of an instance for this schema in JSON.
685
+ * This is copied verbatim to the output.
686
+ *
687
+ * @generated from field: string example = 6;
688
+ */
689
+ example: string;
690
+ };
691
+
692
+ /**
693
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Schema.
694
+ * Use `create(SchemaSchema)` to create a new message.
695
+ */
696
+ export const SchemaSchema: GenMessage<Schema> = /*@__PURE__*/
697
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 8);
698
+
699
+ /**
700
+ * `JSONSchema` represents properties from JSON Schema taken, and as used, in
701
+ * the OpenAPI v2 spec.
702
+ *
703
+ * This includes changes made by OpenAPI v2.
704
+ *
705
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
706
+ *
707
+ * See also: https://cswr.github.io/JsonSchema/spec/basic_types/,
708
+ * https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json
709
+ *
710
+ * Example:
711
+ *
712
+ * message SimpleMessage {
713
+ * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = {
714
+ * json_schema: {
715
+ * title: "SimpleMessage"
716
+ * description: "A simple message."
717
+ * required: ["id"]
718
+ * }
719
+ * };
720
+ *
721
+ * // Id represents the message identifier.
722
+ * string id = 1; [
723
+ * (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
724
+ * {description: "The unique identifier of the simple message."
725
+ * }];
726
+ * }
727
+ *
728
+ *
729
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema
730
+ */
731
+ export type JSONSchema = Message<"grpc.gateway.protoc_gen_openapiv2.options.JSONSchema"> & {
732
+ /**
733
+ * Ref is used to define an external reference to include in the message.
734
+ * This could be a fully qualified proto message reference, and that type must
735
+ * be imported into the protofile. If no message is identified, the Ref will
736
+ * be used verbatim in the output.
737
+ * For example:
738
+ * `ref: ".google.protobuf.Timestamp"`.
739
+ *
740
+ * @generated from field: string ref = 3;
741
+ */
742
+ ref: string;
743
+
744
+ /**
745
+ * The title of the schema.
746
+ *
747
+ * @generated from field: string title = 5;
748
+ */
749
+ title: string;
750
+
751
+ /**
752
+ * A short description of the schema.
753
+ *
754
+ * @generated from field: string description = 6;
755
+ */
756
+ description: string;
757
+
758
+ /**
759
+ * @generated from field: string default = 7;
760
+ */
761
+ default: string;
762
+
763
+ /**
764
+ * @generated from field: bool read_only = 8;
765
+ */
766
+ readOnly: boolean;
767
+
768
+ /**
769
+ * A free-form property to include a JSON example of this field. This is copied
770
+ * verbatim to the output swagger.json. Quotes must be escaped.
771
+ * 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
772
+ *
773
+ * @generated from field: string example = 9;
774
+ */
775
+ example: string;
776
+
777
+ /**
778
+ * @generated from field: double multiple_of = 10;
779
+ */
780
+ multipleOf: number;
781
+
782
+ /**
783
+ * Maximum represents an inclusive upper limit for a numeric instance. The
784
+ * value of MUST be a number,
785
+ *
786
+ * @generated from field: double maximum = 11;
787
+ */
788
+ maximum: number;
789
+
790
+ /**
791
+ * @generated from field: bool exclusive_maximum = 12;
792
+ */
793
+ exclusiveMaximum: boolean;
794
+
795
+ /**
796
+ * minimum represents an inclusive lower limit for a numeric instance. The
797
+ * value of MUST be a number,
798
+ *
799
+ * @generated from field: double minimum = 13;
800
+ */
801
+ minimum: number;
802
+
803
+ /**
804
+ * @generated from field: bool exclusive_minimum = 14;
805
+ */
806
+ exclusiveMinimum: boolean;
807
+
808
+ /**
809
+ * @generated from field: uint64 max_length = 15;
810
+ */
811
+ maxLength: bigint;
812
+
813
+ /**
814
+ * @generated from field: uint64 min_length = 16;
815
+ */
816
+ minLength: bigint;
817
+
818
+ /**
819
+ * @generated from field: string pattern = 17;
820
+ */
821
+ pattern: string;
822
+
823
+ /**
824
+ * @generated from field: uint64 max_items = 20;
825
+ */
826
+ maxItems: bigint;
827
+
828
+ /**
829
+ * @generated from field: uint64 min_items = 21;
830
+ */
831
+ minItems: bigint;
832
+
833
+ /**
834
+ * @generated from field: bool unique_items = 22;
835
+ */
836
+ uniqueItems: boolean;
837
+
838
+ /**
839
+ * @generated from field: uint64 max_properties = 24;
840
+ */
841
+ maxProperties: bigint;
842
+
843
+ /**
844
+ * @generated from field: uint64 min_properties = 25;
845
+ */
846
+ minProperties: bigint;
847
+
848
+ /**
849
+ * @generated from field: repeated string required = 26;
850
+ */
851
+ required: string[];
852
+
853
+ /**
854
+ * Items in 'array' must be unique.
855
+ *
856
+ * @generated from field: repeated string array = 34;
857
+ */
858
+ array: string[];
859
+
860
+ /**
861
+ * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
862
+ */
863
+ type: JSONSchema_JSONSchemaSimpleTypes[];
864
+
865
+ /**
866
+ * `Format`
867
+ *
868
+ * @generated from field: string format = 36;
869
+ */
870
+ format: string;
871
+
872
+ /**
873
+ * Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
874
+ *
875
+ * @generated from field: repeated string enum = 46;
876
+ */
877
+ enum: string[];
878
+ };
879
+
880
+ /**
881
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.
882
+ * Use `create(JSONSchemaSchema)` to create a new message.
883
+ */
884
+ export const JSONSchemaSchema: GenMessage<JSONSchema> = /*@__PURE__*/
885
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 9);
886
+
887
+ /**
888
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes
889
+ */
890
+ export enum JSONSchema_JSONSchemaSimpleTypes {
891
+ /**
892
+ * @generated from enum value: UNKNOWN = 0;
893
+ */
894
+ UNKNOWN = 0,
895
+
896
+ /**
897
+ * @generated from enum value: ARRAY = 1;
898
+ */
899
+ ARRAY = 1,
900
+
901
+ /**
902
+ * @generated from enum value: BOOLEAN = 2;
903
+ */
904
+ BOOLEAN = 2,
905
+
906
+ /**
907
+ * @generated from enum value: INTEGER = 3;
908
+ */
909
+ INTEGER = 3,
910
+
911
+ /**
912
+ * @generated from enum value: NULL = 4;
913
+ */
914
+ NULL = 4,
915
+
916
+ /**
917
+ * @generated from enum value: NUMBER = 5;
918
+ */
919
+ NUMBER = 5,
920
+
921
+ /**
922
+ * @generated from enum value: OBJECT = 6;
923
+ */
924
+ OBJECT = 6,
925
+
926
+ /**
927
+ * @generated from enum value: STRING = 7;
928
+ */
929
+ STRING = 7,
930
+ }
931
+
932
+ /**
933
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes.
934
+ */
935
+ export const JSONSchema_JSONSchemaSimpleTypesSchema: GenEnum<JSONSchema_JSONSchemaSimpleTypes> = /*@__PURE__*/
936
+ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 9, 0);
937
+
938
+ /**
939
+ * `Tag` is a representation of OpenAPI v2 specification's Tag object.
940
+ *
941
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject
942
+ *
943
+ *
944
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Tag
945
+ */
946
+ export type Tag = Message<"grpc.gateway.protoc_gen_openapiv2.options.Tag"> & {
947
+ /**
948
+ * A short description for the tag. GFM syntax can be used for rich text
949
+ * representation.
950
+ *
951
+ * @generated from field: string description = 2;
952
+ */
953
+ description: string;
954
+
955
+ /**
956
+ * Additional external documentation for this tag.
957
+ *
958
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;
959
+ */
960
+ externalDocs?: ExternalDocumentation;
961
+ };
962
+
963
+ /**
964
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Tag.
965
+ * Use `create(TagSchema)` to create a new message.
966
+ */
967
+ export const TagSchema: GenMessage<Tag> = /*@__PURE__*/
968
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 10);
969
+
970
+ /**
971
+ * `SecurityDefinitions` is a representation of OpenAPI v2 specification's
972
+ * Security Definitions object.
973
+ *
974
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityDefinitionsObject
975
+ *
976
+ * A declaration of the security schemes available to be used in the
977
+ * specification. This does not enforce the security schemes on the operations
978
+ * and only serves to provide the relevant details for each scheme.
979
+ *
980
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions
981
+ */
982
+ export type SecurityDefinitions = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions"> & {
983
+ /**
984
+ * A single security scheme definition, mapping a "name" to the scheme it
985
+ * defines.
986
+ *
987
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme> security = 1;
988
+ */
989
+ security: { [key: string]: SecurityScheme };
990
+ };
991
+
992
+ /**
993
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions.
994
+ * Use `create(SecurityDefinitionsSchema)` to create a new message.
995
+ */
996
+ export const SecurityDefinitionsSchema: GenMessage<SecurityDefinitions> = /*@__PURE__*/
997
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 11);
998
+
999
+ /**
1000
+ * `SecurityScheme` is a representation of OpenAPI v2 specification's
1001
+ * Security Scheme object.
1002
+ *
1003
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject
1004
+ *
1005
+ * Allows the definition of a security scheme that can be used by the
1006
+ * operations. Supported schemes are basic authentication, an API key (either as
1007
+ * a header or as a query parameter) and OAuth2's common flows (implicit,
1008
+ * password, application and access code).
1009
+ *
1010
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme
1011
+ */
1012
+ export type SecurityScheme = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme"> & {
1013
+ /**
1014
+ * The type of the security scheme. Valid values are "basic",
1015
+ * "apiKey" or "oauth2".
1016
+ *
1017
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type type = 1;
1018
+ */
1019
+ type: SecurityScheme_Type;
1020
+
1021
+ /**
1022
+ * A short description for security scheme.
1023
+ *
1024
+ * @generated from field: string description = 2;
1025
+ */
1026
+ description: string;
1027
+
1028
+ /**
1029
+ * The name of the header or query parameter to be used.
1030
+ * Valid for apiKey.
1031
+ *
1032
+ * @generated from field: string name = 3;
1033
+ */
1034
+ name: string;
1035
+
1036
+ /**
1037
+ * The location of the API key. Valid values are "query" or
1038
+ * "header".
1039
+ * Valid for apiKey.
1040
+ *
1041
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In in = 4;
1042
+ */
1043
+ in: SecurityScheme_In;
1044
+
1045
+ /**
1046
+ * The flow used by the OAuth2 security scheme. Valid values are
1047
+ * "implicit", "password", "application" or "accessCode".
1048
+ * Valid for oauth2.
1049
+ *
1050
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow flow = 5;
1051
+ */
1052
+ flow: SecurityScheme_Flow;
1053
+
1054
+ /**
1055
+ * The authorization URL to be used for this flow. This SHOULD be in
1056
+ * the form of a URL.
1057
+ * Valid for oauth2/implicit and oauth2/accessCode.
1058
+ *
1059
+ * @generated from field: string authorization_url = 6;
1060
+ */
1061
+ authorizationUrl: string;
1062
+
1063
+ /**
1064
+ * The token URL to be used for this flow. This SHOULD be in the
1065
+ * form of a URL.
1066
+ * Valid for oauth2/password, oauth2/application and oauth2/accessCode.
1067
+ *
1068
+ * @generated from field: string token_url = 7;
1069
+ */
1070
+ tokenUrl: string;
1071
+
1072
+ /**
1073
+ * The available scopes for the OAuth2 security scheme.
1074
+ * Valid for oauth2.
1075
+ *
1076
+ * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;
1077
+ */
1078
+ scopes?: Scopes;
1079
+
1080
+ /**
1081
+ * @generated from field: map<string, google.protobuf.Value> extensions = 9;
1082
+ */
1083
+ extensions: { [key: string]: Value };
1084
+ };
1085
+
1086
+ /**
1087
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.
1088
+ * Use `create(SecuritySchemeSchema)` to create a new message.
1089
+ */
1090
+ export const SecuritySchemeSchema: GenMessage<SecurityScheme> = /*@__PURE__*/
1091
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 12);
1092
+
1093
+ /**
1094
+ * The type of the security scheme. Valid values are "basic",
1095
+ * "apiKey" or "oauth2".
1096
+ *
1097
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type
1098
+ */
1099
+ export enum SecurityScheme_Type {
1100
+ /**
1101
+ * @generated from enum value: TYPE_INVALID = 0;
1102
+ */
1103
+ INVALID = 0,
1104
+
1105
+ /**
1106
+ * @generated from enum value: TYPE_BASIC = 1;
1107
+ */
1108
+ BASIC = 1,
1109
+
1110
+ /**
1111
+ * @generated from enum value: TYPE_API_KEY = 2;
1112
+ */
1113
+ API_KEY = 2,
1114
+
1115
+ /**
1116
+ * @generated from enum value: TYPE_OAUTH2 = 3;
1117
+ */
1118
+ OAUTH2 = 3,
1119
+ }
1120
+
1121
+ /**
1122
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type.
1123
+ */
1124
+ export const SecurityScheme_TypeSchema: GenEnum<SecurityScheme_Type> = /*@__PURE__*/
1125
+ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 12, 0);
1126
+
1127
+ /**
1128
+ * The location of the API key. Valid values are "query" or "header".
1129
+ *
1130
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In
1131
+ */
1132
+ export enum SecurityScheme_In {
1133
+ /**
1134
+ * @generated from enum value: IN_INVALID = 0;
1135
+ */
1136
+ INVALID = 0,
1137
+
1138
+ /**
1139
+ * @generated from enum value: IN_QUERY = 1;
1140
+ */
1141
+ QUERY = 1,
1142
+
1143
+ /**
1144
+ * @generated from enum value: IN_HEADER = 2;
1145
+ */
1146
+ HEADER = 2,
1147
+ }
1148
+
1149
+ /**
1150
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In.
1151
+ */
1152
+ export const SecurityScheme_InSchema: GenEnum<SecurityScheme_In> = /*@__PURE__*/
1153
+ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 12, 1);
1154
+
1155
+ /**
1156
+ * The flow used by the OAuth2 security scheme. Valid values are
1157
+ * "implicit", "password", "application" or "accessCode".
1158
+ *
1159
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow
1160
+ */
1161
+ export enum SecurityScheme_Flow {
1162
+ /**
1163
+ * @generated from enum value: FLOW_INVALID = 0;
1164
+ */
1165
+ INVALID = 0,
1166
+
1167
+ /**
1168
+ * @generated from enum value: FLOW_IMPLICIT = 1;
1169
+ */
1170
+ IMPLICIT = 1,
1171
+
1172
+ /**
1173
+ * @generated from enum value: FLOW_PASSWORD = 2;
1174
+ */
1175
+ PASSWORD = 2,
1176
+
1177
+ /**
1178
+ * @generated from enum value: FLOW_APPLICATION = 3;
1179
+ */
1180
+ APPLICATION = 3,
1181
+
1182
+ /**
1183
+ * @generated from enum value: FLOW_ACCESS_CODE = 4;
1184
+ */
1185
+ ACCESS_CODE = 4,
1186
+ }
1187
+
1188
+ /**
1189
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow.
1190
+ */
1191
+ export const SecurityScheme_FlowSchema: GenEnum<SecurityScheme_Flow> = /*@__PURE__*/
1192
+ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 12, 2);
1193
+
1194
+ /**
1195
+ * `SecurityRequirement` is a representation of OpenAPI v2 specification's
1196
+ * Security Requirement object.
1197
+ *
1198
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityRequirementObject
1199
+ *
1200
+ * Lists the required security schemes to execute this operation. The object can
1201
+ * have multiple security schemes declared in it which are all required (that
1202
+ * is, there is a logical AND between the schemes).
1203
+ *
1204
+ * The name used for each property MUST correspond to a security scheme
1205
+ * declared in the Security Definitions.
1206
+ *
1207
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement
1208
+ */
1209
+ export type SecurityRequirement = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement"> & {
1210
+ /**
1211
+ * Each name must correspond to a security scheme which is declared in
1212
+ * the Security Definitions. If the security scheme is of type "oauth2",
1213
+ * then the value is a list of scope names required for the execution.
1214
+ * For other security scheme types, the array MUST be empty.
1215
+ *
1216
+ * @generated from field: map<string, grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue> security_requirement = 1;
1217
+ */
1218
+ securityRequirement: { [key: string]: SecurityRequirement_SecurityRequirementValue };
1219
+ };
1220
+
1221
+ /**
1222
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.
1223
+ * Use `create(SecurityRequirementSchema)` to create a new message.
1224
+ */
1225
+ export const SecurityRequirementSchema: GenMessage<SecurityRequirement> = /*@__PURE__*/
1226
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 13);
1227
+
1228
+ /**
1229
+ * If the security scheme is of type "oauth2", then the value is a list of
1230
+ * scope names required for the execution. For other security scheme types,
1231
+ * the array MUST be empty.
1232
+ *
1233
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue
1234
+ */
1235
+ export type SecurityRequirement_SecurityRequirementValue = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue"> & {
1236
+ /**
1237
+ * @generated from field: repeated string scope = 1;
1238
+ */
1239
+ scope: string[];
1240
+ };
1241
+
1242
+ /**
1243
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue.
1244
+ * Use `create(SecurityRequirement_SecurityRequirementValueSchema)` to create a new message.
1245
+ */
1246
+ export const SecurityRequirement_SecurityRequirementValueSchema: GenMessage<SecurityRequirement_SecurityRequirementValue> = /*@__PURE__*/
1247
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 13, 0);
1248
+
1249
+ /**
1250
+ * `Scopes` is a representation of OpenAPI v2 specification's Scopes object.
1251
+ *
1252
+ * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#scopesObject
1253
+ *
1254
+ * Lists the available scopes for an OAuth2 security scheme.
1255
+ *
1256
+ * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Scopes
1257
+ */
1258
+ export type Scopes = Message<"grpc.gateway.protoc_gen_openapiv2.options.Scopes"> & {
1259
+ /**
1260
+ * Maps between a name of a scope to a short description of it (as the value
1261
+ * of the property).
1262
+ *
1263
+ * @generated from field: map<string, string> scope = 1;
1264
+ */
1265
+ scope: { [key: string]: string };
1266
+ };
1267
+
1268
+ /**
1269
+ * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Scopes.
1270
+ * Use `create(ScopesSchema)` to create a new message.
1271
+ */
1272
+ export const ScopesSchema: GenMessage<Scopes> = /*@__PURE__*/
1273
+ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 14);
1274
+
1275
+ /**
1276
+ * Scheme describes the schemes supported by the OpenAPI Swagger
1277
+ * and Operation objects.
1278
+ *
1279
+ * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.Scheme
1280
+ */
1281
+ export enum Scheme {
1282
+ /**
1283
+ * @generated from enum value: UNKNOWN = 0;
1284
+ */
1285
+ UNKNOWN = 0,
1286
+
1287
+ /**
1288
+ * @generated from enum value: HTTP = 1;
1289
+ */
1290
+ HTTP = 1,
1291
+
1292
+ /**
1293
+ * @generated from enum value: HTTPS = 2;
1294
+ */
1295
+ HTTPS = 2,
1296
+
1297
+ /**
1298
+ * @generated from enum value: WS = 3;
1299
+ */
1300
+ WS = 3,
1301
+
1302
+ /**
1303
+ * @generated from enum value: WSS = 4;
1304
+ */
1305
+ WSS = 4,
1306
+ }
1307
+
1308
+ /**
1309
+ * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.Scheme.
1310
+ */
1311
+ export const SchemeSchema: GenEnum<Scheme> = /*@__PURE__*/
1312
+ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 0);
1313
+