io.swagger.v3.oas.annotations.info.License Maven / Gradle / Ivy
/**
* 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 io.swagger.v3.oas.annotations.info;
import io.swagger.v3.oas.annotations.extensions.Extension;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* The annotation may be used in {@link Info#license()} to define a license for the OpenAPI spec.
*
* @see License (OpenAPI specification)
* @see io.swagger.v3.oas.annotations.OpenAPIDefinition
* @see Info
**/
@Target({})
@Retention(RetentionPolicy.RUNTIME)
public @interface License {
/**
* The license name used for the API.
*
* @return the name of the license
**/
String name() default "";
/**
* A URL to the license used for the API. MUST be in the format of a URL.
*
* @return the URL of the license
**/
String url() default "";
/**
* The list of optional extensions
*
* @return an optional array of extensions
*/
Extension[] extensions() default {};
}