Package org.forgerock.api.transform

Class OpenApiHelper

java.lang.Object

org.forgerock.api.transform.OpenApiHelper

public final class OpenApiHelper
extends Object

Helper methods for applying commonly needed changes to the Swagger model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenApiHelper.OperationVisitor	Visits a Swagger Operation.

Method Summary

Modifier and Type	Method	Description
static void	addHeaderToAllOperations(io.swagger.models.parameters.HeaderParameter header, io.swagger.models.Swagger swagger)	Adds a header to all operations.
static void	visitAllOperations(OpenApiHelper.OperationVisitor visitor, io.swagger.models.Swagger swagger)	Visits all operations.

Methods inherited from class java.lang.Object

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

Method Detail

addHeaderToAllOperations

public static void addHeaderToAllOperations(io.swagger.models.parameters.HeaderParameter header,
                                            io.swagger.models.Swagger swagger)

Adds a header to all operations. For example, one may need to add authentication headers for username and password.

Parameters:

header - Header model

swagger - Swagger model

visitAllOperations

public static void visitAllOperations(OpenApiHelper.OperationVisitor visitor,
                                      io.swagger.models.Swagger swagger)

Visits all operations.

Parameters:

visitor - Operation visitor

swagger - Swagger model