Latest generation

This commit is contained in:
ci core model
2026-01-15 15:44:24 +00:00
parent 4eeff8f0fa
commit 1381e013ae
17 changed files with 344 additions and 2358 deletions

View File

@@ -30,7 +30,7 @@ import { Value } from "./google/protobuf/struct";
* };
* license: {
* name: "BSD 3-Clause License";
* url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
* url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
* };
* };
* schemes: HTTPS;
@@ -278,99 +278,6 @@ export interface Operation {
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 protobuf field: grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14
*/
parameters?: Parameters;
}
/**
* `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 protobuf message grpc.gateway.protoc_gen_openapiv2.options.Parameters
*/
export interface Parameters {
/**
* `Headers` is one or more HTTP header parameter.
* See: https://swagger.io/docs/specification/2-0/describing-parameters/#header-parameters
*
* @generated from protobuf field: repeated grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1
*/
headers: HeaderParameter[];
}
/**
* `HeaderParameter` a HTTP header parameter.
* See: https://swagger.io/specification/v2/#parameter-object
*
* @generated from protobuf message grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter
*/
export interface HeaderParameter {
/**
* `Name` is the header name.
*
* @generated from protobuf field: string name = 1
*/
name: string;
/**
* `Description` is a short description of the header.
*
* @generated from protobuf 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 protobuf 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 protobuf field: string format = 4
*/
format: string;
/**
* `Required` indicates if the header is optional
*
* @generated from protobuf field: bool required = 5
*/
required: boolean;
}
/**
* `Type` is a supported HTTP header type.
* See https://swagger.io/specification/v2/#parameterType.
*
* @generated from protobuf enum grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type
*/
export enum HeaderParameter_Type {
/**
* @generated from protobuf enum value: UNKNOWN = 0;
*/
UNKNOWN = 0,
/**
* @generated from protobuf enum value: STRING = 1;
*/
STRING = 1,
/**
* @generated from protobuf enum value: NUMBER = 2;
*/
NUMBER = 2,
/**
* @generated from protobuf enum value: INTEGER = 3;
*/
INTEGER = 3,
/**
* @generated from protobuf enum value: BOOLEAN = 4;
*/
BOOLEAN = 4
}
/**
* `Header` is a representation of OpenAPI v2 specification's Header object.
@@ -486,7 +393,7 @@ export interface Response {
* };
* license: {
* name: "BSD 3-Clause License";
* url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
* url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
* };
* };
* ...
@@ -602,7 +509,7 @@ export interface Contact {
* ...
* license: {
* name: "BSD 3-Clause License";
* url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
* url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
* };
* ...
* };
@@ -709,82 +616,6 @@ export interface Schema {
*/
example: string;
}
/**
* `EnumSchema` is subset of fields from the OpenAPI v2 specification's Schema object.
* Only fields that are applicable to Enums are included
* See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
*
* Example:
*
* option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_enum) = {
* ...
* title: "MyEnum";
* description:"This is my nice enum";
* example: "ZERO";
* required: true;
* ...
* };
*
*
* @generated from protobuf message grpc.gateway.protoc_gen_openapiv2.options.EnumSchema
*/
export interface EnumSchema {
/**
* A short description of the schema.
*
* @generated from protobuf field: string description = 1
*/
description: string;
/**
* @generated from protobuf field: string default = 2
*/
default: string;
/**
* The title of the schema.
*
* @generated from protobuf field: string title = 3
*/
title: string;
/**
* @generated from protobuf field: bool required = 4
*/
required: boolean;
/**
* @generated from protobuf field: bool read_only = 5
*/
read_only: boolean;
/**
* Additional external documentation for this schema.
*
* @generated from protobuf field: grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 6
*/
external_docs?: ExternalDocumentation;
/**
* @generated from protobuf field: string example = 7
*/
example: string;
/**
* 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 protobuf field: string ref = 8
*/
ref: 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 protobuf field: map<string, google.protobuf.Value> extensions = 9
*/
extensions: {
[key: string]: Value;
};
}
/**
* `JSONSchema` represents properties from JSON Schema taken, and as used, in
* the OpenAPI v2 spec.
@@ -974,13 +805,6 @@ export interface JSONSchema_FieldConfiguration {
* @generated from protobuf field: string path_param_name = 47
*/
path_param_name: string;
/**
* Declares this field to be deprecated. Allows for the generated OpenAPI
* parameter to be marked as deprecated without affecting the proto field.
*
* @generated from protobuf field: bool deprecated = 49
*/
deprecated: boolean;
}
/**
* @generated from protobuf enum grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes
@@ -1530,8 +1354,7 @@ class Operation$Type extends MessageType<Operation> {
{ no: 10, name: "schemes", kind: "enum", repeat: 1 /*RepeatType.PACKED*/, T: () => ["grpc.gateway.protoc_gen_openapiv2.options.Scheme", Scheme] },
{ no: 11, name: "deprecated", kind: "scalar", T: 8 /*ScalarType.BOOL*/ },
{ no: 12, name: "security", kind: "message", repeat: 2 /*RepeatType.UNPACKED*/, T: () => SecurityRequirement },
{ no: 13, name: "extensions", kind: "map", K: 9 /*ScalarType.STRING*/, V: { kind: "message", T: () => Value } },
{ no: 14, name: "parameters", kind: "message", T: () => Parameters }
{ no: 13, name: "extensions", kind: "map", K: 9 /*ScalarType.STRING*/, V: { kind: "message", T: () => Value } }
]);
}
create(value?: PartialMessage<Operation>): Operation {
@@ -1596,9 +1419,6 @@ class Operation$Type extends MessageType<Operation> {
case /* map<string, google.protobuf.Value> extensions */ 13:
this.binaryReadMap13(message.extensions, reader, options);
break;
case /* grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters */ 14:
message.parameters = Parameters.internalBinaryRead(reader, reader.uint32(), options, message.parameters);
break;
default:
let u = options.readUnknownField;
if (u === "throw")
@@ -1691,9 +1511,6 @@ class Operation$Type extends MessageType<Operation> {
Value.internalBinaryWrite(message.extensions[k], writer, options);
writer.join().join();
}
/* grpc.gateway.protoc_gen_openapiv2.options.Parameters parameters = 14; */
if (message.parameters)
Parameters.internalBinaryWrite(message.parameters, writer.tag(14, WireType.LengthDelimited).fork(), options).join();
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
@@ -1705,132 +1522,6 @@ class Operation$Type extends MessageType<Operation> {
*/
export const Operation = new Operation$Type();
// @generated message type with reflection information, may provide speed optimized methods
class Parameters$Type extends MessageType<Parameters> {
constructor() {
super("grpc.gateway.protoc_gen_openapiv2.options.Parameters", [
{ no: 1, name: "headers", kind: "message", repeat: 2 /*RepeatType.UNPACKED*/, T: () => HeaderParameter }
]);
}
create(value?: PartialMessage<Parameters>): Parameters {
const message = globalThis.Object.create((this.messagePrototype!));
message.headers = [];
if (value !== undefined)
reflectionMergePartial<Parameters>(this, message, value);
return message;
}
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Parameters): Parameters {
let message = target ?? this.create(), end = reader.pos + length;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
case /* repeated grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers */ 1:
message.headers.push(HeaderParameter.internalBinaryRead(reader, reader.uint32(), options));
break;
default:
let u = options.readUnknownField;
if (u === "throw")
throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
let d = reader.skip(wireType);
if (u !== false)
(u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
}
}
return message;
}
internalBinaryWrite(message: Parameters, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
/* repeated grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter headers = 1; */
for (let i = 0; i < message.headers.length; i++)
HeaderParameter.internalBinaryWrite(message.headers[i], writer.tag(1, WireType.LengthDelimited).fork(), options).join();
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
return writer;
}
}
/**
* @generated MessageType for protobuf message grpc.gateway.protoc_gen_openapiv2.options.Parameters
*/
export const Parameters = new Parameters$Type();
// @generated message type with reflection information, may provide speed optimized methods
class HeaderParameter$Type extends MessageType<HeaderParameter> {
constructor() {
super("grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter", [
{ no: 1, name: "name", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
{ no: 2, name: "description", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
{ no: 3, name: "type", kind: "enum", T: () => ["grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type", HeaderParameter_Type] },
{ no: 4, name: "format", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
{ no: 5, name: "required", kind: "scalar", T: 8 /*ScalarType.BOOL*/ }
]);
}
create(value?: PartialMessage<HeaderParameter>): HeaderParameter {
const message = globalThis.Object.create((this.messagePrototype!));
message.name = "";
message.description = "";
message.type = 0;
message.format = "";
message.required = false;
if (value !== undefined)
reflectionMergePartial<HeaderParameter>(this, message, value);
return message;
}
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: HeaderParameter): HeaderParameter {
let message = target ?? this.create(), end = reader.pos + length;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
case /* string name */ 1:
message.name = reader.string();
break;
case /* string description */ 2:
message.description = reader.string();
break;
case /* grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type */ 3:
message.type = reader.int32();
break;
case /* string format */ 4:
message.format = reader.string();
break;
case /* bool required */ 5:
message.required = reader.bool();
break;
default:
let u = options.readUnknownField;
if (u === "throw")
throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
let d = reader.skip(wireType);
if (u !== false)
(u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
}
}
return message;
}
internalBinaryWrite(message: HeaderParameter, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
/* string name = 1; */
if (message.name !== "")
writer.tag(1, WireType.LengthDelimited).string(message.name);
/* string description = 2; */
if (message.description !== "")
writer.tag(2, WireType.LengthDelimited).string(message.description);
/* grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter.Type type = 3; */
if (message.type !== 0)
writer.tag(3, WireType.Varint).int32(message.type);
/* string format = 4; */
if (message.format !== "")
writer.tag(4, WireType.LengthDelimited).string(message.format);
/* bool required = 5; */
if (message.required !== false)
writer.tag(5, WireType.Varint).bool(message.required);
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
return writer;
}
}
/**
* @generated MessageType for protobuf message grpc.gateway.protoc_gen_openapiv2.options.HeaderParameter
*/
export const HeaderParameter = new HeaderParameter$Type();
// @generated message type with reflection information, may provide speed optimized methods
class Header$Type extends MessageType<Header> {
constructor() {
super("grpc.gateway.protoc_gen_openapiv2.options.Header", [
@@ -2407,136 +2098,6 @@ class Schema$Type extends MessageType<Schema> {
*/
export const Schema = new Schema$Type();
// @generated message type with reflection information, may provide speed optimized methods
class EnumSchema$Type extends MessageType<EnumSchema> {
constructor() {
super("grpc.gateway.protoc_gen_openapiv2.options.EnumSchema", [
{ no: 1, name: "description", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
{ no: 2, name: "default", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
{ no: 3, name: "title", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
{ no: 4, name: "required", kind: "scalar", T: 8 /*ScalarType.BOOL*/ },
{ no: 5, name: "read_only", kind: "scalar", localName: "read_only", T: 8 /*ScalarType.BOOL*/ },
{ no: 6, name: "external_docs", kind: "message", localName: "external_docs", T: () => ExternalDocumentation },
{ no: 7, name: "example", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
{ no: 8, name: "ref", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
{ no: 9, name: "extensions", kind: "map", K: 9 /*ScalarType.STRING*/, V: { kind: "message", T: () => Value } }
]);
}
create(value?: PartialMessage<EnumSchema>): EnumSchema {
const message = globalThis.Object.create((this.messagePrototype!));
message.description = "";
message.default = "";
message.title = "";
message.required = false;
message.read_only = false;
message.example = "";
message.ref = "";
message.extensions = {};
if (value !== undefined)
reflectionMergePartial<EnumSchema>(this, message, value);
return message;
}
internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: EnumSchema): EnumSchema {
let message = target ?? this.create(), end = reader.pos + length;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
case /* string description */ 1:
message.description = reader.string();
break;
case /* string default */ 2:
message.default = reader.string();
break;
case /* string title */ 3:
message.title = reader.string();
break;
case /* bool required */ 4:
message.required = reader.bool();
break;
case /* bool read_only */ 5:
message.read_only = reader.bool();
break;
case /* grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs */ 6:
message.external_docs = ExternalDocumentation.internalBinaryRead(reader, reader.uint32(), options, message.external_docs);
break;
case /* string example */ 7:
message.example = reader.string();
break;
case /* string ref */ 8:
message.ref = reader.string();
break;
case /* map<string, google.protobuf.Value> extensions */ 9:
this.binaryReadMap9(message.extensions, reader, options);
break;
default:
let u = options.readUnknownField;
if (u === "throw")
throw new globalThis.Error(`Unknown field ${fieldNo} (wire type ${wireType}) for ${this.typeName}`);
let d = reader.skip(wireType);
if (u !== false)
(u === true ? UnknownFieldHandler.onRead : u)(this.typeName, message, fieldNo, wireType, d);
}
}
return message;
}
private binaryReadMap9(map: EnumSchema["extensions"], reader: IBinaryReader, options: BinaryReadOptions): void {
let len = reader.uint32(), end = reader.pos + len, key: keyof EnumSchema["extensions"] | undefined, val: EnumSchema["extensions"][any] | undefined;
while (reader.pos < end) {
let [fieldNo, wireType] = reader.tag();
switch (fieldNo) {
case 1:
key = reader.string();
break;
case 2:
val = Value.internalBinaryRead(reader, reader.uint32(), options);
break;
default: throw new globalThis.Error("unknown map entry field for grpc.gateway.protoc_gen_openapiv2.options.EnumSchema.extensions");
}
}
map[key ?? ""] = val ?? Value.create();
}
internalBinaryWrite(message: EnumSchema, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter {
/* string description = 1; */
if (message.description !== "")
writer.tag(1, WireType.LengthDelimited).string(message.description);
/* string default = 2; */
if (message.default !== "")
writer.tag(2, WireType.LengthDelimited).string(message.default);
/* string title = 3; */
if (message.title !== "")
writer.tag(3, WireType.LengthDelimited).string(message.title);
/* bool required = 4; */
if (message.required !== false)
writer.tag(4, WireType.Varint).bool(message.required);
/* bool read_only = 5; */
if (message.read_only !== false)
writer.tag(5, WireType.Varint).bool(message.read_only);
/* grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 6; */
if (message.external_docs)
ExternalDocumentation.internalBinaryWrite(message.external_docs, writer.tag(6, WireType.LengthDelimited).fork(), options).join();
/* string example = 7; */
if (message.example !== "")
writer.tag(7, WireType.LengthDelimited).string(message.example);
/* string ref = 8; */
if (message.ref !== "")
writer.tag(8, WireType.LengthDelimited).string(message.ref);
/* map<string, google.protobuf.Value> extensions = 9; */
for (let k of globalThis.Object.keys(message.extensions)) {
writer.tag(9, WireType.LengthDelimited).fork().tag(1, WireType.LengthDelimited).string(k);
writer.tag(2, WireType.LengthDelimited).fork();
Value.internalBinaryWrite(message.extensions[k], writer, options);
writer.join().join();
}
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);
return writer;
}
}
/**
* @generated MessageType for protobuf message grpc.gateway.protoc_gen_openapiv2.options.EnumSchema
*/
export const EnumSchema = new EnumSchema$Type();
// @generated message type with reflection information, may provide speed optimized methods
class JSONSchema$Type extends MessageType<JSONSchema> {
constructor() {
super("grpc.gateway.protoc_gen_openapiv2.options.JSONSchema", [
@@ -2814,14 +2375,12 @@ export const JSONSchema = new JSONSchema$Type();
class JSONSchema_FieldConfiguration$Type extends MessageType<JSONSchema_FieldConfiguration> {
constructor() {
super("grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration", [
{ no: 47, name: "path_param_name", kind: "scalar", localName: "path_param_name", T: 9 /*ScalarType.STRING*/ },
{ no: 49, name: "deprecated", kind: "scalar", T: 8 /*ScalarType.BOOL*/ }
{ no: 47, name: "path_param_name", kind: "scalar", localName: "path_param_name", T: 9 /*ScalarType.STRING*/ }
]);
}
create(value?: PartialMessage<JSONSchema_FieldConfiguration>): JSONSchema_FieldConfiguration {
const message = globalThis.Object.create((this.messagePrototype!));
message.path_param_name = "";
message.deprecated = false;
if (value !== undefined)
reflectionMergePartial<JSONSchema_FieldConfiguration>(this, message, value);
return message;
@@ -2834,9 +2393,6 @@ class JSONSchema_FieldConfiguration$Type extends MessageType<JSONSchema_FieldCon
case /* string path_param_name */ 47:
message.path_param_name = reader.string();
break;
case /* bool deprecated */ 49:
message.deprecated = reader.bool();
break;
default:
let u = options.readUnknownField;
if (u === "throw")
@@ -2852,9 +2408,6 @@ class JSONSchema_FieldConfiguration$Type extends MessageType<JSONSchema_FieldCon
/* string path_param_name = 47; */
if (message.path_param_name !== "")
writer.tag(47, WireType.LengthDelimited).string(message.path_param_name);
/* bool deprecated = 49; */
if (message.deprecated !== false)
writer.tag(49, WireType.Varint).bool(message.deprecated);
let u = options.writeUnknownFields;
if (u !== false)
(u == true ? UnknownFieldHandler.onWrite : u)(this.typeName, message, writer);