Package org.opennms.features.config.dao.impl.util

Class ConfigSwaggerConverter

java.lang.Object

org.opennms.features.config.dao.impl.util.ConfigSwaggerConverter

public class ConfigSwaggerConverter
extends Object

Convert ConfigItem into OpenAPI

Field Summary

Fields

Modifier and Type	Field	Description
static String	APPLICATION_JSON
static String	REMOTE_REF_PATH
static String	SCHEMA_PATH

Constructor Summary

Constructors

Constructor	Description
ConfigSwaggerConverter()

Method Summary

Modifier and Type	Method	Description
io.swagger.v3.oas.models.OpenAPI	convert(ConfigItem item, String prefix)
io.swagger.v3.oas.models.OpenAPI	convert(ConfigItem item, String prefix, boolean isSingleConfig)	Convert ConfigItem to OpenAPI
String	convertOpenAPIToString(io.swagger.v3.oas.models.OpenAPI openapi, String acceptType)	convert open api object to specific string (default is yaml)
String	convertToString(ConfigItem item, String prefix, String acceptType)
io.swagger.v3.oas.models.OpenAPI	mergeAllPathsWithRemoteRef(Map<String,io.swagger.v3.oas.models.OpenAPI> openapiMap, String prefix)	It will extract all API paths to generate a giant openapi with remote $ref schema
static io.swagger.v3.oas.models.OpenAPI	setupServers(io.swagger.v3.oas.models.OpenAPI openapi, List<String> urls)	replace servers part of openapi
void	walk(ConfigItem parent, ConfigItem item, java.util.function.BiConsumer<ConfigItem,ConfigItem> consumer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPLICATION_JSON

public static final String APPLICATION_JSON

See Also:

Constant Field Values

SCHEMA_PATH

public static final String SCHEMA_PATH

See Also:

Constant Field Values

REMOTE_REF_PATH

public static final String REMOTE_REF_PATH

See Also:

Constant Field Values

Constructor Detail

ConfigSwaggerConverter

public ConfigSwaggerConverter()

Method Detail

convertToString

public String convertToString(ConfigItem item,
                              String prefix,
                              String acceptType)
                       throws SchemaConversionException

Throws:

SchemaConversionException

convertOpenAPIToString

public String convertOpenAPIToString(io.swagger.v3.oas.models.OpenAPI openapi,
                                     String acceptType)
                              throws SchemaConversionException

convert open api object to specific string (default is yaml)

Parameters:

openapi - schema

acceptType - (json / yaml)

Returns:

Throws:

com.fasterxml.jackson.core.JsonProcessingException

SchemaConversionException

setupServers

public static io.swagger.v3.oas.models.OpenAPI setupServers(io.swagger.v3.oas.models.OpenAPI openapi,
                                                            List<String> urls)

replace servers part of openapi

Parameters:

openapi -

urls -

Returns:

mergeAllPathsWithRemoteRef

public io.swagger.v3.oas.models.OpenAPI mergeAllPathsWithRemoteRef(Map<String,io.swagger.v3.oas.models.OpenAPI> openapiMap,
                                                                   String prefix)

It will extract all API paths to generate a giant openapi with remote $ref schema

Parameters:

openapiMap -

prefix - (must include context path)

Returns:

convert

public io.swagger.v3.oas.models.OpenAPI convert(ConfigItem item,
                                                String prefix)

convert

public io.swagger.v3.oas.models.OpenAPI convert(ConfigItem item,
                                                String prefix,
                                                boolean isSingleConfig)

Convert ConfigItem to OpenAPI

Parameters:

item -

prefix -

isSingleConfig - (it will disable post & delete API)

Returns:

walk

public void walk(ConfigItem parent,
                 ConfigItem item,
                 java.util.function.BiConsumer<ConfigItem,ConfigItem> consumer)