Class OpenAPIContract
- java.lang.Object
-
- io.vertx.rxjava3.openapi.contract.OpenAPIContract
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class OpenAPIContract extends Object implements io.vertx.lang.rx.RxDelegate
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<OpenAPIContract>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description OpenAPIContract(OpenAPIContract delegate)OpenAPIContract(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)OperationfindOperation(String urlPath, HttpMethod method)Finds the relatedOperationobject based on the passed url path and method.PathfindPath(String urlPath)Finds the relatedPathobject based on the passed url path.static Single<OpenAPIContract>from(Vertx vertx, JsonObject unresolvedContract)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.static Single<OpenAPIContract>from(Vertx vertx, JsonObject unresolvedContract, Map<String,JsonObject> additionalContractFiles)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.static Single<OpenAPIContract>from(Vertx vertx, String unresolvedContractPath)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.static Single<OpenAPIContract>from(Vertx vertx, String unresolvedContractPath, Map<String,String> additionalContractFiles)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.OpenAPIContractgetDelegate()List<Path>getPaths()JsonObjectgetRawContract()SchemaRepositorygetSchemaRepository()List<SecurityRequirement>getSecurityRequirements()Returns the applicable list of global security requirements (scopes) or empty list.List<Server>getServers()OpenAPIVersiongetVersion()inthashCode()static OpenAPIContractnewInstance(OpenAPIContract arg)Operationoperation(String operationId)Access to an operation defined in the contract withoperationId.List<Operation>operations()static Single<OpenAPIContract>rxFrom(Vertx vertx, JsonObject unresolvedContract)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.static Single<OpenAPIContract>rxFrom(Vertx vertx, JsonObject unresolvedContract, Map<String,JsonObject> additionalContractFiles)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.static Single<OpenAPIContract>rxFrom(Vertx vertx, String unresolvedContractPath)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.static Single<OpenAPIContract>rxFrom(Vertx vertx, String unresolvedContractPath, Map<String,String> additionalContractFiles)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.SecuritySchemesecurityScheme(String name)Gets the relatedSecuritySchemeobject based on the passed name.StringtoString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<OpenAPIContract> __TYPE_ARG
-
-
Constructor Detail
-
OpenAPIContract
public OpenAPIContract(OpenAPIContract delegate)
-
OpenAPIContract
public OpenAPIContract(Object delegate)
-
-
Method Detail
-
getDelegate
public OpenAPIContract getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
from
public static Single<OpenAPIContract> from(Vertx vertx, String unresolvedContractPath)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.- Parameters:
vertx- The related Vert.x instance.unresolvedContractPath- The path to the unresolved contract.- Returns:
- A succeeded holding an
OpenAPIContractinstance, otherwise a failed .
-
rxFrom
public static Single<OpenAPIContract> rxFrom(Vertx vertx, String unresolvedContractPath)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.- Parameters:
vertx- The related Vert.x instance.unresolvedContractPath- The path to the unresolved contract.- Returns:
- A succeeded holding an
OpenAPIContractinstance, otherwise a failed .
-
from
public static Single<OpenAPIContract> from(Vertx vertx, JsonObject unresolvedContract)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.- Parameters:
vertx- The related Vert.x instance.unresolvedContract- The unresolved contract.- Returns:
- A succeeded holding an
OpenAPIContractinstance, otherwise a failed .
-
rxFrom
public static Single<OpenAPIContract> rxFrom(Vertx vertx, JsonObject unresolvedContract)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.- Parameters:
vertx- The related Vert.x instance.unresolvedContract- The unresolved contract.- Returns:
- A succeeded holding an
OpenAPIContractinstance, otherwise a failed .
-
from
public static Single<OpenAPIContract> from(Vertx vertx, String unresolvedContractPath, Map<String,String> additionalContractFiles)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.This method can be used in case that the contract is split into several files. These files can be passed in a Map that has the reference as key and the path to the file as value.
- Parameters:
vertx- The related Vert.x instance.unresolvedContractPath- The path to the unresolved contract.additionalContractFiles- The additional contract files- Returns:
- A succeeded holding an
OpenAPIContractinstance, otherwise a failed .
-
rxFrom
public static Single<OpenAPIContract> rxFrom(Vertx vertx, String unresolvedContractPath, Map<String,String> additionalContractFiles)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.This method can be used in case that the contract is split into several files. These files can be passed in a Map that has the reference as key and the path to the file as value.
- Parameters:
vertx- The related Vert.x instance.unresolvedContractPath- The path to the unresolved contract.additionalContractFiles- The additional contract files- Returns:
- A succeeded holding an
OpenAPIContractinstance, otherwise a failed .
-
from
public static Single<OpenAPIContract> from(Vertx vertx, JsonObject unresolvedContract, Map<String,JsonObject> additionalContractFiles)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.This method can be used in case that the contract is split into several files. These files can be passed in a Map that has the reference as key and the path to the file as value.
- Parameters:
vertx- The related Vert.x instance.unresolvedContract- The unresolved contract.additionalContractFiles- The additional contract files- Returns:
- A succeeded holding an
OpenAPIContractinstance, otherwise a failed .
-
rxFrom
public static Single<OpenAPIContract> rxFrom(Vertx vertx, JsonObject unresolvedContract, Map<String,JsonObject> additionalContractFiles)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.This method can be used in case that the contract is split into several files. These files can be passed in a Map that has the reference as key and the path to the file as value.
- Parameters:
vertx- The related Vert.x instance.unresolvedContract- The unresolved contract.additionalContractFiles- The additional contract files- Returns:
- A succeeded holding an
OpenAPIContractinstance, otherwise a failed .
-
operation
public Operation operation(String operationId)
Access to an operation defined in the contract withoperationId.- Parameters:
operationId- the id of the operation.- Returns:
- the requested operation.
-
getRawContract
public JsonObject getRawContract()
- Returns:
- the resolved OpenAPI contract as .
-
getVersion
public OpenAPIVersion getVersion()
- Returns:
- the OpenAPI version of the contract.
-
getSchemaRepository
public SchemaRepository getSchemaRepository()
- Returns:
- the to validate against.
-
findPath
public Path findPath(String urlPath)
Finds the relatedPathobject based on the passed url path.
-
findOperation
public Operation findOperation(String urlPath, HttpMethod method)
Finds the relatedOperationobject based on the passed url path and method.
-
getSecurityRequirements
public List<SecurityRequirement> getSecurityRequirements()
Returns the applicable list of global security requirements (scopes) or empty list.- Returns:
- The related security requirement.
-
securityScheme
public SecurityScheme securityScheme(String name)
Gets the relatedSecuritySchemeobject based on the passed name.- Parameters:
name- The name of the security scheme.- Returns:
- the found
SecuritySchemeobject, or null if the passed path and method doesn't match anyOperationobject.
-
newInstance
public static OpenAPIContract newInstance(OpenAPIContract arg)
-
-