Interface OpenAPIObject

All Known Subinterfaces:
MediaType, OAuthFlow, OAuthFlows, Operation, Parameter, Path, RequestBody, Response, SecurityRequirement, SecurityScheme, Server
public interface OpenAPIObject

  • Method Details

    • getOpenAPIModel

      JsonObject getOpenAPIModel()
      Returns the part of the related OpenAPI specification which is represented by the OpenAPI object that is implementing this interface.

      Warning:
      • In case the contract contains circular references, the returned object is may of type JsonObjectProxy, which has some limitations when it comes to copying or serializing.
      • Due to these limitations, the reference of the original object is returned. Because of this be very careful when modifying the returned object.
      Returns:
      a JsonObject that represents this part of the related OpenAPI specification.

    • getExtensions

      default Map<String,Object> getExtensions()
      Returns the Specification Extensions of this OpenAPIObject.

      According to the specification, the extension can be of any type.
      Returns:
      the extensions or an empty map if there are none.