Skip to main content

Interface: $Properties

protobuf.EnumOptions.$Properties

Properties of an EnumOptions.

Hierarchy​

Properties​

.grpc.gateway.protoc_gen_openapiv2.options.openapiv2Enum​

• Optional .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Enum: null | $Properties

EnumOptions .grpc.gateway.protoc_gen_openapiv2.options.openapiv2Enum


allowAlias​

• Optional allowAlias: null | boolean

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


deprecated​

• Optional deprecated: null | boolean

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: null | boolean

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: null | $Properties

Any features defined in the specific edition.


uninterpretedOption​

• Optional uninterpretedOption: null | $Properties[]

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