Skip to content

Fixes javadoc warnings in GenApiDelegate #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 24, 2018
Merged

Fixes javadoc warnings in GenApiDelegate #140

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions ...pi-generator-online/src/main/java/org/openapitools/codegen/online/api/GenApiDelegate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ default Optional<NativeWebRequest> getRequest() {

/**
* @see GenApi#clientOptions
* @return A {@link ResponseEntity} listing options for the target client generator.
*/
default ResponseEntity<List<String>> clientOptions() {
getRequest().ifPresent(request -> {
Expand All @@ -58,15 +59,20 @@ default ResponseEntity<List<String>> 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<Resource> downloadFile(String fileId) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}

/**
* @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) {
Expand All @@ -83,7 +89,10 @@ default ResponseEntity<ResponseCode> 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<ResponseCode> generateServerForLanguage( String framework,
GeneratorInput generatorInput) {
Expand All @@ -100,15 +109,19 @@ default ResponseEntity<ResponseCode> 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<Map<String, CliOption>> getClientOptions(String language) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

}

/**
* @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);
Expand All @@ -117,6 +130,7 @@ default ResponseEntity<Map<String, CliOption>> getServerOptions( String framewo

/**
* @see GenApi#serverOptions
* @return A {@link ResponseEntity} listing options for the target server generator.
*/
default ResponseEntity<List<String>> serverOptions() {
getRequest().ifPresent(request -> {
Expand Down