io.swagger.oas.annotations.responses.ApiResponse 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.oas.annotations.responses;
import io.swagger.oas.annotations.links.Link;
import io.swagger.oas.annotations.media.Content;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
*
*
**/
@Target({ ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ApiResponse {
/**
*
**/
String description() default "";
/**
* the HTTP response code, or default, for the supplied response
**/
String responseCode() default "";
/**
*
**/
Link[] links() default @Link();
// TODO #2312 as array, according to spec
/**
*
**/
Content content() default @Content();
}