Uses of Interface
org.eclipse.microprofile.openapi.models.servers.Server
Packages that use Server
Package
Description
A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI
v3.1 documents from their Jakarta REST applications.
A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library.
An interface of a model to represent a design-time link for a response.
Model interfaces 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.
-
Uses of Server in org.eclipse.microprofile.openapi
Methods in org.eclipse.microprofile.openapi that return ServerModifier and TypeMethodDescriptionstatic ServerOASFactory.createServer()This method creates a newServerinstance.default ServerOASFilter.filterServer(Server server) Allows filtering of a particular Server.Methods in org.eclipse.microprofile.openapi with parameters of type ServerModifier and TypeMethodDescriptiondefault ServerOASFilter.filterServer(Server server) Allows filtering of a particular Server. -
Uses of Server in org.eclipse.microprofile.openapi.models
Methods in org.eclipse.microprofile.openapi.models that return types with arguments of type ServerModifier and TypeMethodDescriptionOpenAPI.getServers()Returns the Servers defined in the APIOperation.getServers()Returns the servers property from an Operation instance.PathItem.getServers()Returns the servers property from a PathItem instance.Methods in org.eclipse.microprofile.openapi.models with parameters of type ServerModifier and TypeMethodDescriptionAdds the given server to this OpenAPI instance's list of servers.Adds the given server to this Operation's list of servers.Adds the given server to this PathItem's list of servers.voidOpenAPI.removeServer(Server server) Removes the given server to this OpenAPI instance's list of servers.voidOperation.removeServer(Server server) Removes the given server to this Operation's list of servers.voidPathItem.removeServer(Server server) Removes the given server to this PathItem's list of servers.Method parameters in org.eclipse.microprofile.openapi.models with type arguments of type ServerModifier and TypeMethodDescriptiondefault OpenAPISets this OpenAPI instance's servers property to the given servers.default OperationSets this Operation's servers property to the given list.default PathItemSets this PathItem's servers property to the given list.voidOpenAPI.setServers(List<Server> servers) Sets this OpenAPI instance's servers property to the given servers.voidOperation.setServers(List<Server> servers) Sets this Operation's servers property to the given list.voidPathItem.setServers(List<Server> servers) Sets this PathItem's servers property to the given list. -
Uses of Server in org.eclipse.microprofile.openapi.models.links
Methods in org.eclipse.microprofile.openapi.models.links that return ServerModifier and TypeMethodDescriptionLink.getServer()Returns the server property from a Link instance.Methods in org.eclipse.microprofile.openapi.models.links with parameters of type Server -
Uses of Server in org.eclipse.microprofile.openapi.models.servers
Methods in org.eclipse.microprofile.openapi.models.servers that return ServerModifier and TypeMethodDescriptionServer.addVariable(String variableName, ServerVariable variable) Adds the given server variable item to the Server's map of variables.default ServerServer.description(String description) This method sets the description property of a Server instance to the given description parameter and returns the modified instance.default ServerThis method sets the url property of Server instance to the given url argument, representing a URL to the target host, and returns the modified instance.default ServerServer.variables(Map<String, ServerVariable> variables) This method sets the variables property of Server instance to the given variables argument and returns the modified instance.