jlengrand/openapi-generator
1
0
Fork 0
mirror of https://github.com/jlengrand/openapi-generator.git synced 2026-03-10 08:31:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixes javadoc warnings in GenApiDelegate (#140)

Browse Source
This commit is contained in:
Jim Schubert
2018-05-24 11:25:38 -04:00
committed by Jérémie Bresson
parent 7184f1ec68
commit 22e94fb4d8
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
modules/openapi-generator-online/src/main/java/org/openapitools/codegen/online/api/GenApiDelegate.java
View File

@@ -43,6 +43,7 @@ public interface GenApiDelegate {
/**
* @see GenApi#clientOptions
* @return A {@link ResponseEntity} listing options for the target client generator.
*/
default ResponseEntity<List<String>> clientOptions() {
getRequest().ifPresent(request -> {
@@ -58,7 +59,9 @@ public interface GenApiDelegate {
}
/**
* @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<Resource> downloadFile(String fileId) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
@@ -66,7 +69,10 @@ public interface GenApiDelegate {
}
/**
* @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<ResponseCode> generateClient( String language,
GeneratorInput generatorInput) {
@@ -83,7 +89,10 @@ public interface GenApiDelegate {
}
/**
* @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<ResponseCode> generateServerForLanguage( String framework,
GeneratorInput generatorInput) {
@@ -100,7 +109,9 @@ public interface GenApiDelegate {
}
/**
* @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<Map<String, CliOption>> getClientOptions(String language) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
@@ -108,7 +119,9 @@ public interface GenApiDelegate {
}
/**
* @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<Map<String, CliOption>> getServerOptions( String framework) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
@@ -117,6 +130,7 @@ public interface GenApiDelegate {
/**
* @see GenApi#serverOptions
* @return A {@link ResponseEntity} listing options for the target server generator.
*/
default ResponseEntity<List<String>> serverOptions() {
getRequest().ifPresent(request -> {