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 OpenAPI model.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OpenApiHelper.OperationVisitor	Visits an OpenAPI Operation.

Method Summary

Modifier and Type	Method	Description
static void	addHeaderToAllOperations(io.swagger.v3.oas.models.parameters.Parameter header, io.swagger.v3.oas.models.OpenAPI openApi)	Adds a header to all operations.
static void	visitAllOperations(OpenApiHelper.OperationVisitor visitor, io.swagger.v3.oas.models.OpenAPI openApi)	Visits all operations.

Methods inherited from class java.lang.Object

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

Method Details

addHeaderToAllOperations

public static void addHeaderToAllOperations(io.swagger.v3.oas.models.parameters.Parameter header,
 io.swagger.v3.oas.models.OpenAPI openApi)

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

Parameters:

header - Header parameter model (must have in set to "header")

openApi - OpenAPI model

visitAllOperations

public static void visitAllOperations(OpenApiHelper.OperationVisitor visitor,
 io.swagger.v3.oas.models.OpenAPI openApi)

Visits all operations.

Parameters:

visitor - Operation visitor

openApi - OpenAPI model