diff --git a/modules/openapi-generator-online/src/main/java/org/openapitools/codegen/online/api/GenApiDelegate.java b/modules/openapi-generator-online/src/main/java/org/openapitools/codegen/online/api/GenApiDelegate.java index 0461eff15197..5f92c365d8d5 100644 --- a/modules/openapi-generator-online/src/main/java/org/openapitools/codegen/online/api/GenApiDelegate.java +++ b/modules/openapi-generator-online/src/main/java/org/openapitools/codegen/online/api/GenApiDelegate.java @@ -43,6 +43,7 @@ default Optional getRequest() { /** * @see GenApi#clientOptions + * @return A {@link ResponseEntity} listing options for the target client generator. */ default ResponseEntity> clientOptions() { getRequest().ifPresent(request -> { @@ -58,7 +59,9 @@ default ResponseEntity> clientOptions() { } /** + * @param fileId The unique id of the file, provided in a {@link ResponseCode} response. * @see GenApi#downloadFile + * @return A {@link ResponseEntity} of the requested {@link Resource}. */ default ResponseEntity downloadFile(String fileId) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -66,7 +69,10 @@ default ResponseEntity downloadFile(String fileId) { } /** + * @param language The target generator (language is a misnomer here, but kept for API consistency). + * @param generatorInput The configuration settings to be used during client generation. * @see GenApi#generateClient + * @return A {@link ResponseEntity} referencing the unique download id and a link to download the requested client code. */ default ResponseEntity generateClient( String language, GeneratorInput generatorInput) { @@ -83,7 +89,10 @@ default ResponseEntity generateClient( String language, } /** + * @param framework The target generator name (framework is a slight misnomer here, as we may have a framework like Spring implemented in multiple languages). + * @param generatorInput The configuration settings to be used during server generation. * @see GenApi#generateServerForLanguage + * @return A {@link ResponseEntity} referencing the unique download id and a link to download the requested server code. */ default ResponseEntity generateServerForLanguage( String framework, GeneratorInput generatorInput) { @@ -100,7 +109,9 @@ default ResponseEntity generateServerForLanguage( String framewor } /** + * @param language The target generator (language is a misnomer here, but kept for API consistency). * @see GenApi#getClientOptions + * @return A {@link ResponseEntity} of {@link CliOption}, grouped by language (generator name). */ default ResponseEntity> getClientOptions(String language) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -108,7 +119,9 @@ default ResponseEntity> getClientOptions(String language } /** + * @param framework The target generator name (framework is a slight misnomer here, as we may have a framework like Spring implemented in multiple languages). * @see GenApi#getServerOptions + * @return A {@link ResponseEntity} of {@link CliOption}, grouped by framework (generator name). */ default ResponseEntity> getServerOptions( String framework) { return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); @@ -117,6 +130,7 @@ default ResponseEntity> getServerOptions( String framewo /** * @see GenApi#serverOptions + * @return A {@link ResponseEntity} listing options for the target server generator. */ default ResponseEntity> serverOptions() { getRequest().ifPresent(request -> {