loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Add javadoc to spring API, controller and delegate (#4693)

Browse Source 
* Add javadoc to spring API, controller and delegate

* Add response description and code in javadoc
This commit is contained in:
Christophe Bornet
2019-12-09 04:15:57 +01:00
committed by William Cheng
parent acc04c5609
commit d405158d3f
114 changed files with 5541 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/AnotherFakeApi.java
View File

@@ -31,6 +31,13 @@ public interface AnotherFakeApi {
return new AnotherFakeApiDelegate() {};
}
/**
* PATCH /another-fake/dummy : To test special tags
* To test special tags and operation ID starting with number
*
* @param body client model (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "To test special tags", nickname = "call123testSpecialTags", notes = "To test special tags and operation ID starting with number", response = Client.class, tags={ "$another-fake?", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Client.class) })

5
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java
View File

@@ -24,6 +24,11 @@ public interface AnotherFakeApiDelegate {
}
/**
* PATCH /another-fake/dummy : To test special tags
* To test special tags and operation ID starting with number
*
* @param body client model (required)
* @return successful operation (status code 200)
* @see AnotherFakeApi#call123testSpecialTags
*/
default ResponseEntity<Client> call123testSpecialTags(Client body) {

136
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApi.java
View File

@@ -41,6 +41,13 @@ public interface FakeApi {
return new FakeApiDelegate() {};
}
/**
* POST /fake/create_xml_item : creates an XmlItem
* this route creates an XmlItem
*
* @param xmlItem XmlItem Body (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "creates an XmlItem", nickname = "createXmlItem", notes = "this route creates an XmlItem", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@@ -52,6 +59,13 @@ public interface FakeApi {
}
/**
* POST /fake/outer/boolean
* Test serialization of outer boolean types
*
* @param body Input boolean as post body (optional)
* @return Output boolean (status code 200)
*/
@ApiOperation(value = "", nickname = "fakeOuterBooleanSerialize", notes = "Test serialization of outer boolean types", response = Boolean.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output boolean", response = Boolean.class) })
@@ -63,6 +77,13 @@ public interface FakeApi {
}
/**
* POST /fake/outer/composite
* Test serialization of object with outer number type
*
* @param body Input composite as post body (optional)
* @return Output composite (status code 200)
*/
@ApiOperation(value = "", nickname = "fakeOuterCompositeSerialize", notes = "Test serialization of object with outer number type", response = OuterComposite.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output composite", response = OuterComposite.class) })
@@ -74,6 +95,13 @@ public interface FakeApi {
}
/**
* POST /fake/outer/number
* Test serialization of outer number types
*
* @param body Input number as post body (optional)
* @return Output number (status code 200)
*/
@ApiOperation(value = "", nickname = "fakeOuterNumberSerialize", notes = "Test serialization of outer number types", response = BigDecimal.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output number", response = BigDecimal.class) })
@@ -85,6 +113,13 @@ public interface FakeApi {
}
/**
* POST /fake/outer/string
* Test serialization of outer string types
*
* @param body Input string as post body (optional)
* @return Output string (status code 200)
*/
@ApiOperation(value = "", nickname = "fakeOuterStringSerialize", notes = "Test serialization of outer string types", response = String.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Output string", response = String.class) })
@@ -96,6 +131,13 @@ public interface FakeApi {
}
/**
* PUT /fake/body-with-file-schema
* For this test, the body for this request much reference a schema named &#x60;File&#x60;.
*
* @param body (required)
* @return Success (status code 200)
*/
@ApiOperation(value = "", nickname = "testBodyWithFileSchema", notes = "For this test, the body for this request much reference a schema named `File`.", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success") })
@@ -107,6 +149,13 @@ public interface FakeApi {
}
/**
* PUT /fake/body-with-query-params
*
* @param query (required)
* @param body (required)
* @return Success (status code 200)
*/
@ApiOperation(value = "", nickname = "testBodyWithQueryParams", notes = "", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success") })
@@ -118,6 +167,13 @@ public interface FakeApi {
}
/**
* PATCH /fake : To test \&quot;client\&quot; model
* To test \&quot;client\&quot; model
*
* @param body client model (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "To test \"client\" model", nickname = "testClientModel", notes = "To test \"client\" model", response = Client.class, tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Client.class) })
@@ -130,6 +186,27 @@ public interface FakeApi {
}
/**
* POST /fake : Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
* Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
*
* @param number None (required)
* @param _double None (required)
* @param patternWithoutDelimiter None (required)
* @param _byte None (required)
* @param integer None (optional)
* @param int32 None (optional)
* @param int64 None (optional)
* @param _float None (optional)
* @param string None (optional)
* @param binary None (optional)
* @param date None (optional)
* @param dateTime None (optional)
* @param password None (optional)
* @param paramCallback None (optional)
* @return Invalid username supplied (status code 400)
* or User not found (status code 404)
*/
@ApiOperation(value = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", nickname = "testEndpointParameters", notes = "Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ", authorizations = {
@Authorization(value = "http_basic_test")
}, tags={ "fake", })
@@ -144,6 +221,21 @@ public interface FakeApi {
}
/**
* GET /fake : To test enum parameters
* To test enum parameters
*
* @param enumHeaderStringArray Header parameter enum test (string array) (optional, default to new ArrayList&lt;&gt;())
* @param enumHeaderString Header parameter enum test (string) (optional, default to -efg)
* @param enumQueryStringArray Query parameter enum test (string array) (optional, default to new ArrayList&lt;&gt;())
* @param enumQueryString Query parameter enum test (string) (optional, default to -efg)
* @param enumQueryInteger Query parameter enum test (double) (optional)
* @param enumQueryDouble Query parameter enum test (double) (optional)
* @param enumFormStringArray Form parameter enum test (string array) (optional, default to $)
* @param enumFormString Form parameter enum test (string) (optional, default to -efg)
* @return Invalid request (status code 400)
* or Not found (status code 404)
*/
@ApiOperation(value = "To test enum parameters", nickname = "testEnumParameters", notes = "To test enum parameters", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid request"),
@@ -156,6 +248,18 @@ public interface FakeApi {
}
/**
* DELETE /fake : Fake endpoint to test group parameters (optional)
* Fake endpoint to test group parameters (optional)
*
* @param requiredStringGroup Required String in group parameters (required)
* @param requiredBooleanGroup Required Boolean in group parameters (required)
* @param requiredInt64Group Required Integer in group parameters (required)
* @param stringGroup String in group parameters (optional)
* @param booleanGroup Boolean in group parameters (optional)
* @param int64Group Integer in group parameters (optional)
* @return Someting wrong (status code 400)
*/
@ApiOperation(value = "Fake endpoint to test group parameters (optional)", nickname = "testGroupParameters", notes = "Fake endpoint to test group parameters (optional)", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Someting wrong") })
@@ -166,6 +270,12 @@ public interface FakeApi {
}
/**
* POST /fake/inline-additionalProperties : test inline additionalProperties
*
* @param param request body (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "test inline additionalProperties", nickname = "testInlineAdditionalProperties", notes = "", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@@ -177,6 +287,13 @@ public interface FakeApi {
}
/**
* GET /fake/jsonFormData : test json serialization of form data
*
* @param param field1 (required)
* @param param2 field2 (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "test json serialization of form data", nickname = "testJsonFormData", notes = "", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@@ -188,6 +305,17 @@ public interface FakeApi {
}
/**
* PUT /fake/test-query-paramters
* To test the collection format in query parameters
*
* @param pipe (required)
* @param ioutil (required)
* @param http (required)
* @param url (required)
* @param context (required)
* @return Success (status code 200)
*/
@ApiOperation(value = "", nickname = "testQueryParameterCollectionFormat", notes = "To test the collection format in query parameters", tags={ "fake", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Success") })
@@ -198,6 +326,14 @@ public interface FakeApi {
}
/**
* POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required)
*
* @param petId ID of pet to update (required)
* @param requiredFile file to upload (required)
* @param additionalMetadata Additional data to pass to server (optional)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "uploads an image (required)", nickname = "uploadFileWithRequiredFile", notes = "", response = ModelApiResponse.class, authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),

106
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeApiDelegate.java
View File

@@ -34,6 +34,11 @@ public interface FakeApiDelegate {
}
/**
* POST /fake/create_xml_item : creates an XmlItem
* this route creates an XmlItem
*
* @param xmlItem XmlItem Body (required)
* @return successful operation (status code 200)
* @see FakeApi#createXmlItem
*/
default ResponseEntity<Void> createXmlItem(XmlItem xmlItem) {
@@ -42,6 +47,11 @@ public interface FakeApiDelegate {
}
/**
* POST /fake/outer/boolean
* Test serialization of outer boolean types
*
* @param body Input boolean as post body (optional)
* @return Output boolean (status code 200)
* @see FakeApi#fakeOuterBooleanSerialize
*/
default ResponseEntity<Boolean> fakeOuterBooleanSerialize(Boolean body) {
@@ -50,6 +60,11 @@ public interface FakeApiDelegate {
}
/**
* POST /fake/outer/composite
* Test serialization of object with outer number type
*
* @param body Input composite as post body (optional)
* @return Output composite (status code 200)
* @see FakeApi#fakeOuterCompositeSerialize
*/
default ResponseEntity<OuterComposite> fakeOuterCompositeSerialize(OuterComposite body) {
@@ -67,6 +82,11 @@ public interface FakeApiDelegate {
}
/**
* POST /fake/outer/number
* Test serialization of outer number types
*
* @param body Input number as post body (optional)
* @return Output number (status code 200)
* @see FakeApi#fakeOuterNumberSerialize
*/
default ResponseEntity<BigDecimal> fakeOuterNumberSerialize(BigDecimal body) {
@@ -75,6 +95,11 @@ public interface FakeApiDelegate {
}
/**
* POST /fake/outer/string
* Test serialization of outer string types
*
* @param body Input string as post body (optional)
* @return Output string (status code 200)
* @see FakeApi#fakeOuterStringSerialize
*/
default ResponseEntity<String> fakeOuterStringSerialize(String body) {
@@ -83,6 +108,11 @@ public interface FakeApiDelegate {
}
/**
* PUT /fake/body-with-file-schema
* For this test, the body for this request much reference a schema named &#x60;File&#x60;.
*
* @param body (required)
* @return Success (status code 200)
* @see FakeApi#testBodyWithFileSchema
*/
default ResponseEntity<Void> testBodyWithFileSchema(FileSchemaTestClass body) {
@@ -91,6 +121,11 @@ public interface FakeApiDelegate {
}
/**
* PUT /fake/body-with-query-params
*
* @param query (required)
* @param body (required)
* @return Success (status code 200)
* @see FakeApi#testBodyWithQueryParams
*/
default ResponseEntity<Void> testBodyWithQueryParams(String query,
@@ -100,6 +135,11 @@ public interface FakeApiDelegate {
}
/**
* PATCH /fake : To test \&quot;client\&quot; model
* To test \&quot;client\&quot; model
*
* @param body client model (required)
* @return successful operation (status code 200)
* @see FakeApi#testClientModel
*/
default ResponseEntity<Client> testClientModel(Client body) {
@@ -117,6 +157,25 @@ public interface FakeApiDelegate {
}
/**
* POST /fake : Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
* Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
*
* @param number None (required)
* @param _double None (required)
* @param patternWithoutDelimiter None (required)
* @param _byte None (required)
* @param integer None (optional)
* @param int32 None (optional)
* @param int64 None (optional)
* @param _float None (optional)
* @param string None (optional)
* @param binary None (optional)
* @param date None (optional)
* @param dateTime None (optional)
* @param password None (optional)
* @param paramCallback None (optional)
* @return Invalid username supplied (status code 400)
* or User not found (status code 404)
* @see FakeApi#testEndpointParameters
*/
default ResponseEntity<Void> testEndpointParameters(BigDecimal number,
@@ -138,6 +197,19 @@ public interface FakeApiDelegate {
}
/**
* GET /fake : To test enum parameters
* To test enum parameters
*
* @param enumHeaderStringArray Header parameter enum test (string array) (optional, default to new ArrayList&lt;&gt;())
* @param enumHeaderString Header parameter enum test (string) (optional, default to -efg)
* @param enumQueryStringArray Query parameter enum test (string array) (optional, default to new ArrayList&lt;&gt;())
* @param enumQueryString Query parameter enum test (string) (optional, default to -efg)
* @param enumQueryInteger Query parameter enum test (double) (optional)
* @param enumQueryDouble Query parameter enum test (double) (optional)
* @param enumFormStringArray Form parameter enum test (string array) (optional, default to $)
* @param enumFormString Form parameter enum test (string) (optional, default to -efg)
* @return Invalid request (status code 400)
* or Not found (status code 404)
* @see FakeApi#testEnumParameters
*/
default ResponseEntity<Void> testEnumParameters(List<String> enumHeaderStringArray,
@@ -153,6 +225,16 @@ public interface FakeApiDelegate {
}
/**
* DELETE /fake : Fake endpoint to test group parameters (optional)
* Fake endpoint to test group parameters (optional)
*
* @param requiredStringGroup Required String in group parameters (required)
* @param requiredBooleanGroup Required Boolean in group parameters (required)
* @param requiredInt64Group Required Integer in group parameters (required)
* @param stringGroup String in group parameters (optional)
* @param booleanGroup Boolean in group parameters (optional)
* @param int64Group Integer in group parameters (optional)
* @return Someting wrong (status code 400)
* @see FakeApi#testGroupParameters
*/
default ResponseEntity<Void> testGroupParameters(Integer requiredStringGroup,
@@ -166,6 +248,10 @@ public interface FakeApiDelegate {
}
/**
* POST /fake/inline-additionalProperties : test inline additionalProperties
*
* @param param request body (required)
* @return successful operation (status code 200)
* @see FakeApi#testInlineAdditionalProperties
*/
default ResponseEntity<Void> testInlineAdditionalProperties(Map<String, String> param) {
@@ -174,6 +260,11 @@ public interface FakeApiDelegate {
}
/**
* GET /fake/jsonFormData : test json serialization of form data
*
* @param param field1 (required)
* @param param2 field2 (required)
* @return successful operation (status code 200)
* @see FakeApi#testJsonFormData
*/
default ResponseEntity<Void> testJsonFormData(String param,
@@ -183,6 +274,15 @@ public interface FakeApiDelegate {
}
/**
* PUT /fake/test-query-paramters
* To test the collection format in query parameters
*
* @param pipe (required)
* @param ioutil (required)
* @param http (required)
* @param url (required)
* @param context (required)
* @return Success (status code 200)
* @see FakeApi#testQueryParameterCollectionFormat
*/
default ResponseEntity<Void> testQueryParameterCollectionFormat(List<String> pipe,
@@ -195,6 +295,12 @@ public interface FakeApiDelegate {
}
/**
* POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required)
*
* @param petId ID of pet to update (required)
* @param requiredFile file to upload (required)
* @param additionalMetadata Additional data to pass to server (optional)
* @return successful operation (status code 200)
* @see FakeApi#uploadFileWithRequiredFile
*/
default ResponseEntity<ModelApiResponse> uploadFileWithRequiredFile(Long petId,

7
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeClassnameTestApi.java
View File

@@ -31,6 +31,13 @@ public interface FakeClassnameTestApi {
return new FakeClassnameTestApiDelegate() {};
}
/**
* PATCH /fake_classname_test : To test class name in snake case
* To test class name in snake case
*
* @param body client model (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "To test class name in snake case", nickname = "testClassname", notes = "To test class name in snake case", response = Client.class, authorizations = {
@Authorization(value = "api_key_query")
}, tags={ "fake_classname_tags 123#$%^", })

5
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java
View File

@@ -24,6 +24,11 @@ public interface FakeClassnameTestApiDelegate {
}
/**
* PATCH /fake_classname_test : To test class name in snake case
* To test class name in snake case
*
* @param body client model (required)
* @return successful operation (status code 200)
* @see FakeClassnameTestApi#testClassname
*/
default ResponseEntity<Client> testClassname(Client body) {

66
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApi.java
View File

@@ -33,6 +33,13 @@ public interface PetApi {
return new PetApiDelegate() {};
}
/**
* POST /pet : Add a new pet to the store
*
* @param body Pet object that needs to be added to the store (required)
* @return successful operation (status code 200)
* or Invalid input (status code 405)
*/
@ApiOperation(value = "Add a new pet to the store", nickname = "addPet", notes = "", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@@ -50,6 +57,14 @@ public interface PetApi {
}
/**
* DELETE /pet/{petId} : Deletes a pet
*
* @param petId Pet id to delete (required)
* @param apiKey (optional)
* @return successful operation (status code 200)
* or Invalid pet value (status code 400)
*/
@ApiOperation(value = "Deletes a pet", nickname = "deletePet", notes = "", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@@ -66,6 +81,14 @@ public interface PetApi {
}
/**
* GET /pet/findByStatus : Finds Pets by status
* Multiple status values can be provided with comma separated strings
*
* @param status Status values that need to be considered for filter (required)
* @return successful operation (status code 200)
* or Invalid status value (status code 400)
*/
@ApiOperation(value = "Finds Pets by status", nickname = "findPetsByStatus", notes = "Multiple status values can be provided with comma separated strings", response = Pet.class, responseContainer = "List", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@@ -83,6 +106,15 @@ public interface PetApi {
}
/**
* GET /pet/findByTags : Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
*
* @param tags Tags to filter by (required)
* @return successful operation (status code 200)
* or Invalid tag value (status code 400)
* @deprecated
*/
@ApiOperation(value = "Finds Pets by tags", nickname = "findPetsByTags", notes = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", response = Pet.class, responseContainer = "List", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@@ -100,6 +132,15 @@ public interface PetApi {
}
/**
* GET /pet/{petId} : Find pet by ID
* Returns a single pet
*
* @param petId ID of pet to return (required)
* @return successful operation (status code 200)
* or Invalid ID supplied (status code 400)
* or Pet not found (status code 404)
*/
@ApiOperation(value = "Find pet by ID", nickname = "getPetById", notes = "Returns a single pet", response = Pet.class, authorizations = {
@Authorization(value = "api_key")
}, tags={ "pet", })
@@ -115,6 +156,15 @@ public interface PetApi {
}
/**
* PUT /pet : Update an existing pet
*
* @param body Pet object that needs to be added to the store (required)
* @return successful operation (status code 200)
* or Invalid ID supplied (status code 400)
* or Pet not found (status code 404)
* or Validation exception (status code 405)
*/
@ApiOperation(value = "Update an existing pet", nickname = "updatePet", notes = "", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@@ -134,6 +184,14 @@ public interface PetApi {
}
/**
* POST /pet/{petId} : Updates a pet in the store with form data
*
* @param petId ID of pet that needs to be updated (required)
* @param name Updated name of the pet (optional)
* @param status Updated status of the pet (optional)
* @return Invalid input (status code 405)
*/
@ApiOperation(value = "Updates a pet in the store with form data", nickname = "updatePetWithForm", notes = "", authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),
@@ -150,6 +208,14 @@ public interface PetApi {
}
/**
* POST /pet/{petId}/uploadImage : uploads an image
*
* @param petId ID of pet to update (required)
* @param additionalMetadata Additional data to pass to server (optional)
* @param file file to upload (optional)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "uploads an image", nickname = "uploadFile", notes = "", response = ModelApiResponse.class, authorizations = {
@Authorization(value = "petstore_auth", scopes = {
@AuthorizationScope(scope = "write:pets", description = "modify pets in your account"),

50
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/PetApiDelegate.java
View File

@@ -26,6 +26,11 @@ public interface PetApiDelegate {
}
/**
* POST /pet : Add a new pet to the store
*
* @param body Pet object that needs to be added to the store (required)
* @return successful operation (status code 200)
* or Invalid input (status code 405)
* @see PetApi#addPet
*/
default ResponseEntity<Void> addPet(Pet body) {
@@ -34,6 +39,12 @@ public interface PetApiDelegate {
}
/**
* DELETE /pet/{petId} : Deletes a pet
*
* @param petId Pet id to delete (required)
* @param apiKey (optional)
* @return successful operation (status code 200)
* or Invalid pet value (status code 400)
* @see PetApi#deletePet
*/
default ResponseEntity<Void> deletePet(Long petId,
@@ -43,6 +54,12 @@ public interface PetApiDelegate {
}
/**
* GET /pet/findByStatus : Finds Pets by status
* Multiple status values can be provided with comma separated strings
*
* @param status Status values that need to be considered for filter (required)
* @return successful operation (status code 200)
* or Invalid status value (status code 400)
* @see PetApi#findPetsByStatus
*/
default ResponseEntity<List<Pet>> findPetsByStatus(List<String> status) {
@@ -65,6 +82,13 @@ public interface PetApiDelegate {
}
/**
* GET /pet/findByTags : Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
*
* @param tags Tags to filter by (required)
* @return successful operation (status code 200)
* or Invalid tag value (status code 400)
* @deprecated
* @see PetApi#findPetsByTags
*/
default ResponseEntity<List<Pet>> findPetsByTags(List<String> tags) {
@@ -87,6 +111,13 @@ public interface PetApiDelegate {
}
/**
* GET /pet/{petId} : Find pet by ID
* Returns a single pet
*
* @param petId ID of pet to return (required)
* @return successful operation (status code 200)
* or Invalid ID supplied (status code 400)
* or Pet not found (status code 404)
* @see PetApi#getPetById
*/
default ResponseEntity<Pet> getPetById(Long petId) {
@@ -109,6 +140,13 @@ public interface PetApiDelegate {
}
/**
* PUT /pet : Update an existing pet
*
* @param body Pet object that needs to be added to the store (required)
* @return successful operation (status code 200)
* or Invalid ID supplied (status code 400)
* or Pet not found (status code 404)
* or Validation exception (status code 405)
* @see PetApi#updatePet
*/
default ResponseEntity<Void> updatePet(Pet body) {
@@ -117,6 +155,12 @@ public interface PetApiDelegate {
}
/**
* POST /pet/{petId} : Updates a pet in the store with form data
*
* @param petId ID of pet that needs to be updated (required)
* @param name Updated name of the pet (optional)
* @param status Updated status of the pet (optional)
* @return Invalid input (status code 405)
* @see PetApi#updatePetWithForm
*/
default ResponseEntity<Void> updatePetWithForm(Long petId,
@@ -127,6 +171,12 @@ public interface PetApiDelegate {
}
/**
* POST /pet/{petId}/uploadImage : uploads an image
*
* @param petId ID of pet to update (required)
* @param additionalMetadata Additional data to pass to server (optional)
* @param file file to upload (optional)
* @return successful operation (status code 200)
* @see PetApi#uploadFile
*/
default ResponseEntity<ModelApiResponse> uploadFile(Long petId,

30
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApi.java
View File

@@ -32,6 +32,14 @@ public interface StoreApi {
return new StoreApiDelegate() {};
}
/**
* DELETE /store/order/{order_id} : Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
*
* @param orderId ID of the order that needs to be deleted (required)
* @return Invalid ID supplied (status code 400)
* or Order not found (status code 404)
*/
@ApiOperation(value = "Delete purchase order by ID", nickname = "deleteOrder", notes = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors", tags={ "store", })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid ID supplied"),
@@ -43,6 +51,12 @@ public interface StoreApi {
}
/**
* GET /store/inventory : Returns pet inventories by status
* Returns a map of status codes to quantities
*
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Returns pet inventories by status", nickname = "getInventory", notes = "Returns a map of status codes to quantities", response = Integer.class, responseContainer = "Map", authorizations = {
@Authorization(value = "api_key")
}, tags={ "store", })
@@ -56,6 +70,15 @@ public interface StoreApi {
}
/**
* GET /store/order/{order_id} : Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
*
* @param orderId ID of pet that needs to be fetched (required)
* @return successful operation (status code 200)
* or Invalid ID supplied (status code 400)
* or Order not found (status code 404)
*/
@ApiOperation(value = "Find purchase order by ID", nickname = "getOrderById", notes = "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions", response = Order.class, tags={ "store", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Order.class),
@@ -69,6 +92,13 @@ public interface StoreApi {
}
/**
* POST /store/order : Place an order for a pet
*
* @param body order placed for purchasing the pet (required)
* @return successful operation (status code 200)
* or Invalid Order (status code 400)
*/
@ApiOperation(value = "Place an order for a pet", nickname = "placeOrder", notes = "", response = Order.class, tags={ "store", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = Order.class),

22
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/StoreApiDelegate.java
View File

@@ -25,6 +25,12 @@ public interface StoreApiDelegate {
}
/**
* DELETE /store/order/{order_id} : Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
*
* @param orderId ID of the order that needs to be deleted (required)
* @return Invalid ID supplied (status code 400)
* or Order not found (status code 404)
* @see StoreApi#deleteOrder
*/
default ResponseEntity<Void> deleteOrder(String orderId) {
@@ -33,6 +39,10 @@ public interface StoreApiDelegate {
}
/**
* GET /store/inventory : Returns pet inventories by status
* Returns a map of status codes to quantities
*
* @return successful operation (status code 200)
* @see StoreApi#getInventory
*/
default ResponseEntity<Map<String, Integer>> getInventory() {
@@ -41,6 +51,13 @@ public interface StoreApiDelegate {
}
/**
* GET /store/order/{order_id} : Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
*
* @param orderId ID of pet that needs to be fetched (required)
* @return successful operation (status code 200)
* or Invalid ID supplied (status code 400)
* or Order not found (status code 404)
* @see StoreApi#getOrderById
*/
default ResponseEntity<Order> getOrderById(Long orderId) {
@@ -63,6 +80,11 @@ public interface StoreApiDelegate {
}
/**
* POST /store/order : Place an order for a pet
*
* @param body order placed for purchasing the pet (required)
* @return successful operation (status code 200)
* or Invalid Order (status code 400)
* @see StoreApi#placeOrder
*/
default ResponseEntity<Order> placeOrder(Order body) {

57
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApi.java
View File

@@ -32,6 +32,13 @@ public interface UserApi {
return new UserApiDelegate() {};
}
/**
* POST /user : Create user
* This can only be done by the logged in user.
*
* @param body Created user object (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Create user", nickname = "createUser", notes = "This can only be done by the logged in user.", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@@ -42,6 +49,12 @@ public interface UserApi {
}
/**
* POST /user/createWithArray : Creates list of users with given input array
*
* @param body List of user object (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithArrayInput", notes = "", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@@ -52,6 +65,12 @@ public interface UserApi {
}
/**
* POST /user/createWithList : Creates list of users with given input array
*
* @param body List of user object (required)
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Creates list of users with given input array", nickname = "createUsersWithListInput", notes = "", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@@ -62,6 +81,14 @@ public interface UserApi {
}
/**
* DELETE /user/{username} : Delete user
* This can only be done by the logged in user.
*
* @param username The name that needs to be deleted (required)
* @return Invalid username supplied (status code 400)
* or User not found (status code 404)
*/
@ApiOperation(value = "Delete user", nickname = "deleteUser", notes = "This can only be done by the logged in user.", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid username supplied"),
@@ -73,6 +100,14 @@ public interface UserApi {
}
/**
* GET /user/{username} : Get user by user name
*
* @param username The name that needs to be fetched. Use user1 for testing. (required)
* @return successful operation (status code 200)
* or Invalid username supplied (status code 400)
* or User not found (status code 404)
*/
@ApiOperation(value = "Get user by user name", nickname = "getUserByName", notes = "", response = User.class, tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = User.class),
@@ -86,6 +121,14 @@ public interface UserApi {
}
/**
* GET /user/login : Logs user into the system
*
* @param username The user name for login (required)
* @param password The password for login in clear text (required)
* @return successful operation (status code 200)
* or Invalid username/password supplied (status code 400)
*/
@ApiOperation(value = "Logs user into the system", nickname = "loginUser", notes = "", response = String.class, tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation", response = String.class),
@@ -98,6 +141,11 @@ public interface UserApi {
}
/**
* GET /user/logout : Logs out current logged in user session
*
* @return successful operation (status code 200)
*/
@ApiOperation(value = "Logs out current logged in user session", nickname = "logoutUser", notes = "", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 200, message = "successful operation") })
@@ -108,6 +156,15 @@ public interface UserApi {
}
/**
* PUT /user/{username} : Updated user
* This can only be done by the logged in user.
*
* @param username name that need to be deleted (required)
* @param body Updated user object (required)
* @return Invalid user supplied (status code 400)
* or User not found (status code 404)
*/
@ApiOperation(value = "Updated user", nickname = "updateUser", notes = "This can only be done by the logged in user.", tags={ "user", })
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid user supplied"),

41
samples/server/petstore/springboot-delegate-j8/src/main/java/org/openapitools/api/UserApiDelegate.java
View File

@@ -25,6 +25,11 @@ public interface UserApiDelegate {
}
/**
* POST /user : Create user
* This can only be done by the logged in user.
*
* @param body Created user object (required)
* @return successful operation (status code 200)
* @see UserApi#createUser
*/
default ResponseEntity<Void> createUser(User body) {
@@ -33,6 +38,10 @@ public interface UserApiDelegate {
}
/**
* POST /user/createWithArray : Creates list of users with given input array
*
* @param body List of user object (required)
* @return successful operation (status code 200)
* @see UserApi#createUsersWithArrayInput
*/
default ResponseEntity<Void> createUsersWithArrayInput(List<User> body) {
@@ -41,6 +50,10 @@ public interface UserApiDelegate {
}
/**
* POST /user/createWithList : Creates list of users with given input array
*
* @param body List of user object (required)
* @return successful operation (status code 200)
* @see UserApi#createUsersWithListInput
*/
default ResponseEntity<Void> createUsersWithListInput(List<User> body) {
@@ -49,6 +62,12 @@ public interface UserApiDelegate {
}
/**
* DELETE /user/{username} : Delete user
* This can only be done by the logged in user.
*
* @param username The name that needs to be deleted (required)
* @return Invalid username supplied (status code 400)
* or User not found (status code 404)
* @see UserApi#deleteUser
*/
default ResponseEntity<Void> deleteUser(String username) {
@@ -57,6 +76,12 @@ public interface UserApiDelegate {
}
/**
* GET /user/{username} : Get user by user name
*
* @param username The name that needs to be fetched. Use user1 for testing. (required)
* @return successful operation (status code 200)
* or Invalid username supplied (status code 400)
* or User not found (status code 404)
* @see UserApi#getUserByName
*/
default ResponseEntity<User> getUserByName(String username) {
@@ -79,6 +104,12 @@ public interface UserApiDelegate {
}
/**
* GET /user/login : Logs user into the system
*
* @param username The user name for login (required)
* @param password The password for login in clear text (required)
* @return successful operation (status code 200)
* or Invalid username/password supplied (status code 400)
* @see UserApi#loginUser
*/
default ResponseEntity<String> loginUser(String username,
@@ -88,6 +119,9 @@ public interface UserApiDelegate {
}
/**
* GET /user/logout : Logs out current logged in user session
*
* @return successful operation (status code 200)
* @see UserApi#logoutUser
*/
default ResponseEntity<Void> logoutUser() {
@@ -96,6 +130,13 @@ public interface UserApiDelegate {
}
/**
* PUT /user/{username} : Updated user
* This can only be done by the logged in user.
*
* @param username name that need to be deleted (required)
* @param body Updated user object (required)
* @return Invalid user supplied (status code 400)
* or User not found (status code 404)
* @see UserApi#updateUser
*/
default ResponseEntity<Void> updateUser(String username,