Package net.officefloor.web.openapi.security

Interface OpenApiSecurityExtensionContext

public interface OpenApiSecurityExtensionContext

Context for the OpenApiSecurityExtensionContext.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
void	addOperationExtension(OpenApiOperationExtension extension)	Adds an OpenApiOperationExtension.
void	addSecurityScheme(String securityName, io.swagger.v3.oas.models.security.SecurityScheme scheme)	Registers a SecurityScheme.
HttpSecurityExplorerContext	getHttpSecurity()	Obtains the HttpSecurityExplorerContext.

Method Details

getHttpSecurity

HttpSecurityExplorerContext getHttpSecurity()

Obtains the HttpSecurityExplorerContext.

Returns:

HttpSecurityExplorerContext.

addSecurityScheme

void addSecurityScheme(String securityName,
 io.swagger.v3.oas.models.security.SecurityScheme scheme)

Registers a SecurityScheme.

Parameters:

securityName - Name of security.

scheme - SecurityScheme.

addOperationExtension

void addOperationExtension(OpenApiOperationExtension extension)

Adds an OpenApiOperationExtension.

This allows for custom description specific to HttpSecuritySource.

Parameters:

extension - OpenApiOperationExtension.