Constructor Detail

• OpenApiDocumentation

  OpenApiDocumentation()

Method Detail

• getIsIgnored

   final Boolean getIsIgnored()

• setIsIgnored

   final Unit setIsIgnored(Boolean isIgnored)

• getOperationUpdaterList

   final List<OpenApiUpdater<Operation>> getOperationUpdaterList()

• getRequestBodyList

   final List<OpenApiUpdater<RequestBody>> getRequestBodyList()

• getParameterUpdaterListMapping

   final Map<String, List<OpenApiUpdater<Parameter>>> getParameterUpdaterListMapping()

• getResponseUpdaterListMapping

   final Map<String, List<OpenApiUpdater<ApiResponse>>> getResponseUpdaterListMapping()

• getComponentsUpdaterList

   final List<OpenApiUpdater<Components>> getComponentsUpdaterList()

• getFormParameterList

   final List<DocumentedFormParameter> getFormParameterList()

• getFileUploadList

   final List<DocumentedFileUpload> getFileUploadList()

• hasRequestBodies

   final Boolean hasRequestBodies()

• hasResponses

   final Boolean hasResponses()

• hasFormParameter

   final Boolean hasFormParameter()

• hasFileUploads

   final Boolean hasFileUploads()

• ignore

  @JvmOverloads() final OpenApiDocumentation ignore(Boolean isIgnored)

  Hide the endpoint in the documentation

• ignore

  @JvmOverloads() final OpenApiDocumentation ignore()

  Hide the endpoint in the documentation

• operation

   final OpenApiDocumentation operation(Function1<Operation, Unit> applyUpdates)

• operation

   final OpenApiDocumentation operation(OpenApiUpdater<Operation> openApiUpdater)

• pathParam

  @JvmOverloads() final OpenApiDocumentation pathParam(String name, Class<?> clazz, OpenApiUpdater<Parameter> openApiUpdater)

• pathParam

  @JvmOverloads() final OpenApiDocumentation pathParam(String name, Class<?> clazz)

• queryParam

  @JvmOverloads() final OpenApiDocumentation queryParam(String name, Class<?> clazz, Boolean isRepeatable, OpenApiUpdater<Parameter> openApiUpdater)

• queryParam

  @JvmOverloads() final OpenApiDocumentation queryParam(String name, Class<?> clazz, Boolean isRepeatable)

• queryParam

  @JvmOverloads() final OpenApiDocumentation queryParam(String name, Class<?> clazz)

• header

  @JvmOverloads() final OpenApiDocumentation header(String name, Class<?> clazz, OpenApiUpdater<Parameter> openApiUpdater)

• header

  @JvmOverloads() final OpenApiDocumentation header(String name, Class<?> clazz)

• cookie

  @JvmOverloads() final OpenApiDocumentation cookie(String name, Class<?> clazz, OpenApiUpdater<Parameter> openApiUpdater)

• cookie

  @JvmOverloads() final OpenApiDocumentation cookie(String name, Class<?> clazz)

• param

   final OpenApiDocumentation param(DocumentedParameter documentedParameter, Boolean isRepeatable, Function1<Parameter, Unit> applyUpdates)

• param

  @JvmOverloads() final OpenApiDocumentation param(DocumentedParameter documentedParameter, Boolean isRepeatable, OpenApiUpdater<Parameter> openApiUpdater)

• param

  @JvmOverloads() final OpenApiDocumentation param(DocumentedParameter documentedParameter, Boolean isRepeatable)

• param

  @JvmOverloads() final OpenApiDocumentation param(DocumentedParameter documentedParameter)

• formParam

   final OpenApiDocumentation formParam(String name, Class<?> clazz, Boolean required)

• formParam

   final OpenApiDocumentation formParam(DocumentedFormParameter formParameter)

• formParamBody

  @JvmOverloads() final OpenApiDocumentation formParamBody(Class<?> clazz, OpenApiUpdater<RequestBody> openApiUpdater)

• formParamBody

  @JvmOverloads() final OpenApiDocumentation formParamBody(Class<?> clazz)

• formParamBody

   final OpenApiDocumentation formParamBody(Class<?> clazz, String contentType, OpenApiUpdater<RequestBody> openApiUpdater)

• uploadedFile

   final OpenApiDocumentation uploadedFile(String name, Function1<RequestBody, Unit> applyUpdates)

• uploadedFile

  @JvmOverloads() final OpenApiDocumentation uploadedFile(String name, OpenApiUpdater<RequestBody> openApiUpdater)

• uploadedFile

  @JvmOverloads() final OpenApiDocumentation uploadedFile(String name)

• uploadedFiles

   final OpenApiDocumentation uploadedFiles(String name, Function1<RequestBody, Unit> applyUpdates)

• uploadedFiles

  @JvmOverloads() final OpenApiDocumentation uploadedFiles(String name, OpenApiUpdater<RequestBody> openApiUpdater)

• uploadedFiles

  @JvmOverloads() final OpenApiDocumentation uploadedFiles(String name)

• body

   final OpenApiDocumentation body(Class<?> returnType, String contentType, Function1<RequestBody, Unit> applyUpdates)

• body

   final OpenApiDocumentation body(Class<?> returnType, OpenApiUpdater<RequestBody> openApiUpdater)

• body

  @JvmOverloads() final OpenApiDocumentation body(Composition composition, String contentType, OpenApiUpdater<RequestBody> openApiUpdater)

• body

  @JvmOverloads() final OpenApiDocumentation body(Composition composition, String contentType)

• body

  @JvmOverloads() final OpenApiDocumentation body(Composition composition)

• body

  @JvmOverloads() final OpenApiDocumentation body(Class<?> returnType, String contentType, OpenApiUpdater<RequestBody> openApiUpdater)

• body

  @JvmOverloads() final OpenApiDocumentation body(Class<?> returnType, String contentType)

• body

  @JvmOverloads() final OpenApiDocumentation body(Class<?> returnType)

• body

  @JvmOverloads() final OpenApiDocumentation body(Schema<?> schema, String contentType, OpenApiUpdater<RequestBody> openApiUpdater)

• body

  @JvmOverloads() final OpenApiDocumentation body(Schema<?> schema, String contentType)

• body

  @JvmOverloads() final OpenApiDocumentation body(List<DocumentedContent> content, OpenApiUpdater<RequestBody> openApiUpdater, String contentType, ComposedType composedType)

• body

  @JvmOverloads() final OpenApiDocumentation body(List<DocumentedContent> content, OpenApiUpdater<RequestBody> openApiUpdater, String contentType)

• body

  @JvmOverloads() final OpenApiDocumentation body(List<DocumentedContent> content, OpenApiUpdater<RequestBody> openApiUpdater)

• body

  @JvmOverloads() final OpenApiDocumentation body(List<DocumentedContent> content)

• body

  @JvmOverloads() final OpenApiDocumentation body(DocumentedRequestBody documentedBody, OpenApiUpdater<RequestBody> openApiUpdater)

• body

  @JvmOverloads() final OpenApiDocumentation body(DocumentedRequestBody documentedBody)

• bodyAsBytes

  @JvmOverloads() final OpenApiDocumentation bodyAsBytes(String contentType, Function1<RequestBody, Unit> applyUpdates)

• bodyAsBytes

  @JvmOverloads() final OpenApiDocumentation bodyAsBytes(Function1<RequestBody, Unit> applyUpdates)

• bodyAsBytes

  @JvmOverloads() final OpenApiDocumentation bodyAsBytes(String contentType, OpenApiUpdater<RequestBody> openApiUpdater)

• bodyAsBytes

  @JvmOverloads() final OpenApiDocumentation bodyAsBytes(String contentType)

• bodyAsBytes

  @JvmOverloads() final OpenApiDocumentation bodyAsBytes()

• jsonArray

  @JvmOverloads() final OpenApiDocumentation jsonArray(String status, Class<?> returnType, OpenApiUpdater<ApiResponse> openApiUpdater)

• jsonArray

  @JvmOverloads() final OpenApiDocumentation jsonArray(String status, Class<?> returnType)

• json

  @JvmOverloads() final OpenApiDocumentation json(String status, Class<?> returnType, OpenApiUpdater<ApiResponse> openApiUpdater)

• json

  @JvmOverloads() final OpenApiDocumentation json(String status, Class<?> returnType)

• html

   final OpenApiDocumentation html(String status, Function1<ApiResponse, Unit> applyUpdates)

• html

  @JvmOverloads() final OpenApiDocumentation html(String status, OpenApiUpdater<ApiResponse> openApiUpdater)

• html

  @JvmOverloads() final OpenApiDocumentation html(String status)

• result

  @JvmOverloads() final OpenApiDocumentation result(String status, Class<?> returnType, OpenApiUpdater<ApiResponse> openApiUpdater)

• result

  @JvmOverloads() final OpenApiDocumentation result(String status, Class<?> returnType)

• result

  @JvmOverloads() final OpenApiDocumentation result(String status)

• result

  @JvmOverloads() final OpenApiDocumentation result(String status, Class<?> returnType, String contentType, OpenApiUpdater<ApiResponse> openApiUpdater)

• result

  @JvmOverloads() final OpenApiDocumentation result(String status, Class<?> returnType, String contentType)

• result

  @JvmOverloads() final OpenApiDocumentation result(String status, Composition.OneOf composition, Function1<ApiResponse, Unit> applyUpdates)

• result

  @JvmOverloads() final OpenApiDocumentation result(String status, Composition.OneOf composition)

• result

   final OpenApiDocumentation result(DocumentedResponse documentedResponse, Function1<ApiResponse, Unit> applyUpdates)

• result

   final OpenApiDocumentation result(String status, DocumentedContent content, OpenApiUpdater<ApiResponse> updater)

• result

   final OpenApiDocumentation result(String status, List<DocumentedContent> content, OpenApiUpdater<ApiResponse> updater)

• result

  @JvmOverloads() final OpenApiDocumentation result(DocumentedResponse documentedResponse, OpenApiUpdater<ApiResponse> openApiUpdater)

• result

  @JvmOverloads() final OpenApiDocumentation result(DocumentedResponse documentedResponse)

• apply

   final Unit apply(OpenApiDocumentation other)

  Merge the values of another documentation into this documentation