io.swagger.transform.migrate

Interface SwaggerMigrator

All Known Implementing Classes:

ApiArrayMigrator, ApiObjectMigrator, ApiOperationMigrator, OperationParametersMigrator, PathAppenderMigrator, SwaggerMigrators.MembersToString, V11AllowableValuesMigrator, V11ApiDeclarationMigrator, V11ResourceListingMigrator, V11TypeMigrator

public interface SwaggerMigrator

Core interface for JSON migration

This takes a JsonNode as an input and outputs the transformed JsonNode.

Note that this interface makes no guarantee as to whether a new JsonNode is returned, or the input argument is returned (altered or not). If this distinction is important, please document it in your implementation(s).

You can either implement this interface directly or use one of the predefined migrators in SwaggerMigrators.

See Also:

SwaggerMigrators, MutableJsonTree.applyMigrator(SwaggerMigrator), MutableJsonTree.applyMigratorToElements(SwaggerMigrator)

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	migrate(com.fasterxml.jackson.databind.JsonNode input) Migrate a JSON input

Method Detail

migrate

@Nonnull
com.fasterxml.jackson.databind.JsonNode migrate(@Nonnull
                                                         com.fasterxml.jackson.databind.JsonNode input)
                                                  throws SwaggerMigrationException

Migrate a JSON input

Parameters:

input - the input node

Returns:

the migrated node

Throws:

SwaggerMigrationException - migration failed