org.eclipse.microprofile.openapi.annotations.links.package-info Maven / Gradle / Ivy

Go to download
/*
 * 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.
 */

/**
 * Annotations to represent a design-time link for a response and the corresponding parameter to be passed to the linked
 * operation.
 * 

 * Example usage:
 *
 * 
 *  {@literal @}APIResponse(
 *      responseCode="201",
 *      description="review created",
 *      links = {
 *          {@literal @}Link(
 *              name="Review",
 *              description="get the review that was added",
 *              operationId="getReviewById"
 *      }
 *  )
 * 
 */

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