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

/**
 * A set of annotations, many derived from Swagger Core library. OpenAPI annotations can be augmented with existing
 * Jakarta REST annotations in an application to produce a valid OpenAPI document.
 *
 * Examples of annotations in this package include:
 * 

 * Components
 * ExternalDocumentation
 * OpenAPIDefinition
 * Operation
 * 
 * 
 * Example of usage:
 *
 * 
 *  {@literal @}GET
 *  {@literal @}Path("/findByStatus")
 *  {@literal @}Operation(summary = "Finds Pets by status",
 *            description = "Multiple status values can be provided with comma separated strings")
 *  public Response findPetsByStatus(...) { ... }
 * 
 */

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