Package com.atlassian.crowd.maven.plugin.openapi

Class OpenAPIUtils

java.lang.Object

com.atlassian.crowd.maven.plugin.openapi.OpenAPIUtils

public class OpenAPIUtils
extends Object

Utility class for working with OpenAPI objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAPIUtils.SortedMapKeysSerializer	Serializes the entries of a map in a sorted order.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	X_ATLASSIAN_NARRATIVE

Constructor Summary

Constructors

Constructor	Description
OpenAPIUtils()

Method Summary

Modifier and Type	Method	Description
static io.swagger.v3.oas.models.OpenAPI	addTagsToRoot(io.swagger.v3.oas.models.OpenAPI openAPI)	Adds tags to the root of an OpenAPI object, extracted from the existing tags on operations
static io.swagger.v3.oas.models.OpenAPI	mergeOpenAPI(io.swagger.v3.oas.models.OpenAPI api1, io.swagger.v3.oas.models.OpenAPI api2)
static io.swagger.v3.oas.models.OpenAPI	processNarrative(io.swagger.v3.oas.models.OpenAPI openAPI, String docFilesRoot)	Processes the x-atlassian-narrative extension in an OpenAPI object.
static void	writeOpenAPIToFile(io.swagger.v3.oas.models.OpenAPI mergedOpenAPI, String outputFile)	Overload for writeOpenAPIToFile(OpenAPI, String, boolean) where format is enabled by default.
static void	writeOpenAPIToFile(io.swagger.v3.oas.models.OpenAPI mergedOpenAPI, String outputFile, boolean formatted)	Writes an OpenAPI object to a file.

Methods inherited from class java.lang.Object

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

Field Details

X_ATLASSIAN_NARRATIVE

public static final String X_ATLASSIAN_NARRATIVE

See Also:

• Constant Field Values

Constructor Details

OpenAPIUtils

public OpenAPIUtils()

Method Details

mergeOpenAPI

public static io.swagger.v3.oas.models.OpenAPI mergeOpenAPI(io.swagger.v3.oas.models.OpenAPI api1,
 io.swagger.v3.oas.models.OpenAPI api2)
                                                     throws IntrospectionException,
InvocationTargetException,
InstantiationException,
IllegalAccessException,
NoSuchMethodException

Throws:

IntrospectionException

InvocationTargetException

InstantiationException

IllegalAccessException

NoSuchMethodException

writeOpenAPIToFile

public static void writeOpenAPIToFile(io.swagger.v3.oas.models.OpenAPI mergedOpenAPI,
 String outputFile)

Overload for writeOpenAPIToFile(OpenAPI, String, boolean) where format is enabled by default.

writeOpenAPIToFile

public static void writeOpenAPIToFile(io.swagger.v3.oas.models.OpenAPI mergedOpenAPI,
 String outputFile,
 boolean formatted)

Writes an OpenAPI object to a file. The file extension must be .yaml, .yml, or .json.

Parameters:

mergedOpenAPI - the OpenAPI object

outputFile - the file path

processNarrative

public static io.swagger.v3.oas.models.OpenAPI processNarrative(io.swagger.v3.oas.models.OpenAPI openAPI,
 String docFilesRoot)

Processes the x-atlassian-narrative extension in an OpenAPI object.

Parameters:

openAPI - the OpenAPI object

Returns:

the processed OpenAPI object

addTagsToRoot

public static io.swagger.v3.oas.models.OpenAPI addTagsToRoot(io.swagger.v3.oas.models.OpenAPI openAPI)

Adds tags to the root of an OpenAPI object, extracted from the existing tags on operations

Parameters:

openAPI - the OpenAPI object

Returns:

the OpenAPI object with tags added