Enum Class JetOpenApiAnnotationsExtension.GenerateOperationId

java.lang.Object

java.lang.Enum<JetOpenApiAnnotationsExtension.GenerateOperationId>

net.jacobpeterson.jet.openapiannotationsplugin.JetOpenApiAnnotationsExtension.GenerateOperationId

All Implemented Interfaces:

Serializable, Comparable<JetOpenApiAnnotationsExtension.GenerateOperationId>, Constable

Enclosing class:

JetOpenApiAnnotationsExtension

public static enum JetOpenApiAnnotationsExtension.GenerateOperationId
extends Enum<JetOpenApiAnnotationsExtension.GenerateOperationId>

JetOpenApiAnnotationsExtension.GenerateOperationId is an enum for JetOpenApiAnnotationsExtension.getGenerateOperationId().

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	If not already provided, generate OpenApiOperation.operationId() using the FROM_CLASS_METHOD_NAME configuration and ensuring the generated value is equal to the generated value of the FROM_METHOD_AND_PATH configuration.
DISABLED	Do not generate OpenApiOperation.operationId().
FROM_CLASS_METHOD_NAME	If not already provided, generate OpenApiOperation.operationId() using the name of the class method annotated with the OpenApi annotation.
FROM_METHOD_AND_PATH	If not already provided, generate OpenApiOperation.operationId() by concatenating OpenApiPathItem.methods() with the lower-camelcase conversion of the path segments of OpenApiPathItem.MapEntry.key() after the index of OpenApiOperation.tags().

Method Summary

Modifier and Type	Method	Description
static JetOpenApiAnnotationsExtension.GenerateOperationId	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JetOpenApiAnnotationsExtension.GenerateOperationId[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISABLED

public static final JetOpenApiAnnotationsExtension.GenerateOperationId DISABLED

Do not generate OpenApiOperation.operationId().

FROM_CLASS_METHOD_NAME

public static final JetOpenApiAnnotationsExtension.GenerateOperationId FROM_CLASS_METHOD_NAME

If not already provided, generate OpenApiOperation.operationId() using the name of the class method annotated with the OpenApi annotation.

FROM_METHOD_AND_PATH

public static final JetOpenApiAnnotationsExtension.GenerateOperationId FROM_METHOD_AND_PATH

If not already provided, generate OpenApiOperation.operationId() by concatenating OpenApiPathItem.methods() with the lower-camelcase conversion of the path segments of OpenApiPathItem.MapEntry.key() after the index of OpenApiOperation.tags().

BOTH

public static final JetOpenApiAnnotationsExtension.GenerateOperationId BOTH

If not already provided, generate OpenApiOperation.operationId() using the FROM_CLASS_METHOD_NAME configuration and ensuring the generated value is equal to the generated value of the FROM_METHOD_AND_PATH configuration. This enforces the same naming convention for both the class method name and the API path.

Method Details

values

public static JetOpenApiAnnotationsExtension.GenerateOperationId[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JetOpenApiAnnotationsExtension.GenerateOperationId valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null