org.eclipse.microprofile.openapi.annotations.responses.package-info 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
 * 
 * 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.
 */

/**
 * Contains annotation to describe a single response from an API operation, and an annotation to encapsulate multiple
 * responses from an API operation.
 * 

 * Example usage:
 *
 * 
 * {@literal @}GET
 *  {@literal @}Path("{id}")
 *  {@literal @}APIResponse(
 *      responseCode="200",
 *      description="Review retrieved",
 *      content={@literal @}Content(
 *          schema={@literal @}Schema(
 *              implementation=Review.class))
 *  )
 * 
 */

@org.osgi.annotation.versioning.Version("1.2")
@org.osgi.annotation.versioning.ProviderType
package org.eclipse.microprofile.openapi.annotations.responses;