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

@Version("1.0") 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"))
  • Class
    Description
    OAuthFlow
    Configuration details for a supportde OAuthFlow
    OAuthFlows
    Configuration of the supported OAuthFlows
    Scopes
    Scopes is a property of OAuth Flow Object.
    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.