org.eclipse.microprofile.openapi.annotations.extensions.Extension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of microprofile-openapi-api Show documentation

MicroProfile OpenAPI API :: API

There is a newer version: 4.0.2

Show newest version

/**
 * 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.extensions;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * A named extension that should be added to the OpenAPI definition.
 */
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Extensions.class)
public @interface Extension {

    /**
     * A name for the extension.
     *
     * @return an option name for these extensions - will be prefixed with "x-"
     */
    String name();

    /**
     * The extension value. If the value should be parsed into an object or array, then the value should be stringified
     * JSON suitable for parsing by a standard JSON parser.
     * 
     * @return the actual extension value
     */
    String value();

    /**
     * Should the value be parsed into an object/array or other simple type (number, boolean, etc) or left as a simple
     * String. If this is true, then the value must be parseable as one of:
     * 

     * JSON object
     * JSON array
     * number
     * boolean
     * 
     * 
     * @return true if the value should be parsed
     */
    boolean parseValue() default false;
}