Skip to main content

Interface: $Properties

Properties of an EnumOptions.

Extended by​

Properties​

.grpc.gateway.protoc_gen_openapiv2.options.openapiv2Enum?​

optional .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Enum?: $Properties | null

EnumOptions .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Enum

allowAlias?​

optional allowAlias?: boolean | null

Set this option to true to allow mapping different tag names to the same value.

deprecated?​

optional deprecated?: boolean | null

Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums.

deprecatedLegacyJsonFieldConflicts?​

optional deprecatedLegacyJsonFieldConflicts?: boolean | null

Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only. The new behavior takes json_name into account and applies to proto2 as well. TODO Remove this legacy behavior once downstream teams have had time to migrate.

features?​

optional features?: $Properties | null

Any features defined in the specific edition.

uninterpretedOption?​

optional uninterpretedOption?: $Properties[] | null

The parser stores options it doesn't recognize here. See above.