io.swagger.transform.migrate

Class V11AllowableValuesMigrator

java.lang.Object

io.swagger.transform.migrate.V11AllowableValuesMigrator

All Implemented Interfaces:

SwaggerMigrator

public final class V11AllowableValuesMigrator
extends Object
implements SwaggerMigrator

Patch a 1.1 allowableValues into a 1.2 enum

allowableValues is an object which has at least one valueType member, whose value is a JSON String. If this string is "LIST", then it is replaced by an enum, as in:

     {
         "allowableValues": {
             "valueType": "LIST",
             "values": [ "a", "b", "c" ]
         }
     }
 

which will become:

     {
         "enum": [ "a", "b", "c" ]
     }
 

Another possible value is "range[]", however this migrator does not handle this case (yet?).

Constructor Summary

Constructors

Constructor and Description
V11AllowableValuesMigrator()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

V11AllowableValuesMigrator

public V11AllowableValuesMigrator()

Method Detail

migrate

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

Description copied from interface: SwaggerMigrator

Migrate a JSON input

Specified by:

migrate in interface SwaggerMigrator

Parameters:

input - the input node

Returns:

the migrated node

Throws:

SwaggerMigrationException - migration failed