// @generated by protoc-gen-es v1.10.0 with parameter "target=ts" // @generated from file openapiv2.proto (package grpc.gateway.protoc_gen_openapiv2.options, syntax proto3) /* eslint-disable */ // @ts-nocheck import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf"; import { Message, proto3, protoInt64 } from "@bufbuild/protobuf"; import { Value } from "./google/protobuf/struct_pb.js"; /** * 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, } // Retrieve enum metadata with: proto3.getEnumType(Scheme) proto3.util.setEnumType(Scheme, "grpc.gateway.protoc_gen_openapiv2.options.Scheme", [ { no: 0, name: "UNKNOWN" }, { no: 1, name: "HTTP" }, { no: 2, name: "HTTPS" }, { no: 3, name: "WS" }, { no: 4, name: "WSS" }, ]); /** * `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/master/LICENSE.txt"; * }; * }; * schemes: HTTPS; * consumes: "application/json"; * produces: "application/json"; * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Swagger */ export class Swagger extends Message { /** * 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 = ""; /** * 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; /** * 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 = ""; /** * 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 = ""; /** * 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; /** * 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[] = []; /** * Additional external documentation. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14; */ externalDocs?: ExternalDocumentation; /** * @generated from field: map extensions = 15; */ extensions: { [key: string]: Value } = {}; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.Swagger"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "swagger", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "info", kind: "message", T: Info }, { no: 3, name: "host", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 4, name: "base_path", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 5, name: "schemes", kind: "enum", T: proto3.getEnumType(Scheme), repeated: true }, { no: 6, name: "consumes", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, { no: 7, name: "produces", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, { no: 10, name: "responses", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: Response} }, { no: 11, name: "security_definitions", kind: "message", T: SecurityDefinitions }, { no: 12, name: "security", kind: "message", T: SecurityRequirement, repeated: true }, { no: 14, name: "external_docs", kind: "message", T: ExternalDocumentation }, { no: 15, name: "extensions", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: Value} }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Swagger { return new Swagger().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Swagger { return new Swagger().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Swagger { return new Swagger().fromJsonString(jsonString, options); } static equals(a: Swagger | PlainMessage | undefined, b: Swagger | PlainMessage | undefined): boolean { return proto3.util.equals(Swagger, a, b); } } /** * `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 class Operation extends Message { /** * 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 = ""; /** * A verbose explanation of the operation behavior. GFM syntax can be used for * rich text representation. * * @generated from field: string description = 3; */ description = ""; /** * Additional external documentation for this operation. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 4; */ externalDocs?: ExternalDocumentation; /** * 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 = ""; /** * 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 = false; /** * 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[] = []; /** * @generated from field: map extensions = 13; */ extensions: { [key: string]: Value } = {}; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.Operation"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "tags", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, { no: 2, name: "summary", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 3, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 4, name: "external_docs", kind: "message", T: ExternalDocumentation }, { no: 5, name: "operation_id", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 6, name: "consumes", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, { no: 7, name: "produces", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, { no: 9, name: "responses", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: Response} }, { no: 10, name: "schemes", kind: "enum", T: proto3.getEnumType(Scheme), repeated: true }, { no: 11, name: "deprecated", kind: "scalar", T: 8 /* ScalarType.BOOL */ }, { no: 12, name: "security", kind: "message", T: SecurityRequirement, repeated: true }, { no: 13, name: "extensions", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: Value} }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Operation { return new Operation().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Operation { return new Operation().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Operation { return new Operation().fromJsonString(jsonString, options); } static equals(a: Operation | PlainMessage | undefined, b: Operation | PlainMessage | undefined): boolean { return proto3.util.equals(Operation, a, b); } } /** * `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 class Header extends Message
{ /** * `Description` is a short description of the header. * * @generated from field: string description = 1; */ description = ""; /** * 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 = ""; /** * `Format` The extending format for the previously mentioned type. * * @generated from field: string format = 3; */ format = ""; /** * `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 = ""; /** * 'Pattern' See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. * * @generated from field: string pattern = 13; */ pattern = ""; constructor(data?: PartialMessage
) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.Header"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "type", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 3, name: "format", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 6, name: "default", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 13, name: "pattern", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Header { return new Header().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Header { return new Header().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Header { return new Header().fromJsonString(jsonString, options); } static equals(a: Header | PlainMessage
| undefined, b: Header | PlainMessage
| undefined): boolean { return proto3.util.equals(Header, a, b); } } /** * `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 class Response extends Message { /** * `Description` is a short description of the response. * GFM syntax can be used for rich text representation. * * @generated from field: string description = 1; */ description = ""; /** * `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; /** * `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 } = {}; /** * @generated from field: map extensions = 5; */ extensions: { [key: string]: Value } = {}; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.Response"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "schema", kind: "message", T: Schema }, { no: 3, name: "headers", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: Header} }, { no: 4, name: "examples", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "scalar", T: 9 /* ScalarType.STRING */} }, { no: 5, name: "extensions", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: Value} }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Response { return new Response().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Response { return new Response().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Response { return new Response().fromJsonString(jsonString, options); } static equals(a: Response | PlainMessage | undefined, b: Response | PlainMessage | undefined): boolean { return proto3.util.equals(Response, a, b); } } /** * `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/master/LICENSE.txt"; * }; * }; * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.Info */ export class Info extends Message { /** * The title of the application. * * @generated from field: string title = 1; */ title = ""; /** * A short description of the application. GFM syntax can be used for rich * text representation. * * @generated from field: string description = 2; */ description = ""; /** * The Terms of Service for the API. * * @generated from field: string terms_of_service = 3; */ termsOfService = ""; /** * The contact information for the exposed API. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4; */ contact?: Contact; /** * The license information for the exposed API. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.License license = 5; */ license?: License; /** * Provides the version of the application API (not to be confused * with the specification version). * * @generated from field: string version = 6; */ version = ""; /** * @generated from field: map extensions = 7; */ extensions: { [key: string]: Value } = {}; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.Info"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "title", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 3, name: "terms_of_service", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 4, name: "contact", kind: "message", T: Contact }, { no: 5, name: "license", kind: "message", T: License }, { no: 6, name: "version", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 7, name: "extensions", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: Value} }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Info { return new Info().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Info { return new Info().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Info { return new Info().fromJsonString(jsonString, options); } static equals(a: Info | PlainMessage | undefined, b: Info | PlainMessage | undefined): boolean { return proto3.util.equals(Info, a, b); } } /** * `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 class Contact extends Message { /** * The identifying name of the contact person/organization. * * @generated from field: string name = 1; */ name = ""; /** * The URL pointing to the contact information. MUST be in the format of a * URL. * * @generated from field: string url = 2; */ url = ""; /** * The email address of the contact person/organization. MUST be in the format * of an email address. * * @generated from field: string email = 3; */ email = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.Contact"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "url", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 3, name: "email", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Contact { return new Contact().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Contact { return new Contact().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Contact { return new Contact().fromJsonString(jsonString, options); } static equals(a: Contact | PlainMessage | undefined, b: Contact | PlainMessage | undefined): boolean { return proto3.util.equals(Contact, a, b); } } /** * `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/master/LICENSE.txt"; * }; * ... * }; * ... * }; * * * @generated from message grpc.gateway.protoc_gen_openapiv2.options.License */ export class License extends Message { /** * The license name used for the API. * * @generated from field: string name = 1; */ name = ""; /** * A URL to the license used for the API. MUST be in the format of a URL. * * @generated from field: string url = 2; */ url = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.License"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "url", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): License { return new License().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): License { return new License().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): License { return new License().fromJsonString(jsonString, options); } static equals(a: License | PlainMessage | undefined, b: License | PlainMessage | undefined): boolean { return proto3.util.equals(License, a, b); } } /** * `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 class ExternalDocumentation extends Message { /** * A short description of the target documentation. GFM syntax can be used for * rich text representation. * * @generated from field: string description = 1; */ description = ""; /** * The URL for the target documentation. Value MUST be in the format * of a URL. * * @generated from field: string url = 2; */ url = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 2, name: "url", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): ExternalDocumentation { return new ExternalDocumentation().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): ExternalDocumentation { return new ExternalDocumentation().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): ExternalDocumentation { return new ExternalDocumentation().fromJsonString(jsonString, options); } static equals(a: ExternalDocumentation | PlainMessage | undefined, b: ExternalDocumentation | PlainMessage | undefined): boolean { return proto3.util.equals(ExternalDocumentation, a, b); } } /** * `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 class Schema extends Message { /** * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1; */ jsonSchema?: JSONSchema; /** * 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 = ""; /** * 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 = false; /** * Additional external documentation for this schema. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5; */ externalDocs?: ExternalDocumentation; /** * 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 = ""; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.Schema"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "json_schema", kind: "message", T: JSONSchema }, { no: 2, name: "discriminator", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 3, name: "read_only", kind: "scalar", T: 8 /* ScalarType.BOOL */ }, { no: 5, name: "external_docs", kind: "message", T: ExternalDocumentation }, { no: 6, name: "example", kind: "scalar", T: 9 /* ScalarType.STRING */ }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Schema { return new Schema().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Schema { return new Schema().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Schema { return new Schema().fromJsonString(jsonString, options); } static equals(a: Schema | PlainMessage | undefined, b: Schema | PlainMessage | undefined): boolean { return proto3.util.equals(Schema, a, b); } } /** * `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; [ * The unique identifier of the simple message. * (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 class JSONSchema extends Message { /** * 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 = ""; /** * The title of the schema. * * @generated from field: string title = 5; */ title = ""; /** * A short description of the schema. * * @generated from field: string description = 6; */ description = ""; /** * @generated from field: string default = 7; */ default = ""; /** * @generated from field: bool read_only = 8; */ readOnly = false; /** * 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 = ""; /** * @generated from field: double multiple_of = 10; */ multipleOf = 0; /** * Maximum represents an inclusive upper limit for a numeric instance. The * value of MUST be a number, * * @generated from field: double maximum = 11; */ maximum = 0; /** * @generated from field: bool exclusive_maximum = 12; */ exclusiveMaximum = false; /** * minimum represents an inclusive lower limit for a numeric instance. The * value of MUST be a number, * * @generated from field: double minimum = 13; */ minimum = 0; /** * @generated from field: bool exclusive_minimum = 14; */ exclusiveMinimum = false; /** * @generated from field: uint64 max_length = 15; */ maxLength = protoInt64.zero; /** * @generated from field: uint64 min_length = 16; */ minLength = protoInt64.zero; /** * @generated from field: string pattern = 17; */ pattern = ""; /** * @generated from field: uint64 max_items = 20; */ maxItems = protoInt64.zero; /** * @generated from field: uint64 min_items = 21; */ minItems = protoInt64.zero; /** * @generated from field: bool unique_items = 22; */ uniqueItems = false; /** * @generated from field: uint64 max_properties = 24; */ maxProperties = protoInt64.zero; /** * @generated from field: uint64 min_properties = 25; */ minProperties = protoInt64.zero; /** * @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 = ""; /** * 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[] = []; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.JSONSchema"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 3, name: "ref", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 5, name: "title", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 6, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 7, name: "default", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 8, name: "read_only", kind: "scalar", T: 8 /* ScalarType.BOOL */ }, { no: 9, name: "example", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 10, name: "multiple_of", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ }, { no: 11, name: "maximum", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ }, { no: 12, name: "exclusive_maximum", kind: "scalar", T: 8 /* ScalarType.BOOL */ }, { no: 13, name: "minimum", kind: "scalar", T: 1 /* ScalarType.DOUBLE */ }, { no: 14, name: "exclusive_minimum", kind: "scalar", T: 8 /* ScalarType.BOOL */ }, { no: 15, name: "max_length", kind: "scalar", T: 4 /* ScalarType.UINT64 */ }, { no: 16, name: "min_length", kind: "scalar", T: 4 /* ScalarType.UINT64 */ }, { no: 17, name: "pattern", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 20, name: "max_items", kind: "scalar", T: 4 /* ScalarType.UINT64 */ }, { no: 21, name: "min_items", kind: "scalar", T: 4 /* ScalarType.UINT64 */ }, { no: 22, name: "unique_items", kind: "scalar", T: 8 /* ScalarType.BOOL */ }, { no: 24, name: "max_properties", kind: "scalar", T: 4 /* ScalarType.UINT64 */ }, { no: 25, name: "min_properties", kind: "scalar", T: 4 /* ScalarType.UINT64 */ }, { no: 26, name: "required", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, { no: 34, name: "array", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, { no: 35, name: "type", kind: "enum", T: proto3.getEnumType(JSONSchema_JSONSchemaSimpleTypes), repeated: true }, { no: 36, name: "format", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 46, name: "enum", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): JSONSchema { return new JSONSchema().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): JSONSchema { return new JSONSchema().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): JSONSchema { return new JSONSchema().fromJsonString(jsonString, options); } static equals(a: JSONSchema | PlainMessage | undefined, b: JSONSchema | PlainMessage | undefined): boolean { return proto3.util.equals(JSONSchema, a, b); } } /** * @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, } // Retrieve enum metadata with: proto3.getEnumType(JSONSchema_JSONSchemaSimpleTypes) proto3.util.setEnumType(JSONSchema_JSONSchemaSimpleTypes, "grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes", [ { no: 0, name: "UNKNOWN" }, { no: 1, name: "ARRAY" }, { no: 2, name: "BOOLEAN" }, { no: 3, name: "INTEGER" }, { no: 4, name: "NULL" }, { no: 5, name: "NUMBER" }, { no: 6, name: "OBJECT" }, { no: 7, name: "STRING" }, ]); /** * `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 class Tag extends Message { /** * A short description for the tag. GFM syntax can be used for rich text * representation. * * @generated from field: string description = 2; */ description = ""; /** * Additional external documentation for this tag. * * @generated from field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3; */ externalDocs?: ExternalDocumentation; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.Tag"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 2, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 3, name: "external_docs", kind: "message", T: ExternalDocumentation }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Tag { return new Tag().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Tag { return new Tag().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Tag { return new Tag().fromJsonString(jsonString, options); } static equals(a: Tag | PlainMessage | undefined, b: Tag | PlainMessage | undefined): boolean { return proto3.util.equals(Tag, a, b); } } /** * `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 class SecurityDefinitions extends Message { /** * A single security scheme definition, mapping a "name" to the scheme it * defines. * * @generated from field: map security = 1; */ security: { [key: string]: SecurityScheme } = {}; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "security", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: SecurityScheme} }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): SecurityDefinitions { return new SecurityDefinitions().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): SecurityDefinitions { return new SecurityDefinitions().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): SecurityDefinitions { return new SecurityDefinitions().fromJsonString(jsonString, options); } static equals(a: SecurityDefinitions | PlainMessage | undefined, b: SecurityDefinitions | PlainMessage | undefined): boolean { return proto3.util.equals(SecurityDefinitions, a, b); } } /** * `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 class SecurityScheme extends Message { /** * 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.INVALID; /** * A short description for security scheme. * * @generated from field: string description = 2; */ description = ""; /** * The name of the header or query parameter to be used. * Valid for apiKey. * * @generated from field: string name = 3; */ name = ""; /** * 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.INVALID; /** * 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.INVALID; /** * 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 = ""; /** * 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 = ""; /** * 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; /** * @generated from field: map extensions = 9; */ extensions: { [key: string]: Value } = {}; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "type", kind: "enum", T: proto3.getEnumType(SecurityScheme_Type) }, { no: 2, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 3, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 4, name: "in", kind: "enum", T: proto3.getEnumType(SecurityScheme_In) }, { no: 5, name: "flow", kind: "enum", T: proto3.getEnumType(SecurityScheme_Flow) }, { no: 6, name: "authorization_url", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 7, name: "token_url", kind: "scalar", T: 9 /* ScalarType.STRING */ }, { no: 8, name: "scopes", kind: "message", T: Scopes }, { no: 9, name: "extensions", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: Value} }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): SecurityScheme { return new SecurityScheme().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): SecurityScheme { return new SecurityScheme().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): SecurityScheme { return new SecurityScheme().fromJsonString(jsonString, options); } static equals(a: SecurityScheme | PlainMessage | undefined, b: SecurityScheme | PlainMessage | undefined): boolean { return proto3.util.equals(SecurityScheme, a, b); } } /** * 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, } // Retrieve enum metadata with: proto3.getEnumType(SecurityScheme_Type) proto3.util.setEnumType(SecurityScheme_Type, "grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type", [ { no: 0, name: "TYPE_INVALID" }, { no: 1, name: "TYPE_BASIC" }, { no: 2, name: "TYPE_API_KEY" }, { no: 3, name: "TYPE_OAUTH2" }, ]); /** * 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, } // Retrieve enum metadata with: proto3.getEnumType(SecurityScheme_In) proto3.util.setEnumType(SecurityScheme_In, "grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In", [ { no: 0, name: "IN_INVALID" }, { no: 1, name: "IN_QUERY" }, { no: 2, name: "IN_HEADER" }, ]); /** * 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, } // Retrieve enum metadata with: proto3.getEnumType(SecurityScheme_Flow) proto3.util.setEnumType(SecurityScheme_Flow, "grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Flow", [ { no: 0, name: "FLOW_INVALID" }, { no: 1, name: "FLOW_IMPLICIT" }, { no: 2, name: "FLOW_PASSWORD" }, { no: 3, name: "FLOW_APPLICATION" }, { no: 4, name: "FLOW_ACCESS_CODE" }, ]); /** * `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 class SecurityRequirement extends Message { /** * 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 } = {}; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "security_requirement", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "message", T: SecurityRequirement_SecurityRequirementValue} }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): SecurityRequirement { return new SecurityRequirement().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): SecurityRequirement { return new SecurityRequirement().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): SecurityRequirement { return new SecurityRequirement().fromJsonString(jsonString, options); } static equals(a: SecurityRequirement | PlainMessage | undefined, b: SecurityRequirement | PlainMessage | undefined): boolean { return proto3.util.equals(SecurityRequirement, a, b); } } /** * 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 class SecurityRequirement_SecurityRequirementValue extends Message { /** * @generated from field: repeated string scope = 1; */ scope: string[] = []; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement.SecurityRequirementValue"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "scope", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): SecurityRequirement_SecurityRequirementValue { return new SecurityRequirement_SecurityRequirementValue().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): SecurityRequirement_SecurityRequirementValue { return new SecurityRequirement_SecurityRequirementValue().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): SecurityRequirement_SecurityRequirementValue { return new SecurityRequirement_SecurityRequirementValue().fromJsonString(jsonString, options); } static equals(a: SecurityRequirement_SecurityRequirementValue | PlainMessage | undefined, b: SecurityRequirement_SecurityRequirementValue | PlainMessage | undefined): boolean { return proto3.util.equals(SecurityRequirement_SecurityRequirementValue, a, b); } } /** * `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 class Scopes extends Message { /** * 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 } = {}; constructor(data?: PartialMessage) { super(); proto3.util.initPartial(data, this); } static readonly runtime: typeof proto3 = proto3; static readonly typeName = "grpc.gateway.protoc_gen_openapiv2.options.Scopes"; static readonly fields: FieldList = proto3.util.newFieldList(() => [ { no: 1, name: "scope", kind: "map", K: 9 /* ScalarType.STRING */, V: {kind: "scalar", T: 9 /* ScalarType.STRING */} }, ]); static fromBinary(bytes: Uint8Array, options?: Partial): Scopes { return new Scopes().fromBinary(bytes, options); } static fromJson(jsonValue: JsonValue, options?: Partial): Scopes { return new Scopes().fromJson(jsonValue, options); } static fromJsonString(jsonString: string, options?: Partial): Scopes { return new Scopes().fromJsonString(jsonString, options); } static equals(a: Scopes | PlainMessage | undefined, b: Scopes | PlainMessage | undefined): boolean { return proto3.util.equals(Scopes, a, b); } }