Package net.officefloor.web.openapi.operation

Interface OpenApiOperationContext

    • Method Detail

      • getOpenApi

        io.swagger.v3.oas.models.OpenAPI getOpenApi()
        Obtains the OpenAPI.
        Returns:
        OpenAPI.

      • getPath

        io.swagger.v3.oas.models.PathItem getPath()
        Obtains the PathItem.
        Returns:
        PathItem.

      • getOperation

        io.swagger.v3.oas.models.Operation getOperation()
        Obtains the Operation.
        Returns:
        Operation.

      • getParameter

        io.swagger.v3.oas.models.parameters.Parameter getParameter​(java.lang.String name)
        Obtains the Parameter by name.
        Parameters:
        name - Name of the Parameter.
        Returns:
        Parameter by name or null if none.

      • getOrAddSecurityRequirement

        io.swagger.v3.oas.models.security.SecurityRequirement getOrAddSecurityRequirement​(java.lang.String securityName)

        Convenience method to lazy create the SecurityRequirement.

        This will return the first SecurityRequirement registered for the SecurityScheme.

        Parameters:
        securityName - Name of SecurityScheme.
        Returns:
        Existing SecurityRequirement for SecurityScheme or created SecurityRequirement if not already added.

      • getComponents

        io.swagger.v3.oas.models.Components getComponents()
        Obtains the Components.
        Returns:
        Components.

      • getAllSecurityNames

        java.lang.String[] getAllSecurityNames()
        Obtains all the security names registered via the OpenApiSecurityExtension instances.
        Returns:
        All the security names.