// @generated by protoc-gen-es with parameter "elide_plugin_version=true,import_extension=js,json_types=true,target=ts,valid_types=protovalidate_required" // @generated from file protoc-gen-openapiv2/options/openapiv2.proto (package grpc.gateway.protoc_gen_openapiv2.options, syntax proto3) /* eslint-disable */ import type { GenEnum, GenFile, GenMessage, } from "@bufbuild/protobuf/codegenv2"; import { enumDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2"; import type { Value, ValueJson } from "@bufbuild/protobuf/wkt"; import { file_google_protobuf_struct } from "@bufbuild/protobuf/wkt"; import type { Message } from "@bufbuild/protobuf"; /** * Describes the file protoc-gen-openapiv2/options/openapiv2.proto. */ export const file_protoc_gen_openapiv2_options_openapiv2: GenFile = /*@__PURE__*/ fileDesc( "Cixwcm90b2MtZ2VuLW9wZW5hcGl2Mi9vcHRpb25zL29wZW5hcGl2Mi5wcm90bxIpZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMilQcKB1N3YWdnZXISDwoHc3dhZ2dlchgBIAEoCRI9CgRpbmZvGAIgASgLMi8uZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuSW5mbxIMCgRob3N0GAMgASgJEhEKCWJhc2VfcGF0aBgEIAEoCRJCCgdzY2hlbWVzGAUgAygOMjEuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2NoZW1lEhAKCGNvbnN1bWVzGAYgAygJEhAKCHByb2R1Y2VzGAcgAygJElQKCXJlc3BvbnNlcxgKIAMoCzJBLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlN3YWdnZXIuUmVzcG9uc2VzRW50cnkSXAoUc2VjdXJpdHlfZGVmaW5pdGlvbnMYCyABKAsyPi5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TZWN1cml0eURlZmluaXRpb25zElAKCHNlY3VyaXR5GAwgAygLMj4uZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2VjdXJpdHlSZXF1aXJlbWVudBI8CgR0YWdzGA0gAygLMi4uZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuVGFnElcKDWV4dGVybmFsX2RvY3MYDiABKAsyQC5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5FeHRlcm5hbERvY3VtZW50YXRpb24SVgoKZXh0ZW5zaW9ucxgPIAMoCzJCLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlN3YWdnZXIuRXh0ZW5zaW9uc0VudHJ5GmUKDlJlc3BvbnNlc0VudHJ5EgsKA2tleRgBIAEoCRJCCgV2YWx1ZRgCIAEoCzIzLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlJlc3BvbnNlOgI4ARpJCg9FeHRlbnNpb25zRW50cnkSCwoDa2V5GAEgASgJEiUKBXZhbHVlGAIgASgLMhYuZ29vZ2xlLnByb3RvYnVmLlZhbHVlOgI4AUoECAgQCUoECAkQCiKxBgoJT3BlcmF0aW9uEgwKBHRhZ3MYASADKAkSDwoHc3VtbWFyeRgCIAEoCRITCgtkZXNjcmlwdGlvbhgDIAEoCRJXCg1leHRlcm5hbF9kb2NzGAQgASgLMkAuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuRXh0ZXJuYWxEb2N1bWVudGF0aW9uEhQKDG9wZXJhdGlvbl9pZBgFIAEoCRIQCghjb25zdW1lcxgGIAMoCRIQCghwcm9kdWNlcxgHIAMoCRJWCglyZXNwb25zZXMYCSADKAsyQy5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5PcGVyYXRpb24uUmVzcG9uc2VzRW50cnkSQgoHc2NoZW1lcxgKIAMoDjIxLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlNjaGVtZRISCgpkZXByZWNhdGVkGAsgASgIElAKCHNlY3VyaXR5GAwgAygLMj4uZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2VjdXJpdHlSZXF1aXJlbWVudBJYCgpleHRlbnNpb25zGA0gAygLMkQuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuT3BlcmF0aW9uLkV4dGVuc2lvbnNFbnRyeRJJCgpwYXJhbWV0ZXJzGA4gASgLMjUuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuUGFyYW1ldGVycxplCg5SZXNwb25zZXNFbnRyeRILCgNrZXkYASABKAkSQgoFdmFsdWUYAiABKAsyMy5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5SZXNwb25zZToCOAEaSQoPRXh0ZW5zaW9uc0VudHJ5EgsKA2tleRgBIAEoCRIlCgV2YWx1ZRgCIAEoCzIWLmdvb2dsZS5wcm90b2J1Zi5WYWx1ZToCOAFKBAgIEAkiWQoKUGFyYW1ldGVycxJLCgdoZWFkZXJzGAEgAygLMjouZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuSGVhZGVyUGFyYW1ldGVyIvgBCg9IZWFkZXJQYXJhbWV0ZXISDAoEbmFtZRgBIAEoCRITCgtkZXNjcmlwdGlvbhgCIAEoCRJNCgR0eXBlGAMgASgOMj8uZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuSGVhZGVyUGFyYW1ldGVyLlR5cGUSDgoGZm9ybWF0GAQgASgJEhAKCHJlcXVpcmVkGAUgASgIIkUKBFR5cGUSCwoHVU5LTk9XThAAEgoKBlNUUklORxABEgoKBk5VTUJFUhACEgsKB0lOVEVHRVIQAxILCgdCT09MRUFOEARKBAgGEAdKBAgHEAgiqwEKBkhlYWRlchITCgtkZXNjcmlwdGlvbhgBIAEoCRIMCgR0eXBlGAIgASgJEg4KBmZvcm1hdBgDIAEoCRIPCgdkZWZhdWx0GAYgASgJEg8KB3BhdHRlcm4YDSABKAlKBAgEEAVKBAgFEAZKBAgHEAhKBAgIEAlKBAgJEApKBAgKEAtKBAgLEAxKBAgMEA1KBAgOEA9KBAgPEBBKBAgQEBFKBAgREBJKBAgSEBMiwgQKCFJlc3BvbnNlEhMKC2Rlc2NyaXB0aW9uGAEgASgJEkEKBnNjaGVtYRgCIAEoCzIxLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlNjaGVtYRJRCgdoZWFkZXJzGAMgAygLMkAuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuUmVzcG9uc2UuSGVhZGVyc0VudHJ5ElMKCGV4YW1wbGVzGAQgAygLMkEuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuUmVzcG9uc2UuRXhhbXBsZXNFbnRyeRJXCgpleHRlbnNpb25zGAUgAygLMkMuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuUmVzcG9uc2UuRXh0ZW5zaW9uc0VudHJ5GmEKDEhlYWRlcnNFbnRyeRILCgNrZXkYASABKAkSQAoFdmFsdWUYAiABKAsyMS5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5IZWFkZXI6AjgBGi8KDUV4YW1wbGVzRW50cnkSCwoDa2V5GAEgASgJEg0KBXZhbHVlGAIgASgJOgI4ARpJCg9FeHRlbnNpb25zRW50cnkSCwoDa2V5GAEgASgJEiUKBXZhbHVlGAIgASgLMhYuZ29vZ2xlLnByb3RvYnVmLlZhbHVlOgI4ASL/AgoESW5mbxINCgV0aXRsZRgBIAEoCRITCgtkZXNjcmlwdGlvbhgCIAEoCRIYChB0ZXJtc19vZl9zZXJ2aWNlGAMgASgJEkMKB2NvbnRhY3QYBCABKAsyMi5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5Db250YWN0EkMKB2xpY2Vuc2UYBSABKAsyMi5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5MaWNlbnNlEg8KB3ZlcnNpb24YBiABKAkSUwoKZXh0ZW5zaW9ucxgHIAMoCzI/LmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLkluZm8uRXh0ZW5zaW9uc0VudHJ5GkkKD0V4dGVuc2lvbnNFbnRyeRILCgNrZXkYASABKAkSJQoFdmFsdWUYAiABKAsyFi5nb29nbGUucHJvdG9idWYuVmFsdWU6AjgBIjMKB0NvbnRhY3QSDAoEbmFtZRgBIAEoCRILCgN1cmwYAiABKAkSDQoFZW1haWwYAyABKAkiJAoHTGljZW5zZRIMCgRuYW1lGAEgASgJEgsKA3VybBgCIAEoCSI5ChVFeHRlcm5hbERvY3VtZW50YXRpb24SEwoLZGVzY3JpcHRpb24YASABKAkSCwoDdXJsGAIgASgJIu4BCgZTY2hlbWESSgoLanNvbl9zY2hlbWEYASABKAsyNS5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5KU09OU2NoZW1hEhUKDWRpc2NyaW1pbmF0b3IYAiABKAkSEQoJcmVhZF9vbmx5GAMgASgIElcKDWV4dGVybmFsX2RvY3MYBSABKAsyQC5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5FeHRlcm5hbERvY3VtZW50YXRpb24SDwoHZXhhbXBsZRgGIAEoCUoECAQQBSKiCAoKSlNPTlNjaGVtYRILCgNyZWYYAyABKAkSDQoFdGl0bGUYBSABKAkSEwoLZGVzY3JpcHRpb24YBiABKAkSDwoHZGVmYXVsdBgHIAEoCRIRCglyZWFkX29ubHkYCCABKAgSDwoHZXhhbXBsZRgJIAEoCRITCgttdWx0aXBsZV9vZhgKIAEoARIPCgdtYXhpbXVtGAsgASgBEhkKEWV4Y2x1c2l2ZV9tYXhpbXVtGAwgASgIEg8KB21pbmltdW0YDSABKAESGQoRZXhjbHVzaXZlX21pbmltdW0YDiABKAgSEgoKbWF4X2xlbmd0aBgPIAEoBBISCgptaW5fbGVuZ3RoGBAgASgEEg8KB3BhdHRlcm4YESABKAkSEQoJbWF4X2l0ZW1zGBQgASgEEhEKCW1pbl9pdGVtcxgVIAEoBBIUCgx1bmlxdWVfaXRlbXMYFiABKAgSFgoObWF4X3Byb3BlcnRpZXMYGCABKAQSFgoObWluX3Byb3BlcnRpZXMYGSABKAQSEAoIcmVxdWlyZWQYGiADKAkSDQoFYXJyYXkYIiADKAkSWQoEdHlwZRgjIAMoDjJLLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLkpTT05TY2hlbWEuSlNPTlNjaGVtYVNpbXBsZVR5cGVzEg4KBmZvcm1hdBgkIAEoCRIMCgRlbnVtGC4gAygJEmYKE2ZpZWxkX2NvbmZpZ3VyYXRpb24Y6QcgASgLMkguZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuSlNPTlNjaGVtYS5GaWVsZENvbmZpZ3VyYXRpb24SWQoKZXh0ZW5zaW9ucxgwIAMoCzJFLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLkpTT05TY2hlbWEuRXh0ZW5zaW9uc0VudHJ5Gi0KEkZpZWxkQ29uZmlndXJhdGlvbhIXCg9wYXRoX3BhcmFtX25hbWUYLyABKAkaSQoPRXh0ZW5zaW9uc0VudHJ5EgsKA2tleRgBIAEoCRIlCgV2YWx1ZRgCIAEoCzIWLmdvb2dsZS5wcm90b2J1Zi5WYWx1ZToCOAEidwoVSlNPTlNjaGVtYVNpbXBsZVR5cGVzEgsKB1VOS05PV04QABIJCgVBUlJBWRABEgsKB0JPT0xFQU4QAhILCgdJTlRFR0VSEAMSCAoETlVMTBAEEgoKBk5VTUJFUhAFEgoKBk9CSkVDVBAGEgoKBlNUUklORxAHSgQIARACSgQIAhADSgQIBBAFSgQIEhATSgQIExAUSgQIFxAYSgQIGxAcSgQIHBAdSgQIHRAeSgQIHhAiSgQIJRAqSgQIKhArSgQIKxAuIqACCgNUYWcSDAoEbmFtZRgBIAEoCRITCgtkZXNjcmlwdGlvbhgCIAEoCRJXCg1leHRlcm5hbF9kb2NzGAMgASgLMkAuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuRXh0ZXJuYWxEb2N1bWVudGF0aW9uElIKCmV4dGVuc2lvbnMYBCADKAsyPi5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5UYWcuRXh0ZW5zaW9uc0VudHJ5GkkKD0V4dGVuc2lvbnNFbnRyeRILCgNrZXkYASABKAkSJQoFdmFsdWUYAiABKAsyFi5nb29nbGUucHJvdG9idWYuVmFsdWU6AjgBIuEBChNTZWN1cml0eURlZmluaXRpb25zEl4KCHNlY3VyaXR5GAEgAygLMkwuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2VjdXJpdHlEZWZpbml0aW9ucy5TZWN1cml0eUVudHJ5GmoKDVNlY3VyaXR5RW50cnkSCwoDa2V5GAEgASgJEkgKBXZhbHVlGAIgASgLMjkuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2VjdXJpdHlTY2hlbWU6AjgBIqAGCg5TZWN1cml0eVNjaGVtZRJMCgR0eXBlGAEgASgOMj4uZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2VjdXJpdHlTY2hlbWUuVHlwZRITCgtkZXNjcmlwdGlvbhgCIAEoCRIMCgRuYW1lGAMgASgJEkgKAmluGAQgASgOMjwuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2VjdXJpdHlTY2hlbWUuSW4STAoEZmxvdxgFIAEoDjI+LmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlNlY3VyaXR5U2NoZW1lLkZsb3cSGQoRYXV0aG9yaXphdGlvbl91cmwYBiABKAkSEQoJdG9rZW5fdXJsGAcgASgJEkEKBnNjb3BlcxgIIAEoCzIxLmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlNjb3BlcxJdCgpleHRlbnNpb25zGAkgAygLMkkuZ3JwYy5nYXRld2F5LnByb3RvY19nZW5fb3BlbmFwaXYyLm9wdGlvbnMuU2VjdXJpdHlTY2hlbWUuRXh0ZW5zaW9uc0VudHJ5GkkKD0V4dGVuc2lvbnNFbnRyeRILCgNrZXkYASABKAkSJQoFdmFsdWUYAiABKAsyFi5nb29nbGUucHJvdG9idWYuVmFsdWU6AjgBIksKBFR5cGUSEAoMVFlQRV9JTlZBTElEEAASDgoKVFlQRV9CQVNJQxABEhAKDFRZUEVfQVBJX0tFWRACEg8KC1RZUEVfT0FVVEgyEAMiMQoCSW4SDgoKSU5fSU5WQUxJRBAAEgwKCElOX1FVRVJZEAESDQoJSU5fSEVBREVSEAIiagoERmxvdxIQCgxGTE9XX0lOVkFMSUQQABIRCg1GTE9XX0lNUExJQ0lUEAESEQoNRkxPV19QQVNTV09SRBACEhQKEEZMT1dfQVBQTElDQVRJT04QAxIUChBGTE9XX0FDQ0VTU19DT0RFEAQizQIKE1NlY3VyaXR5UmVxdWlyZW1lbnQSdQoUc2VjdXJpdHlfcmVxdWlyZW1lbnQYASADKAsyVy5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TZWN1cml0eVJlcXVpcmVtZW50LlNlY3VyaXR5UmVxdWlyZW1lbnRFbnRyeRopChhTZWN1cml0eVJlcXVpcmVtZW50VmFsdWUSDQoFc2NvcGUYASADKAkakwEKGFNlY3VyaXR5UmVxdWlyZW1lbnRFbnRyeRILCgNrZXkYASABKAkSZgoFdmFsdWUYAiABKAsyVy5ncnBjLmdhdGV3YXkucHJvdG9jX2dlbl9vcGVuYXBpdjIub3B0aW9ucy5TZWN1cml0eVJlcXVpcmVtZW50LlNlY3VyaXR5UmVxdWlyZW1lbnRWYWx1ZToCOAEigwEKBlNjb3BlcxJLCgVzY29wZRgBIAMoCzI8LmdycGMuZ2F0ZXdheS5wcm90b2NfZ2VuX29wZW5hcGl2Mi5vcHRpb25zLlNjb3Blcy5TY29wZUVudHJ5GiwKClNjb3BlRW50cnkSCwoDa2V5GAEgASgJEg0KBXZhbHVlGAIgASgJOgI4ASo7CgZTY2hlbWUSCwoHVU5LTk9XThAAEggKBEhUVFAQARIJCgVIVFRQUxACEgYKAldTEAMSBwoDV1NTEARCSFpGZ2l0aHViLmNvbS9ncnBjLWVjb3N5c3RlbS9ncnBjLWdhdGV3YXkvdjIvcHJvdG9jLWdlbi1vcGVuYXBpdjIvb3B0aW9uc2IGcHJvdG8z", [file_google_protobuf_struct], ); /** * `Swagger` is a representation of OpenAPI v2 specification's Swagger object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * info: { * title: "Echo API"; * version: "1.0"; * description: ""; * contact: { * name: "gRPC-Gateway project"; * url: "https://github.com/grpc-ecosystem/grpc-gateway"; * email: "none@example.com"; * }; * license: { * name: "BSD 3-Clause License"; * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE"; * }; * }; * schemes: HTTPS; * consumes: "application/json"; * produces: "application/json"; * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Swagger */ export type Swagger = Message<"grpc.gateway.protoc_gen_openapiv2.options.Swagger"> & { /** * Specifies the OpenAPI Specification version being used. It can be * used by the OpenAPI UI and other clients to interpret the API listing. The * value MUST be "2.0". * * @generated from field: string swagger = 1; */ swagger: string; /** * Provides metadata about the API. The metadata can be used by the * clients if needed. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Info info = 2; */ info?: Info | undefined; /** * The host (name or ip) serving the API. This MUST be the host only and does * not include the scheme nor sub-paths. It MAY include a port. If the host is * not included, the host serving the documentation is to be used (including * the port). The host does not support path templating. * * @generated from field: string host = 3; */ host: string; /** * The base path on which the API is served, which is relative to the host. If * it is not included, the API is served directly under the host. The value * MUST start with a leading slash (/). The basePath does not support path * templating. * Note that using `base_path` does not change the endpoint paths that are * generated in the resulting OpenAPI file. If you wish to use `base_path` * with relatively generated OpenAPI paths, the `base_path` prefix must be * manually removed from your `google.api.http` paths and your code changed to * serve the API from the `base_path`. * * @generated from field: string base_path = 4; */ basePath: string; /** * The transfer protocol of the API. Values MUST be from the list: "http", * "https", "ws", "wss". If the schemes is not included, the default scheme to * be used is the one used to access the OpenAPI definition itself. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5; */ schemes: Scheme[]; /** * A list of MIME types the APIs can consume. This is global to all APIs but * can be overridden on specific API calls. Value MUST be as described under * Mime Types. * * @generated from field: repeated string consumes = 6; */ consumes: string[]; /** * A list of MIME types the APIs can produce. This is global to all APIs but * can be overridden on specific API calls. Value MUST be as described under * Mime Types. * * @generated from field: repeated string produces = 7; */ produces: string[]; /** * An object to hold responses that can be used across operations. This * property does not define global responses for all operations. * * @generated from field: map responses = 10; */ responses: { [key: string]: Response }; /** * Security scheme definitions that can be used across the specification. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11; */ securityDefinitions?: SecurityDefinitions | undefined; /** * A declaration of which security schemes are applied for the API as a whole. * The list of values describes alternative security schemes that can be used * (that is, there is a logical OR between the security requirements). * Individual operations can override this definition. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12; */ security: SecurityRequirement[]; /** * A list of tags for API documentation control. Tags can be used for logical * grouping of operations by resources or any other qualifier. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13; */ tags: Tag[]; /** * Additional external documentation. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14; */ externalDocs?: ExternalDocumentation | undefined; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 15; */ extensions: { [key: string]: Value }; }; /** * `Swagger` is a representation of OpenAPI v2 specification's Swagger object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * info: { * title: "Echo API"; * version: "1.0"; * description: ""; * contact: { * name: "gRPC-Gateway project"; * url: "https://github.com/grpc-ecosystem/grpc-gateway"; * email: "none@example.com"; * }; * license: { * name: "BSD 3-Clause License"; * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE"; * }; * }; * schemes: HTTPS; * consumes: "application/json"; * produces: "application/json"; * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Swagger */ export type SwaggerJson = { /** * Specifies the OpenAPI Specification version being used. It can be * used by the OpenAPI UI and other clients to interpret the API listing. The * value MUST be "2.0". * * @generated from field: string swagger = 1; */ swagger?: string; /** * Provides metadata about the API. The metadata can be used by the * clients if needed. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Info info = 2; */ info?: InfoJson; /** * The host (name or ip) serving the API. This MUST be the host only and does * not include the scheme nor sub-paths. It MAY include a port. If the host is * not included, the host serving the documentation is to be used (including * the port). The host does not support path templating. * * @generated from field: string host = 3; */ host?: string; /** * The base path on which the API is served, which is relative to the host. If * it is not included, the API is served directly under the host. The value * MUST start with a leading slash (/). The basePath does not support path * templating. * Note that using `base_path` does not change the endpoint paths that are * generated in the resulting OpenAPI file. If you wish to use `base_path` * with relatively generated OpenAPI paths, the `base_path` prefix must be * manually removed from your `google.api.http` paths and your code changed to * serve the API from the `base_path`. * * @generated from field: string base_path = 4; */ basePath?: string; /** * The transfer protocol of the API. Values MUST be from the list: "http", * "https", "ws", "wss". If the schemes is not included, the default scheme to * be used is the one used to access the OpenAPI definition itself. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5; */ schemes?: SchemeJson[]; /** * A list of MIME types the APIs can consume. This is global to all APIs but * can be overridden on specific API calls. Value MUST be as described under * Mime Types. * * @generated from field: repeated string consumes = 6; */ consumes?: string[]; /** * A list of MIME types the APIs can produce. This is global to all APIs but * can be overridden on specific API calls. Value MUST be as described under * Mime Types. * * @generated from field: repeated string produces = 7; */ produces?: string[]; /** * An object to hold responses that can be used across operations. This * property does not define global responses for all operations. * * @generated from field: map responses = 10; */ responses?: { [key: string]: ResponseJson }; /** * Security scheme definitions that can be used across the specification. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11; */ securityDefinitions?: SecurityDefinitionsJson; /** * A declaration of which security schemes are applied for the API as a whole. * The list of values describes alternative security schemes that can be used * (that is, there is a logical OR between the security requirements). * Individual operations can override this definition. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12; */ security?: SecurityRequirementJson[]; /** * A list of tags for API documentation control. Tags can be used for logical * grouping of operations by resources or any other qualifier. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13; */ tags?: TagJson[]; /** * Additional external documentation. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14; */ externalDocs?: ExternalDocumentationJson; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 15; */ extensions?: { [key: string]: ValueJson }; }; export type SwaggerValid = Swagger; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Swagger. * Use `create(SwaggerSchema)` to create a new message. */ export const SwaggerSchema: GenMessage< Swagger, { jsonType: SwaggerJson; validType: SwaggerValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 0); /** * `Operation` is a representation of OpenAPI v2 specification's Operation object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject * * Example: * * service EchoService { * rpc Echo(SimpleMessage) returns (SimpleMessage) { * option (google.api.http) = { * get: "/v1/example/echo/{id}" * }; * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { * summary: "Get a message."; * operation_id: "getMessage"; * tags: "echo"; * responses: { * key: "200" * value: { * description: "OK"; * } * } * }; * } * } * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Operation */ export type Operation = Message<"grpc.gateway.protoc_gen_openapiv2.options.Operation"> & { /** * A list of tags for API documentation control. Tags can be used for logical * grouping of operations by resources or any other qualifier. * * @generated from field: repeated string tags = 1; */ tags: string[]; /** * A short summary of what the operation does. For maximum readability in the * swagger-ui, this field SHOULD be less than 120 characters. * * @generated from field: string summary = 2; */ summary: string; /** * A verbose explanation of the operation behavior. GFM syntax can be used for * rich text representation. * * @generated from field: string description = 3; */ description: string; /** * Additional external documentation for this operation. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4; */ externalDocs?: ExternalDocumentation | undefined; /** * Unique string used to identify the operation. The id MUST be unique among * all operations described in the API. Tools and libraries MAY use the * operationId to uniquely identify an operation, therefore, it is recommended * to follow common programming naming conventions. * * @generated from field: string operation_id = 5; */ operationId: string; /** * A list of MIME types the operation can consume. This overrides the consumes * definition at the OpenAPI Object. An empty value MAY be used to clear the * global definition. Value MUST be as described under Mime Types. * * @generated from field: repeated string consumes = 6; */ consumes: string[]; /** * A list of MIME types the operation can produce. This overrides the produces * definition at the OpenAPI Object. An empty value MAY be used to clear the * global definition. Value MUST be as described under Mime Types. * * @generated from field: repeated string produces = 7; */ produces: string[]; /** * The list of possible responses as they are returned from executing this * operation. * * @generated from field: map responses = 9; */ responses: { [key: string]: Response }; /** * The transfer protocol for the operation. Values MUST be from the list: * "http", "https", "ws", "wss". The value overrides the OpenAPI Object * schemes definition. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10; */ schemes: Scheme[]; /** * Declares this operation to be deprecated. Usage of the declared operation * should be refrained. Default value is false. * * @generated from field: bool deprecated = 11; */ deprecated: boolean; /** * A declaration of which security schemes are applied for this operation. The * list of values describes alternative security schemes that can be used * (that is, there is a logical OR between the security requirements). This * definition overrides any declared top-level security. To remove a top-level * security declaration, an empty array can be used. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12; */ security: SecurityRequirement[]; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 13; */ extensions: { [key: string]: Value }; /** * Custom parameters such as HTTP request headers. * See: https://swagger.io/docs/specification/2-0/describing-parameters/ * and https://swagger.io/specification/v2/#parameter-object. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14; */ parameters?: Parameters | undefined; }; /** * `Operation` is a representation of OpenAPI v2 specification's Operation object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject * * Example: * * service EchoService { * rpc Echo(SimpleMessage) returns (SimpleMessage) { * option (google.api.http) = { * get: "/v1/example/echo/{id}" * }; * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = { * summary: "Get a message."; * operation_id: "getMessage"; * tags: "echo"; * responses: { * key: "200" * value: { * description: "OK"; * } * } * }; * } * } * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Operation */ export type OperationJson = { /** * A list of tags for API documentation control. Tags can be used for logical * grouping of operations by resources or any other qualifier. * * @generated from field: repeated string tags = 1; */ tags?: string[]; /** * A short summary of what the operation does. For maximum readability in the * swagger-ui, this field SHOULD be less than 120 characters. * * @generated from field: string summary = 2; */ summary?: string; /** * A verbose explanation of the operation behavior. GFM syntax can be used for * rich text representation. * * @generated from field: string description = 3; */ description?: string; /** * Additional external documentation for this operation. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4; */ externalDocs?: ExternalDocumentationJson; /** * Unique string used to identify the operation. The id MUST be unique among * all operations described in the API. Tools and libraries MAY use the * operationId to uniquely identify an operation, therefore, it is recommended * to follow common programming naming conventions. * * @generated from field: string operation_id = 5; */ operationId?: string; /** * A list of MIME types the operation can consume. This overrides the consumes * definition at the OpenAPI Object. An empty value MAY be used to clear the * global definition. Value MUST be as described under Mime Types. * * @generated from field: repeated string consumes = 6; */ consumes?: string[]; /** * A list of MIME types the operation can produce. This overrides the produces * definition at the OpenAPI Object. An empty value MAY be used to clear the * global definition. Value MUST be as described under Mime Types. * * @generated from field: repeated string produces = 7; */ produces?: string[]; /** * The list of possible responses as they are returned from executing this * operation. * * @generated from field: map responses = 9; */ responses?: { [key: string]: ResponseJson }; /** * The transfer protocol for the operation. Values MUST be from the list: * "http", "https", "ws", "wss". The value overrides the OpenAPI Object * schemes definition. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 10; */ schemes?: SchemeJson[]; /** * Declares this operation to be deprecated. Usage of the declared operation * should be refrained. Default value is false. * * @generated from field: bool deprecated = 11; */ deprecated?: boolean; /** * A declaration of which security schemes are applied for this operation. The * list of values describes alternative security schemes that can be used * (that is, there is a logical OR between the security requirements). This * definition overrides any declared top-level security. To remove a top-level * security declaration, an empty array can be used. * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12; */ security?: SecurityRequirementJson[]; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 13; */ extensions?: { [key: string]: ValueJson }; /** * Custom parameters such as HTTP request headers. * See: https://swagger.io/docs/specification/2-0/describing-parameters/ * and https://swagger.io/specification/v2/#parameter-object. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14; */ parameters?: ParametersJson; }; export type OperationValid = Operation; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Operation. * Use `create(OperationSchema)` to create a new message. */ export const OperationSchema: GenMessage< Operation, { jsonType: OperationJson; validType: OperationValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 1); /** * `Parameters` is a representation of OpenAPI v2 specification's parameters object. * Note: This technically breaks compatibility with the OpenAPI 2 definition structure as we only * allow header parameters to be set here since we do not want users specifying custom non-header * parameters beyond those inferred from the Protobuf schema. * See: https://swagger.io/specification/v2/#parameter-object * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Parameters */ export type Parameters = Message<"grpc.gateway.protoc_gen_openapiv2.options.Parameters"> & { /** * `Headers` is one or more HTTP header parameter. * See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1; */ headers: HeaderParameter[]; }; /** * `Parameters` is a representation of OpenAPI v2 specification's parameters object. * Note: This technically breaks compatibility with the OpenAPI 2 definition structure as we only * allow header parameters to be set here since we do not want users specifying custom non-header * parameters beyond those inferred from the Protobuf schema. * See: https://swagger.io/specification/v2/#parameter-object * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Parameters */ export type ParametersJson = { /** * `Headers` is one or more HTTP header parameter. * See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters * * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1; */ headers?: HeaderParameterJson[]; }; export type ParametersValid = Parameters; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Parameters. * Use `create(ParametersSchema)` to create a new message. */ export const ParametersSchema: GenMessage< Parameters, { jsonType: ParametersJson; validType: ParametersValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 2); /** * `HeaderParameter` a HTTP header parameter. * See: https://swagger.io/specification/v2/#parameter-object * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter */ export type HeaderParameter = Message<"grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter"> & { /** * `Name` is the header name. * * @generated from field: string name = 1; */ name: string; /** * `Description` is a short description of the header. * * @generated from field: string description = 2; */ description: string; /** * `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported. * See: https://swagger.io/specification/v2/#parameterType. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3; */ type: HeaderParameter_Type; /** * `Format` The extending format for the previously mentioned type. * * @generated from field: string format = 4; */ format: string; /** * `Required` indicates if the header is optional * * @generated from field: bool required = 5; */ required: boolean; }; /** * `HeaderParameter` a HTTP header parameter. * See: https://swagger.io/specification/v2/#parameter-object * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter */ export type HeaderParameterJson = { /** * `Name` is the header name. * * @generated from field: string name = 1; */ name?: string; /** * `Description` is a short description of the header. * * @generated from field: string description = 2; */ description?: string; /** * `Type` is the type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported. * See: https://swagger.io/specification/v2/#parameterType. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3; */ type?: HeaderParameter_TypeJson; /** * `Format` The extending format for the previously mentioned type. * * @generated from field: string format = 4; */ format?: string; /** * `Required` indicates if the header is optional * * @generated from field: bool required = 5; */ required?: boolean; }; export type HeaderParameterValid = HeaderParameter; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter. * Use `create(HeaderParameterSchema)` to create a new message. */ export const HeaderParameterSchema: GenMessage< HeaderParameter, { jsonType: HeaderParameterJson; validType: HeaderParameterValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 3); /** * `Type` is a supported HTTP header type. * See https://swagger.io/specification/v2/#parameterType. * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type */ export enum HeaderParameter_Type { /** * @generated from enum value: UNKNOWN = 0; */ UNKNOWN = 0, /** * @generated from enum value: STRING = 1; */ STRING = 1, /** * @generated from enum value: NUMBER = 2; */ NUMBER = 2, /** * @generated from enum value: INTEGER = 3; */ INTEGER = 3, /** * @generated from enum value: BOOLEAN = 4; */ BOOLEAN = 4, } /** * `Type` is a supported HTTP header type. * See https://swagger.io/specification/v2/#parameterType. * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type */ export type HeaderParameter_TypeJson = "UNKNOWN" | "STRING" | "NUMBER" | "INTEGER" | "BOOLEAN"; /** * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type. */ export const HeaderParameter_TypeSchema: GenEnum< HeaderParameter_Type, HeaderParameter_TypeJson > = /*@__PURE__*/ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 3, 0); /** * `Header` is a representation of OpenAPI v2 specification's Header object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Header */ export type Header = Message<"grpc.gateway.protoc_gen_openapiv2.options.Header"> & { /** * `Description` is a short description of the header. * * @generated from field: string description = 1; */ description: string; /** * The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported. * * @generated from field: string type = 2; */ type: string; /** * `Format` The extending format for the previously mentioned type. * * @generated from field: string format = 3; */ format: string; /** * `Default` Declares the value of the header that the server will use if none is provided. * See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. * Unlike JSON Schema this value MUST conform to the defined type for the header. * * @generated from field: string default = 6; */ default: string; /** * 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. * * @generated from field: string pattern = 13; */ pattern: string; }; /** * `Header` is a representation of OpenAPI v2 specification's Header object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#headerObject * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Header */ export type HeaderJson = { /** * `Description` is a short description of the header. * * @generated from field: string description = 1; */ description?: string; /** * The type of the object. The value MUST be one of "string", "number", "integer", or "boolean". The "array" type is not supported. * * @generated from field: string type = 2; */ type?: string; /** * `Format` The extending format for the previously mentioned type. * * @generated from field: string format = 3; */ format?: string; /** * `Default` Declares the value of the header that the server will use if none is provided. * See: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. * Unlike JSON Schema this value MUST conform to the defined type for the header. * * @generated from field: string default = 6; */ default?: string; /** * 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. * * @generated from field: string pattern = 13; */ pattern?: string; }; export type HeaderValid = Header; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Header. * Use `create(HeaderSchema)` to create a new message. */ export const HeaderSchema: GenMessage< Header, { jsonType: HeaderJson; validType: HeaderValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 4); /** * `Response` is a representation of OpenAPI v2 specification's Response object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Response */ export type Response = Message<"grpc.gateway.protoc_gen_openapiv2.options.Response"> & { /** * `Description` is a short description of the response. * GFM syntax can be used for rich text representation. * * @generated from field: string description = 1; */ description: string; /** * `Schema` optionally defines the structure of the response. * If `Schema` is not provided, it means there is no content to the response. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2; */ schema?: Schema | undefined; /** * `Headers` A list of headers that are sent with the response. * `Header` name is expected to be a string in the canonical format of the MIME header key * See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey * * @generated from field: map headers = 3; */ headers: { [key: string]: Header }; /** * `Examples` gives per-mimetype response examples. * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object * * @generated from field: map examples = 4; */ examples: { [key: string]: string }; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 5; */ extensions: { [key: string]: Value }; }; /** * `Response` is a representation of OpenAPI v2 specification's Response object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Response */ export type ResponseJson = { /** * `Description` is a short description of the response. * GFM syntax can be used for rich text representation. * * @generated from field: string description = 1; */ description?: string; /** * `Schema` optionally defines the structure of the response. * If `Schema` is not provided, it means there is no content to the response. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2; */ schema?: SchemaJson; /** * `Headers` A list of headers that are sent with the response. * `Header` name is expected to be a string in the canonical format of the MIME header key * See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey * * @generated from field: map headers = 3; */ headers?: { [key: string]: HeaderJson }; /** * `Examples` gives per-mimetype response examples. * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object * * @generated from field: map examples = 4; */ examples?: { [key: string]: string }; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 5; */ extensions?: { [key: string]: ValueJson }; }; export type ResponseValid = Response; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Response. * Use `create(ResponseSchema)` to create a new message. */ export const ResponseSchema: GenMessage< Response, { jsonType: ResponseJson; validType: ResponseValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 5); /** * `Info` is a representation of OpenAPI v2 specification's Info object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * info: { * title: "Echo API"; * version: "1.0"; * description: ""; * contact: { * name: "gRPC-Gateway project"; * url: "https://github.com/grpc-ecosystem/grpc-gateway"; * email: "none@example.com"; * }; * license: { * name: "BSD 3-Clause License"; * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE"; * }; * }; * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Info */ export type Info = Message<"grpc.gateway.protoc_gen_openapiv2.options.Info"> & { /** * The title of the application. * * @generated from field: string title = 1; */ title: string; /** * A short description of the application. GFM syntax can be used for rich * text representation. * * @generated from field: string description = 2; */ description: string; /** * The Terms of Service for the API. * * @generated from field: string terms_of_service = 3; */ termsOfService: string; /** * The contact information for the exposed API. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4; */ contact?: Contact | undefined; /** * The license information for the exposed API. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.License license = 5; */ license?: License | undefined; /** * Provides the version of the application API (not to be confused * with the specification version). * * @generated from field: string version = 6; */ version: string; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 7; */ extensions: { [key: string]: Value }; }; /** * `Info` is a representation of OpenAPI v2 specification's Info object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * info: { * title: "Echo API"; * version: "1.0"; * description: ""; * contact: { * name: "gRPC-Gateway project"; * url: "https://github.com/grpc-ecosystem/grpc-gateway"; * email: "none@example.com"; * }; * license: { * name: "BSD 3-Clause License"; * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE"; * }; * }; * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Info */ export type InfoJson = { /** * The title of the application. * * @generated from field: string title = 1; */ title?: string; /** * A short description of the application. GFM syntax can be used for rich * text representation. * * @generated from field: string description = 2; */ description?: string; /** * The Terms of Service for the API. * * @generated from field: string terms_of_service = 3; */ termsOfService?: string; /** * The contact information for the exposed API. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4; */ contact?: ContactJson; /** * The license information for the exposed API. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.License license = 5; */ license?: LicenseJson; /** * Provides the version of the application API (not to be confused * with the specification version). * * @generated from field: string version = 6; */ version?: string; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 7; */ extensions?: { [key: string]: ValueJson }; }; export type InfoValid = Info; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Info. * Use `create(InfoSchema)` to create a new message. */ export const InfoSchema: GenMessage< Info, { jsonType: InfoJson; validType: InfoValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 6); /** * `Contact` is a representation of OpenAPI v2 specification's Contact object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#contactObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * info: { * ... * contact: { * name: "gRPC-Gateway project"; * url: "https://github.com/grpc-ecosystem/grpc-gateway"; * email: "none@example.com"; * }; * ... * }; * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Contact */ export type Contact = Message<"grpc.gateway.protoc_gen_openapiv2.options.Contact"> & { /** * The identifying name of the contact person/organization. * * @generated from field: string name = 1; */ name: string; /** * The URL pointing to the contact information. MUST be in the format of a * URL. * * @generated from field: string url = 2; */ url: string; /** * The email address of the contact person/organization. MUST be in the format * of an email address. * * @generated from field: string email = 3; */ email: string; }; /** * `Contact` is a representation of OpenAPI v2 specification's Contact object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#contactObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * info: { * ... * contact: { * name: "gRPC-Gateway project"; * url: "https://github.com/grpc-ecosystem/grpc-gateway"; * email: "none@example.com"; * }; * ... * }; * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Contact */ export type ContactJson = { /** * The identifying name of the contact person/organization. * * @generated from field: string name = 1; */ name?: string; /** * The URL pointing to the contact information. MUST be in the format of a * URL. * * @generated from field: string url = 2; */ url?: string; /** * The email address of the contact person/organization. MUST be in the format * of an email address. * * @generated from field: string email = 3; */ email?: string; }; export type ContactValid = Contact; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Contact. * Use `create(ContactSchema)` to create a new message. */ export const ContactSchema: GenMessage< Contact, { jsonType: ContactJson; validType: ContactValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 7); /** * `License` is a representation of OpenAPI v2 specification's License object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#licenseObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * info: { * ... * license: { * name: "BSD 3-Clause License"; * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE"; * }; * ... * }; * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.License */ export type License = Message<"grpc.gateway.protoc_gen_openapiv2.options.License"> & { /** * The license name used for the API. * * @generated from field: string name = 1; */ name: string; /** * A URL to the license used for the API. MUST be in the format of a URL. * * @generated from field: string url = 2; */ url: string; }; /** * `License` is a representation of OpenAPI v2 specification's License object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#licenseObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * info: { * ... * license: { * name: "BSD 3-Clause License"; * url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE"; * }; * ... * }; * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.License */ export type LicenseJson = { /** * The license name used for the API. * * @generated from field: string name = 1; */ name?: string; /** * A URL to the license used for the API. MUST be in the format of a URL. * * @generated from field: string url = 2; */ url?: string; }; export type LicenseValid = License; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.License. * Use `create(LicenseSchema)` to create a new message. */ export const LicenseSchema: GenMessage< License, { jsonType: LicenseJson; validType: LicenseValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 8); /** * `ExternalDocumentation` is a representation of OpenAPI v2 specification's * ExternalDocumentation object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * ... * external_docs: { * description: "More about gRPC-Gateway"; * url: "https://github.com/grpc-ecosystem/grpc-gateway"; * } * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation */ export type ExternalDocumentation = Message<"grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation"> & { /** * A short description of the target documentation. GFM syntax can be used for * rich text representation. * * @generated from field: string description = 1; */ description: string; /** * The URL for the target documentation. Value MUST be in the format * of a URL. * * @generated from field: string url = 2; */ url: string; }; /** * `ExternalDocumentation` is a representation of OpenAPI v2 specification's * ExternalDocumentation object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject * * Example: * * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { * ... * external_docs: { * description: "More about gRPC-Gateway"; * url: "https://github.com/grpc-ecosystem/grpc-gateway"; * } * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation */ export type ExternalDocumentationJson = { /** * A short description of the target documentation. GFM syntax can be used for * rich text representation. * * @generated from field: string description = 1; */ description?: string; /** * The URL for the target documentation. Value MUST be in the format * of a URL. * * @generated from field: string url = 2; */ url?: string; }; export type ExternalDocumentationValid = ExternalDocumentation; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation. * Use `create(ExternalDocumentationSchema)` to create a new message. */ export const ExternalDocumentationSchema: GenMessage< ExternalDocumentation, { jsonType: ExternalDocumentationJson; validType: ExternalDocumentationValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 9); /** * `Schema` is a representation of OpenAPI v2 specification's Schema object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Schema */ export type Schema = Message<"grpc.gateway.protoc_gen_openapiv2.options.Schema"> & { /** * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1; */ jsonSchema?: JSONSchema | undefined; /** * Adds support for polymorphism. The discriminator is the schema property * name that is used to differentiate between other schema that inherit this * schema. The property name used MUST be defined at this schema and it MUST * be in the required property list. When used, the value MUST be the name of * this schema or any schema that inherits it. * * @generated from field: string discriminator = 2; */ discriminator: string; /** * Relevant only for Schema "properties" definitions. Declares the property as * "read only". This means that it MAY be sent as part of a response but MUST * NOT be sent as part of the request. Properties marked as readOnly being * true SHOULD NOT be in the required list of the defined schema. Default * value is false. * * @generated from field: bool read_only = 3; */ readOnly: boolean; /** * Additional external documentation for this schema. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5; */ externalDocs?: ExternalDocumentation | undefined; /** * A free-form property to include an example of an instance for this schema in JSON. * This is copied verbatim to the output. * * @generated from field: string example = 6; */ example: string; }; /** * `Schema` is a representation of OpenAPI v2 specification's Schema object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Schema */ export type SchemaJson = { /** * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1; */ jsonSchema?: JSONSchemaJson; /** * Adds support for polymorphism. The discriminator is the schema property * name that is used to differentiate between other schema that inherit this * schema. The property name used MUST be defined at this schema and it MUST * be in the required property list. When used, the value MUST be the name of * this schema or any schema that inherits it. * * @generated from field: string discriminator = 2; */ discriminator?: string; /** * Relevant only for Schema "properties" definitions. Declares the property as * "read only". This means that it MAY be sent as part of a response but MUST * NOT be sent as part of the request. Properties marked as readOnly being * true SHOULD NOT be in the required list of the defined schema. Default * value is false. * * @generated from field: bool read_only = 3; */ readOnly?: boolean; /** * Additional external documentation for this schema. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5; */ externalDocs?: ExternalDocumentationJson; /** * A free-form property to include an example of an instance for this schema in JSON. * This is copied verbatim to the output. * * @generated from field: string example = 6; */ example?: string; }; export type SchemaValid = Schema; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Schema. * Use `create(SchemaSchema)` to create a new message. */ export const SchemaSchema: GenMessage< Schema, { jsonType: SchemaJson; validType: SchemaValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 10); /** * `JSONSchema` represents properties from JSON Schema taken, and as used, in * the OpenAPI v2 spec. * * This includes changes made by OpenAPI v2. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject * * See also: https://cswr.github.io/JsonSchema/spec/basic_types/, * https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json * * Example: * * message SimpleMessage { * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { * json_schema: { * title: "SimpleMessage" * description: "A simple message." * required: ["id"] * } * }; * * // Id represents the message identifier. * string id = 1; [ * (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { * description: "The unique identifier of the simple message." * }]; * } * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema */ export type JSONSchema = Message<"grpc.gateway.protoc_gen_openapiv2.options.JSONSchema"> & { /** * Ref is used to define an external reference to include in the message. * This could be a fully qualified proto message reference, and that type must * be imported into the protofile. If no message is identified, the Ref will * be used verbatim in the output. * For example: * `ref: ".google.protobuf.Timestamp"`. * * @generated from field: string ref = 3; */ ref: string; /** * The title of the schema. * * @generated from field: string title = 5; */ title: string; /** * A short description of the schema. * * @generated from field: string description = 6; */ description: string; /** * @generated from field: string default = 7; */ default: string; /** * @generated from field: bool read_only = 8; */ readOnly: boolean; /** * A free-form property to include a JSON example of this field. This is copied * verbatim to the output swagger.json. Quotes must be escaped. * 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 * * @generated from field: string example = 9; */ example: string; /** * @generated from field: double multiple_of = 10; */ multipleOf: number; /** * Maximum represents an inclusive upper limit for a numeric instance. The * value of MUST be a number, * * @generated from field: double maximum = 11; */ maximum: number; /** * @generated from field: bool exclusive_maximum = 12; */ exclusiveMaximum: boolean; /** * minimum represents an inclusive lower limit for a numeric instance. The * value of MUST be a number, * * @generated from field: double minimum = 13; */ minimum: number; /** * @generated from field: bool exclusive_minimum = 14; */ exclusiveMinimum: boolean; /** * @generated from field: uint64 max_length = 15; */ maxLength: bigint; /** * @generated from field: uint64 min_length = 16; */ minLength: bigint; /** * @generated from field: string pattern = 17; */ pattern: string; /** * @generated from field: uint64 max_items = 20; */ maxItems: bigint; /** * @generated from field: uint64 min_items = 21; */ minItems: bigint; /** * @generated from field: bool unique_items = 22; */ uniqueItems: boolean; /** * @generated from field: uint64 max_properties = 24; */ maxProperties: bigint; /** * @generated from field: uint64 min_properties = 25; */ minProperties: bigint; /** * @generated from field: repeated string required = 26; */ required: string[]; /** * Items in 'array' must be unique. * * @generated from field: repeated string array = 34; */ array: string[]; /** * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35; */ type: JSONSchema_JSONSchemaSimpleTypes[]; /** * `Format` * * @generated from field: string format = 36; */ format: string; /** * Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 * * @generated from field: repeated string enum = 46; */ enum: string[]; /** * Additional field level properties used when generating the OpenAPI v2 file. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001; */ fieldConfiguration?: JSONSchema_FieldConfiguration | undefined; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 48; */ extensions: { [key: string]: Value }; }; /** * `JSONSchema` represents properties from JSON Schema taken, and as used, in * the OpenAPI v2 spec. * * This includes changes made by OpenAPI v2. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject * * See also: https://cswr.github.io/JsonSchema/spec/basic_types/, * https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json * * Example: * * message SimpleMessage { * option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { * json_schema: { * title: "SimpleMessage" * description: "A simple message." * required: ["id"] * } * }; * * // Id represents the message identifier. * string id = 1; [ * (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { * description: "The unique identifier of the simple message." * }]; * } * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema */ export type JSONSchemaJson = { /** * Ref is used to define an external reference to include in the message. * This could be a fully qualified proto message reference, and that type must * be imported into the protofile. If no message is identified, the Ref will * be used verbatim in the output. * For example: * `ref: ".google.protobuf.Timestamp"`. * * @generated from field: string ref = 3; */ ref?: string; /** * The title of the schema. * * @generated from field: string title = 5; */ title?: string; /** * A short description of the schema. * * @generated from field: string description = 6; */ description?: string; /** * @generated from field: string default = 7; */ default?: string; /** * @generated from field: bool read_only = 8; */ readOnly?: boolean; /** * A free-form property to include a JSON example of this field. This is copied * verbatim to the output swagger.json. Quotes must be escaped. * 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 * * @generated from field: string example = 9; */ example?: string; /** * @generated from field: double multiple_of = 10; */ multipleOf?: number | "NaN" | "Infinity" | "-Infinity"; /** * Maximum represents an inclusive upper limit for a numeric instance. The * value of MUST be a number, * * @generated from field: double maximum = 11; */ maximum?: number | "NaN" | "Infinity" | "-Infinity"; /** * @generated from field: bool exclusive_maximum = 12; */ exclusiveMaximum?: boolean; /** * minimum represents an inclusive lower limit for a numeric instance. The * value of MUST be a number, * * @generated from field: double minimum = 13; */ minimum?: number | "NaN" | "Infinity" | "-Infinity"; /** * @generated from field: bool exclusive_minimum = 14; */ exclusiveMinimum?: boolean; /** * @generated from field: uint64 max_length = 15; */ maxLength?: string; /** * @generated from field: uint64 min_length = 16; */ minLength?: string; /** * @generated from field: string pattern = 17; */ pattern?: string; /** * @generated from field: uint64 max_items = 20; */ maxItems?: string; /** * @generated from field: uint64 min_items = 21; */ minItems?: string; /** * @generated from field: bool unique_items = 22; */ uniqueItems?: boolean; /** * @generated from field: uint64 max_properties = 24; */ maxProperties?: string; /** * @generated from field: uint64 min_properties = 25; */ minProperties?: string; /** * @generated from field: repeated string required = 26; */ required?: string[]; /** * Items in 'array' must be unique. * * @generated from field: repeated string array = 34; */ array?: string[]; /** * @generated from field: repeated grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35; */ type?: JSONSchema_JSONSchemaSimpleTypesJson[]; /** * `Format` * * @generated from field: string format = 36; */ format?: string; /** * Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 * * @generated from field: repeated string enum = 46; */ enum?: string[]; /** * Additional field level properties used when generating the OpenAPI v2 file. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001; */ fieldConfiguration?: JSONSchema_FieldConfigurationJson; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 48; */ extensions?: { [key: string]: ValueJson }; }; export type JSONSchemaValid = JSONSchema; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema. * Use `create(JSONSchemaSchema)` to create a new message. */ export const JSONSchemaSchema: GenMessage< JSONSchema, { jsonType: JSONSchemaJson; validType: JSONSchemaValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 11); /** * 'FieldConfiguration' provides additional field level properties used when generating the OpenAPI v2 file. * These properties are not defined by OpenAPIv2, but they are used to control the generation. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration */ export type JSONSchema_FieldConfiguration = Message<"grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration"> & { /** * Alternative parameter name when used as path parameter. If set, this will * be used as the complete parameter name when this field is used as a path * parameter. Use this to avoid having auto generated path parameter names * for overlapping paths. * * @generated from field: string path_param_name = 47; */ pathParamName: string; }; /** * 'FieldConfiguration' provides additional field level properties used when generating the OpenAPI v2 file. * These properties are not defined by OpenAPIv2, but they are used to control the generation. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration */ export type JSONSchema_FieldConfigurationJson = { /** * Alternative parameter name when used as path parameter. If set, this will * be used as the complete parameter name when this field is used as a path * parameter. Use this to avoid having auto generated path parameter names * for overlapping paths. * * @generated from field: string path_param_name = 47; */ pathParamName?: string; }; export type JSONSchema_FieldConfigurationValid = JSONSchema_FieldConfiguration; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration. * Use `create(JSONSchema_FieldConfigurationSchema)` to create a new message. */ export const JSONSchema_FieldConfigurationSchema: GenMessage< JSONSchema_FieldConfiguration, { jsonType: JSONSchema_FieldConfigurationJson; validType: JSONSchema_FieldConfigurationValid; } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 11, 0); /** * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes */ export enum JSONSchema_JSONSchemaSimpleTypes { /** * @generated from enum value: UNKNOWN = 0; */ UNKNOWN = 0, /** * @generated from enum value: ARRAY = 1; */ ARRAY = 1, /** * @generated from enum value: BOOLEAN = 2; */ BOOLEAN = 2, /** * @generated from enum value: INTEGER = 3; */ INTEGER = 3, /** * @generated from enum value: NULL = 4; */ NULL = 4, /** * @generated from enum value: NUMBER = 5; */ NUMBER = 5, /** * @generated from enum value: OBJECT = 6; */ OBJECT = 6, /** * @generated from enum value: STRING = 7; */ STRING = 7, } /** * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes */ export type JSONSchema_JSONSchemaSimpleTypesJson = | "UNKNOWN" | "ARRAY" | "BOOLEAN" | "INTEGER" | "NULL" | "NUMBER" | "OBJECT" | "STRING"; /** * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes. */ export const JSONSchema_JSONSchemaSimpleTypesSchema: GenEnum< JSONSchema_JSONSchemaSimpleTypes, JSONSchema_JSONSchemaSimpleTypesJson > = /*@__PURE__*/ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 11, 0); /** * `Tag` is a representation of OpenAPI v2 specification's Tag object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Tag */ export type Tag = Message<"grpc.gateway.protoc_gen_openapiv2.options.Tag"> & { /** * The name of the tag. Use it to allow override of the name of a * global Tag object, then use that name to reference the tag throughout the * OpenAPI file. * * @generated from field: string name = 1; */ name: string; /** * A short description for the tag. GFM syntax can be used for rich text * representation. * * @generated from field: string description = 2; */ description: string; /** * Additional external documentation for this tag. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3; */ externalDocs?: ExternalDocumentation | undefined; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 4; */ extensions: { [key: string]: Value }; }; /** * `Tag` is a representation of OpenAPI v2 specification's Tag object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Tag */ export type TagJson = { /** * The name of the tag. Use it to allow override of the name of a * global Tag object, then use that name to reference the tag throughout the * OpenAPI file. * * @generated from field: string name = 1; */ name?: string; /** * A short description for the tag. GFM syntax can be used for rich text * representation. * * @generated from field: string description = 2; */ description?: string; /** * Additional external documentation for this tag. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3; */ externalDocs?: ExternalDocumentationJson; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 4; */ extensions?: { [key: string]: ValueJson }; }; export type TagValid = Tag; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Tag. * Use `create(TagSchema)` to create a new message. */ export const TagSchema: GenMessage< Tag, { jsonType: TagJson; validType: TagValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 12); /** * `SecurityDefinitions` is a representation of OpenAPI v2 specification's * Security Definitions object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityDefinitionsObject * * A declaration of the security schemes available to be used in the * specification. This does not enforce the security schemes on the operations * and only serves to provide the relevant details for each scheme. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions */ export type SecurityDefinitions = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions"> & { /** * A single security scheme definition, mapping a "name" to the scheme it * defines. * * @generated from field: map security = 1; */ security: { [key: string]: SecurityScheme }; }; /** * `SecurityDefinitions` is a representation of OpenAPI v2 specification's * Security Definitions object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityDefinitionsObject * * A declaration of the security schemes available to be used in the * specification. This does not enforce the security schemes on the operations * and only serves to provide the relevant details for each scheme. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions */ export type SecurityDefinitionsJson = { /** * A single security scheme definition, mapping a "name" to the scheme it * defines. * * @generated from field: map security = 1; */ security?: { [key: string]: SecuritySchemeJson }; }; export type SecurityDefinitionsValid = SecurityDefinitions; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions. * Use `create(SecurityDefinitionsSchema)` to create a new message. */ export const SecurityDefinitionsSchema: GenMessage< SecurityDefinitions, { jsonType: SecurityDefinitionsJson; validType: SecurityDefinitionsValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 13); /** * `SecurityScheme` is a representation of OpenAPI v2 specification's * Security Scheme object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject * * Allows the definition of a security scheme that can be used by the * operations. Supported schemes are basic authentication, an API key (either as * a header or as a query parameter) and OAuth2's common flows (implicit, * password, application and access code). * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme */ export type SecurityScheme = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme"> & { /** * The type of the security scheme. Valid values are "basic", * "apiKey" or "oauth2". * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type type = 1; */ type: SecurityScheme_Type; /** * A short description for security scheme. * * @generated from field: string description = 2; */ description: string; /** * The name of the header or query parameter to be used. * Valid for apiKey. * * @generated from field: string name = 3; */ name: string; /** * The location of the API key. Valid values are "query" or * "header". * Valid for apiKey. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In in = 4; */ in: SecurityScheme_In; /** * The flow used by the OAuth2 security scheme. Valid values are * "implicit", "password", "application" or "accessCode". * Valid for oauth2. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow flow = 5; */ flow: SecurityScheme_Flow; /** * The authorization URL to be used for this flow. This SHOULD be in * the form of a URL. * Valid for oauth2/implicit and oauth2/accessCode. * * @generated from field: string authorization_url = 6; */ authorizationUrl: string; /** * The token URL to be used for this flow. This SHOULD be in the * form of a URL. * Valid for oauth2/password, oauth2/application and oauth2/accessCode. * * @generated from field: string token_url = 7; */ tokenUrl: string; /** * The available scopes for the OAuth2 security scheme. * Valid for oauth2. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8; */ scopes?: Scopes | undefined; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 9; */ extensions: { [key: string]: Value }; }; /** * `SecurityScheme` is a representation of OpenAPI v2 specification's * Security Scheme object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject * * Allows the definition of a security scheme that can be used by the * operations. Supported schemes are basic authentication, an API key (either as * a header or as a query parameter) and OAuth2's common flows (implicit, * password, application and access code). * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme */ export type SecuritySchemeJson = { /** * The type of the security scheme. Valid values are "basic", * "apiKey" or "oauth2". * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type type = 1; */ type?: SecurityScheme_TypeJson; /** * A short description for security scheme. * * @generated from field: string description = 2; */ description?: string; /** * The name of the header or query parameter to be used. * Valid for apiKey. * * @generated from field: string name = 3; */ name?: string; /** * The location of the API key. Valid values are "query" or * "header". * Valid for apiKey. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In in = 4; */ in?: SecurityScheme_InJson; /** * The flow used by the OAuth2 security scheme. Valid values are * "implicit", "password", "application" or "accessCode". * Valid for oauth2. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow flow = 5; */ flow?: SecurityScheme_FlowJson; /** * The authorization URL to be used for this flow. This SHOULD be in * the form of a URL. * Valid for oauth2/implicit and oauth2/accessCode. * * @generated from field: string authorization_url = 6; */ authorizationUrl?: string; /** * The token URL to be used for this flow. This SHOULD be in the * form of a URL. * Valid for oauth2/password, oauth2/application and oauth2/accessCode. * * @generated from field: string token_url = 7; */ tokenUrl?: string; /** * The available scopes for the OAuth2 security scheme. * Valid for oauth2. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8; */ scopes?: ScopesJson; /** * Custom properties that start with "x-" such as "x-foo" used to describe * extra functionality that is not covered by the standard OpenAPI Specification. * See: https://swagger.io/docs/specification/2-0/swagger-extensions/ * * @generated from field: map extensions = 9; */ extensions?: { [key: string]: ValueJson }; }; export type SecuritySchemeValid = SecurityScheme; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme. * Use `create(SecuritySchemeSchema)` to create a new message. */ export const SecuritySchemeSchema: GenMessage< SecurityScheme, { jsonType: SecuritySchemeJson; validType: SecuritySchemeValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 14); /** * The type of the security scheme. Valid values are "basic", * "apiKey" or "oauth2". * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type */ export enum SecurityScheme_Type { /** * @generated from enum value: TYPE_INVALID = 0; */ INVALID = 0, /** * @generated from enum value: TYPE_BASIC = 1; */ BASIC = 1, /** * @generated from enum value: TYPE_API_KEY = 2; */ API_KEY = 2, /** * @generated from enum value: TYPE_OAUTH2 = 3; */ OAUTH2 = 3, } /** * The type of the security scheme. Valid values are "basic", * "apiKey" or "oauth2". * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type */ export type SecurityScheme_TypeJson = "TYPE_INVALID" | "TYPE_BASIC" | "TYPE_API_KEY" | "TYPE_OAUTH2"; /** * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type. */ export const SecurityScheme_TypeSchema: GenEnum< SecurityScheme_Type, SecurityScheme_TypeJson > = /*@__PURE__*/ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 14, 0); /** * The location of the API key. Valid values are "query" or "header". * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In */ export enum SecurityScheme_In { /** * @generated from enum value: IN_INVALID = 0; */ INVALID = 0, /** * @generated from enum value: IN_QUERY = 1; */ QUERY = 1, /** * @generated from enum value: IN_HEADER = 2; */ HEADER = 2, } /** * The location of the API key. Valid values are "query" or "header". * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In */ export type SecurityScheme_InJson = "IN_INVALID" | "IN_QUERY" | "IN_HEADER"; /** * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In. */ export const SecurityScheme_InSchema: GenEnum< SecurityScheme_In, SecurityScheme_InJson > = /*@__PURE__*/ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 14, 1); /** * The flow used by the OAuth2 security scheme. Valid values are * "implicit", "password", "application" or "accessCode". * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow */ export enum SecurityScheme_Flow { /** * @generated from enum value: FLOW_INVALID = 0; */ INVALID = 0, /** * @generated from enum value: FLOW_IMPLICIT = 1; */ IMPLICIT = 1, /** * @generated from enum value: FLOW_PASSWORD = 2; */ PASSWORD = 2, /** * @generated from enum value: FLOW_APPLICATION = 3; */ APPLICATION = 3, /** * @generated from enum value: FLOW_ACCESS_CODE = 4; */ ACCESS_CODE = 4, } /** * The flow used by the OAuth2 security scheme. Valid values are * "implicit", "password", "application" or "accessCode". * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow */ export type SecurityScheme_FlowJson = | "FLOW_INVALID" | "FLOW_IMPLICIT" | "FLOW_PASSWORD" | "FLOW_APPLICATION" | "FLOW_ACCESS_CODE"; /** * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow. */ export const SecurityScheme_FlowSchema: GenEnum< SecurityScheme_Flow, SecurityScheme_FlowJson > = /*@__PURE__*/ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 14, 2); /** * `SecurityRequirement` is a representation of OpenAPI v2 specification's * Security Requirement object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityRequirementObject * * Lists the required security schemes to execute this operation. The object can * have multiple security schemes declared in it which are all required (that * is, there is a logical AND between the schemes). * * The name used for each property MUST correspond to a security scheme * declared in the Security Definitions. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement */ export type SecurityRequirement = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement"> & { /** * Each name must correspond to a security scheme which is declared in * the Security Definitions. If the security scheme is of type "oauth2", * then the value is a list of scope names required for the execution. * For other security scheme types, the array MUST be empty. * * @generated from field: map security_requirement = 1; */ securityRequirement: { [key: string]: SecurityRequirement_SecurityRequirementValue; }; }; /** * `SecurityRequirement` is a representation of OpenAPI v2 specification's * Security Requirement object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityRequirementObject * * Lists the required security schemes to execute this operation. The object can * have multiple security schemes declared in it which are all required (that * is, there is a logical AND between the schemes). * * The name used for each property MUST correspond to a security scheme * declared in the Security Definitions. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement */ export type SecurityRequirementJson = { /** * Each name must correspond to a security scheme which is declared in * the Security Definitions. If the security scheme is of type "oauth2", * then the value is a list of scope names required for the execution. * For other security scheme types, the array MUST be empty. * * @generated from field: map security_requirement = 1; */ securityRequirement?: { [key: string]: SecurityRequirement_SecurityRequirementValueJson; }; }; export type SecurityRequirementValid = SecurityRequirement; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement. * Use `create(SecurityRequirementSchema)` to create a new message. */ export const SecurityRequirementSchema: GenMessage< SecurityRequirement, { jsonType: SecurityRequirementJson; validType: SecurityRequirementValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 15); /** * If the security scheme is of type "oauth2", then the value is a list of * scope names required for the execution. For other security scheme types, * the array MUST be empty. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue */ export type SecurityRequirement_SecurityRequirementValue = Message<"grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue"> & { /** * @generated from field: repeated string scope = 1; */ scope: string[]; }; /** * If the security scheme is of type "oauth2", then the value is a list of * scope names required for the execution. For other security scheme types, * the array MUST be empty. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue */ export type SecurityRequirement_SecurityRequirementValueJson = { /** * @generated from field: repeated string scope = 1; */ scope?: string[]; }; export type SecurityRequirement_SecurityRequirementValueValid = SecurityRequirement_SecurityRequirementValue; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue. * Use `create(SecurityRequirement_SecurityRequirementValueSchema)` to create a new message. */ export const SecurityRequirement_SecurityRequirementValueSchema: GenMessage< SecurityRequirement_SecurityRequirementValue, { jsonType: SecurityRequirement_SecurityRequirementValueJson; validType: SecurityRequirement_SecurityRequirementValueValid; } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 15, 0); /** * `Scopes` is a representation of OpenAPI v2 specification's Scopes object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#scopesObject * * Lists the available scopes for an OAuth2 security scheme. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Scopes */ export type Scopes = Message<"grpc.gateway.protoc_gen_openapiv2.options.Scopes"> & { /** * Maps between a name of a scope to a short description of it (as the value * of the property). * * @generated from field: map scope = 1; */ scope: { [key: string]: string }; }; /** * `Scopes` is a representation of OpenAPI v2 specification's Scopes object. * * See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#scopesObject * * Lists the available scopes for an OAuth2 security scheme. * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Scopes */ export type ScopesJson = { /** * Maps between a name of a scope to a short description of it (as the value * of the property). * * @generated from field: map scope = 1; */ scope?: { [key: string]: string }; }; export type ScopesValid = Scopes; /** * Describes the message grpc.gateway.protoc_gen_openapiv2.options.Scopes. * Use `create(ScopesSchema)` to create a new message. */ export const ScopesSchema: GenMessage< Scopes, { jsonType: ScopesJson; validType: ScopesValid } > = /*@__PURE__*/ messageDesc(file_protoc_gen_openapiv2_options_openapiv2, 16); /** * Scheme describes the schemes supported by the OpenAPI Swagger * and Operation objects. * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.Scheme */ export enum Scheme { /** * @generated from enum value: UNKNOWN = 0; */ UNKNOWN = 0, /** * @generated from enum value: HTTP = 1; */ HTTP = 1, /** * @generated from enum value: HTTPS = 2; */ HTTPS = 2, /** * @generated from enum value: WS = 3; */ WS = 3, /** * @generated from enum value: WSS = 4; */ WSS = 4, } /** * Scheme describes the schemes supported by the OpenAPI Swagger * and Operation objects. * * @generated from enum grpc.gateway.protoc_gen_openapiv2.options.Scheme */ export type SchemeJson = "UNKNOWN" | "HTTP" | "HTTPS" | "WS" | "WSS"; /** * Describes the enum grpc.gateway.protoc_gen_openapiv2.options.Scheme. */ export const SchemeSchema: GenEnum = /*@__PURE__*/ enumDesc(file_protoc_gen_openapiv2_options_openapiv2, 0);