Package software.aws.awsprototypingsdk.openapigateway

Enum DocumentationFormat

java.lang.Object

java.lang.Enum<DocumentationFormat>

software.aws.awsprototypingsdk.openapigateway.DocumentationFormat

All Implemented Interfaces:

Serializable, Comparable<DocumentationFormat>

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-15T09:33:12.691Z")
@Stability(Experimental)
public enum DocumentationFormat
extends Enum<DocumentationFormat>

(experimental) Formats for documentation generation.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HTML_REDOC	(experimental) HTML Documentation generated by redoc.
HTML2	(experimental) OpenAPI Generator 'html2' documentation.
MARKDOWN	(experimental) OpenAPI Generator 'markdown' documentation.
PLANTUML	(experimental) OpenAPI Generator 'plantuml' documentation.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HTML_REDOC

@Stability(Experimental)
public static final DocumentationFormat HTML_REDOC

(experimental) HTML Documentation generated by redoc.

See Also:

https://github.com/Redocly/redoc

HTML2

@Stability(Experimental)
public static final DocumentationFormat HTML2

(experimental) OpenAPI Generator 'html2' documentation.

See Also:

https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/html2.md

MARKDOWN

@Stability(Experimental)
public static final DocumentationFormat MARKDOWN

(experimental) OpenAPI Generator 'markdown' documentation.

See Also:

https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/markdown.md

PLANTUML

@Stability(Experimental)
public static final DocumentationFormat PLANTUML

(experimental) OpenAPI Generator 'plantuml' documentation.

See Also:

https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/plantuml.md

Method Detail

values

public static DocumentationFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DocumentationFormat c : DocumentationFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocumentationFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null