Module org.eclipse.microprofile.openapi

# Package org.eclipse.microprofile.openapi.models.security

@Version("2.2") @ProviderType package org.eclipse.microprofile.openapi.models.security
A set of model interfaces to represent various security components of an OpenAPI app.

The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.

Example usage:

     @Override
      public OpenAPI buildModel() {
          return OASFactory.createObject(OpenAPI.class)
              .security(new ArrayList<SecurityRequirement>())
                  .addSecurityRequirement(OASFactory.createObject(SecurityRequirement.class)
                      .addScheme("airlinesRatingApp_auth"))

Related Packages
Package
Description
org.eclipse.microprofile.openapi.models
A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library.
Class
Description
OAuthFlow
Configuration details for a supportde OAuthFlow
OAuthFlows
Configuration of the supported OAuthFlows
SecurityRequirement
SecurityRequirement
SecurityScheme
SecurityScheme
SecurityScheme.In
In is a REQUIRED property that specifies the location of the API key.
SecurityScheme.Type
Type is a REQUIRED property that specifies the type of SecurityScheme instance.