org.eclipse.microprofile.openapi.annotations.security.OAuthFlow Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2017 Contributors to the Eclipse Foundation
 * Copyright 2017 SmartBear Software
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 

 * http://www.apache.org/licenses/LICENSE-2.0
 * 

 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.eclipse.microprofile.openapi.annotations.security;

import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.eclipse.microprofile.openapi.annotations.extensions.Extension;

/**
 * Configuration details for a supported OAuth Flow.
 *
 * @see OpenAPI Specification OAuth Flow
 *      Object
 **/
@Target({})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface OAuthFlow {
    /**
     * The authorization URL to be used for this flow.
     * 

     * This is a REQUIRED property and MUST be in the form of a URL. Applies to oauth2 ("implicit", "authorizationCode")
     * type.
     * 
     *
     * @return authorization URL for this flow
     **/
    String authorizationUrl() default "";

    /**
     * The token URL to be used for this flow.
     * 
     * This is a REQUIRED property and MUST be in the form of a URL. Applies to oauth2 ("password", "clientCredentials",
     * "authorizationCode") type.
     * 
     *
     * @return token URL for this flow
     **/
    String tokenUrl() default "";

    /**
     * The URL to be used for obtaining refresh tokens.
     * 
     * This MUST be in the form of a URL. Applies to oauth2 type.
     * 
     *
     * @return URL for obtaining refresh tokens
     **/
    String refreshUrl() default "";

    /**
     * This is a REQUIRED property.
     * 
     * The available scopes for the OAuth2 security scheme. Applies to oauth2 type.
     * 
     *
     * @return scopes available for this security scheme
     **/
    OAuthScope[] scopes() default {};

    /**
     * List of extensions to be added to the {@link org.eclipse.microprofile.openapi.models.security.OAuthFlow
     * OAuthFlow} model corresponding to the containing annotation.
     *
     * @return array of extensions
     *
     * @since 3.1
     */
    Extension[] extensions() default {};
}