org.eclipse.microprofile.openapi.annotations.servers.package-info Maven / Gradle / Ivy
/*
* 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 servers used for a single API operation or for all operations in an OpenAPI document, as
* well as a way to represent variables for server URL template substitution.
*
* Example usage:
*
*
* {@literal @}POST
* {@literal @}Servers(value={
* {@literal @}Server(url = "localhost:9080/{proxyPath}/reviews/id",
* description = "view of all the reviews",
* variables = { {@literal @}ServerVariable(name = "proxyPath", description = "Base path of the proxy", defaultValue = "proxy") }),
* {@literal @}Server(url = "http://random.url/reviews", description = "random text")
* })
*
*/
@org.osgi.annotation.versioning.Version("1.1")
@org.osgi.annotation.versioning.ProviderType
package org.eclipse.microprofile.openapi.annotations.servers;