Interface OpenApi3xMapperRules

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
OpenApi3xMapperRules.BuilderBase.OpenApi3xMapperRulesImpl
public interface OpenApi3xMapperRules extends Prototype.Api
OpenAPI 3.x version-specific mapper rules.
See Also:

  • Method Details

    • builder

      static OpenApi3xMapperRules.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static OpenApi3xMapperRules.Builder builder(OpenApi3xMapperRules instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • targetVersion

      String targetVersion()
      Target OpenAPI version.
      Returns:
      target OpenAPI version

    • operationResponsesRequired

      boolean operationResponsesRequired()
      Whether operations must define responses.
      Returns:
      whether operation responses are required

    • responseDescriptionRequired

      boolean responseDescriptionRequired()
      Whether responses must define a description.
      Returns:
      whether response descriptions are required

    • documentFields

      Set<String> documentFields()
      Document fields.
      Returns:
      document fields

    • infoFields

      Set<String> infoFields()
      Info fields.
      Returns:
      info fields

    • contactFields

      Set<String> contactFields()
      Contact fields.
      Returns:
      contact fields

    • licenseFields

      Set<String> licenseFields()
      License fields.
      Returns:
      license fields

    • serverFields

      Set<String> serverFields()
      Server fields.
      Returns:
      server fields

    • serverVariableFields

      Set<String> serverVariableFields()
      Server variable fields.
      Returns:
      server variable fields

    • tagFields

      Set<String> tagFields()
      Tag fields.
      Returns:
      tag fields

    • pathItemFields

      Set<String> pathItemFields()
      Path item fields.
      Returns:
      path item fields

    • fixedPathOperationFields

      Set<String> fixedPathOperationFields()
      Fixed path operation fields.
      Returns:
      fixed path operation fields

    • operationFields

      Set<String> operationFields()
      Operation fields.
      Returns:
      operation fields

    • parameterFields

      Set<String> parameterFields()
      Parameter fields.
      Returns:
      parameter fields

    • parameterLocations

      Set<String> parameterLocations()
      Parameter locations.
      Returns:
      parameter locations

    • headerFields

      Set<String> headerFields()
      Header fields.
      Returns:
      header fields

    • requestBodyFields

      Set<String> requestBodyFields()
      Request body fields.
      Returns:
      request body fields

    • responseFields

      Set<String> responseFields()
      Response fields.
      Returns:
      response fields

    • mediaTypeFields

      Set<String> mediaTypeFields()
      Media type fields.
      Returns:
      media type fields

    • encodingFields

      Set<String> encodingFields()
      Encoding fields.
      Returns:
      encoding fields

    • componentsFields

      Set<String> componentsFields()
      Components fields.
      Returns:
      components fields

    • securitySchemeFields

      Set<String> securitySchemeFields()
      Security scheme fields.
      Returns:
      security scheme fields

    • securitySchemeTypes

      Set<String> securitySchemeTypes()
      Security scheme types.
      Returns:
      security scheme types

    • oauthFlowsFields

      Set<String> oauthFlowsFields()
      OAuth flows fields.
      Returns:
      OAuth flows fields

    • oauthFlowFields

      Set<String> oauthFlowFields()
      OAuth flow fields.
      Returns:
      OAuth flow fields

    • linkFields

      Set<String> linkFields()
      Link fields.
      Returns:
      link fields

    • exampleFields

      Set<String> exampleFields()
      Example fields.
      Returns:
      example fields

    • externalDocsFields

      Set<String> externalDocsFields()
      External docs fields.
      Returns:
      external docs fields