Skip to content

Commit 2dd4ab5

Browse files
reinhapareinhapa
committed
Update samples and documentation
Signed-off-by: Patrick Reinhart <[email protected]>
1 parent e4e322e commit 2dd4ab5

File tree

52 files changed

+262
-367
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+262
-367
lines changed

‎docs/generators/java-microprofile.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
6666
|licenseName|The name of the license| |Unlicense|
6767
|licenseUrl|The URL of the license| |http://unlicense.org|
6868
|microprofileFramework|Framework for microprofile. Possible values &quot;kumuluzee&quot;| |null|
69-
|microprofileGlobalExceptionMapper|Should ApiExceptionMapper be annotated with @Provider making it a global exception mapper| |true|
7069
|microprofileMutiny|Whether to use async types for microprofile (currently only Smallrye Mutiny is supported).| |null|
71-
|microprofileRegisterExceptionMapper|Should generated API Clients be annotated with @RegisterProvider(ApiExceptionMapper.class).| |true|
70+
|microprofileRegisterExceptionMapper|Should generated API Clients be annotated with @RegisterProvider(ApiExceptionMapper.class).| |false|
7271
|microprofileRestClientVersion|Version of MicroProfile Rest Client API.| |null|
7372
|modelPackage|package for generated models| |org.openapitools.client.model|
7473
|openApiNullable|Enable OpenAPI Jackson Nullable library. Not supported by `microprofile` library.| |true|

‎docs/generators/java.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,8 @@ These options may be applied as additional-properties (cli) or configOptions (pl
6666
|licenseName|The name of the license| |Unlicense|
6767
|licenseUrl|The URL of the license| |http://unlicense.org|
6868
|microprofileFramework|Framework for microprofile. Possible values &quot;kumuluzee&quot;| |null|
69-
|microprofileGlobalExceptionMapper|Should ApiExceptionMapper be annotated with @Provider making it a global exception mapper| |true|
7069
|microprofileMutiny|Whether to use async types for microprofile (currently only Smallrye Mutiny is supported).| |null|
71-
|microprofileRegisterExceptionMapper|Should generated API Clients be annotated with @RegisterProvider(ApiExceptionMapper.class).| |true|
70+
|microprofileRegisterExceptionMapper|Should generated API Clients be annotated with @RegisterProvider(ApiExceptionMapper.class).| |false|
7271
|microprofileRestClientVersion|Version of MicroProfile Rest Client API.| |null|
7372
|modelPackage|package for generated models| |org.openapitools.client.model|
7473
|openApiNullable|Enable OpenAPI Jackson Nullable library. Not supported by `microprofile` library.| |true|

‎samples/client/petstore/java/microprofile-rest-client-3.0-jackson-mutiny/.openapi-generator/FILES‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ pom.xml
1212
src/main/java/org/openapitools/client/RFC3339DateFormat.java
1313
src/main/java/org/openapitools/client/RFC3339InstantDeserializer.java
1414
src/main/java/org/openapitools/client/RFC3339JavaTimeModule.java
15-
src/main/java/org/openapitools/client/api/ApiException.java
16-
src/main/java/org/openapitools/client/api/ApiExceptionMapper.java
1715
src/main/java/org/openapitools/client/api/PetApi.java
1816
src/main/java/org/openapitools/client/api/StoreApi.java
1917
src/main/java/org/openapitools/client/api/UserApi.java

‎samples/client/petstore/java/microprofile-rest-client-3.0-jackson-mutiny/src/main/java/org/openapitools/client/api/PetApi.java‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
import io.smallrye.mutiny.Uni;
2929

3030

31-
import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
3231
import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
3332

3433
/**
@@ -39,7 +38,6 @@
3938
*/
4039

4140
@RegisterRestClient(configKey="petstore")
42-
@RegisterProvider(ApiExceptionMapper.class)
4341
@Path("/pet")
4442
public interface PetApi {
4543

@@ -53,7 +51,7 @@ public interface PetApi {
5351

5452
@Consumes({ "application/json", "application/xml" })
5553
@Produces({ "application/xml", "application/json" })
56-
Uni<Pet> addPet(Pet pet) throws ApiException, ProcessingException;
54+
Uni<Pet> addPet(Pet pet) throws WebApplicationException, ProcessingException;
5755

5856
/**
5957
* Deletes a pet
@@ -63,7 +61,7 @@ public interface PetApi {
6361
*/
6462
@DELETE
6563
@Path("/{petId}")
66-
Uni<Void> deletePet(@PathParam("petId") Long petId, @HeaderParam("api_key") String apiKey) throws ApiException, ProcessingException;
64+
Uni<Void> deletePet(@PathParam("petId") Long petId, @HeaderParam("api_key") String apiKey) throws WebApplicationException, ProcessingException;
6765

6866
/**
6967
* Finds Pets by status
@@ -74,7 +72,7 @@ public interface PetApi {
7472
@GET
7573
@Path("/findByStatus")
7674
@Produces({ "application/xml", "application/json" })
77-
Uni<List<Pet>> findPetsByStatus(@QueryParam("status") List<String> status) throws ApiException, ProcessingException;
75+
Uni<List<Pet>> findPetsByStatus(@QueryParam("status") List<String> status) throws WebApplicationException, ProcessingException;
7876

7977
/**
8078
* Finds Pets by tags
@@ -87,7 +85,7 @@ public interface PetApi {
8785
@GET
8886
@Path("/findByTags")
8987
@Produces({ "application/xml", "application/json" })
90-
Uni<List<Pet>> findPetsByTags(@QueryParam("tags") List<String> tags) throws ApiException, ProcessingException;
88+
Uni<List<Pet>> findPetsByTags(@QueryParam("tags") List<String> tags) throws WebApplicationException, ProcessingException;
9189

9290
/**
9391
* Find pet by ID
@@ -98,7 +96,7 @@ public interface PetApi {
9896
@GET
9997
@Path("/{petId}")
10098
@Produces({ "application/xml", "application/json" })
101-
Uni<Pet> getPetById(@PathParam("petId") Long petId) throws ApiException, ProcessingException;
99+
Uni<Pet> getPetById(@PathParam("petId") Long petId) throws WebApplicationException, ProcessingException;
102100

103101
/**
104102
* Update an existing pet
@@ -110,7 +108,7 @@ public interface PetApi {
110108

111109
@Consumes({ "application/json", "application/xml" })
112110
@Produces({ "application/xml", "application/json" })
113-
Uni<Pet> updatePet(Pet pet) throws ApiException, ProcessingException;
111+
Uni<Pet> updatePet(Pet pet) throws WebApplicationException, ProcessingException;
114112

115113
/**
116114
* Updates a pet in the store with form data
@@ -121,7 +119,7 @@ public interface PetApi {
121119
@POST
122120
@Path("/{petId}")
123121
@Consumes({ "application/x-www-form-urlencoded" })
124-
Uni<Void> updatePetWithForm(@PathParam("petId") Long petId, @Multipart(value = "name", required = false) String name, @Multipart(value = "status", required = false) String status) throws ApiException, ProcessingException;
122+
Uni<Void> updatePetWithForm(@PathParam("petId") Long petId, @Multipart(value = "name", required = false) String name, @Multipart(value = "status", required = false) String status) throws WebApplicationException, ProcessingException;
125123

126124
/**
127125
* uploads an image
@@ -133,5 +131,5 @@ public interface PetApi {
133131
@Path("/{petId}/uploadImage")
134132
@Consumes({ "multipart/form-data" })
135133
@Produces({ "application/json" })
136-
Uni<ModelApiResponse> uploadFile(@PathParam("petId") Long petId, @Multipart(value = "additionalMetadata", required = false) String additionalMetadata, @Multipart(value = "file" , required = false) Attachment _fileDetail) throws ApiException, ProcessingException;
134+
Uni<ModelApiResponse> uploadFile(@PathParam("petId") Long petId, @Multipart(value = "additionalMetadata", required = false) String additionalMetadata, @Multipart(value = "file" , required = false) Attachment _fileDetail) throws WebApplicationException, ProcessingException;
137135
}

‎samples/client/petstore/java/microprofile-rest-client-3.0-jackson-mutiny/src/main/java/org/openapitools/client/api/StoreApi.java‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
import io.smallrye.mutiny.Uni;
2727

2828

29-
import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
3029
import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
3130

3231
/**
@@ -37,7 +36,6 @@
3736
*/
3837

3938
@RegisterRestClient(configKey="petstore")
40-
@RegisterProvider(ApiExceptionMapper.class)
4139
@Path("/store")
4240
public interface StoreApi {
4341

@@ -49,7 +47,7 @@ public interface StoreApi {
4947
*/
5048
@DELETE
5149
@Path("/order/{orderId}")
52-
Uni<Void> deleteOrder(@PathParam("orderId") String orderId) throws ApiException, ProcessingException;
50+
Uni<Void> deleteOrder(@PathParam("orderId") String orderId) throws WebApplicationException, ProcessingException;
5351

5452
/**
5553
* Returns pet inventories by status
@@ -60,7 +58,7 @@ public interface StoreApi {
6058
@GET
6159
@Path("/inventory")
6260
@Produces({ "application/json" })
63-
Uni<Map<String, Integer>> getInventory() throws ApiException, ProcessingException;
61+
Uni<Map<String, Integer>> getInventory() throws WebApplicationException, ProcessingException;
6462

6563
/**
6664
* Find purchase order by ID
@@ -71,7 +69,7 @@ public interface StoreApi {
7169
@GET
7270
@Path("/order/{orderId}")
7371
@Produces({ "application/xml", "application/json" })
74-
Uni<Order> getOrderById(@PathParam("orderId") Long orderId) throws ApiException, ProcessingException;
72+
Uni<Order> getOrderById(@PathParam("orderId") Long orderId) throws WebApplicationException, ProcessingException;
7573

7674
/**
7775
* Place an order for a pet
@@ -83,5 +81,5 @@ public interface StoreApi {
8381
@Path("/order")
8482
@Consumes({ "application/json" })
8583
@Produces({ "application/xml", "application/json" })
86-
Uni<Order> placeOrder(Order order) throws ApiException, ProcessingException;
84+
Uni<Order> placeOrder(Order order) throws WebApplicationException, ProcessingException;
8785
}

‎samples/client/petstore/java/microprofile-rest-client-3.0-jackson-mutiny/src/main/java/org/openapitools/client/api/UserApi.java‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
import io.smallrye.mutiny.Uni;
2828

2929

30-
import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
3130
import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
3231

3332
/**
@@ -38,7 +37,6 @@
3837
*/
3938

4039
@RegisterRestClient(configKey="petstore")
41-
@RegisterProvider(ApiExceptionMapper.class)
4240
@Path("/user")
4341
public interface UserApi {
4442

@@ -51,7 +49,7 @@ public interface UserApi {
5149
@POST
5250

5351
@Consumes({ "application/json" })
54-
Uni<Void> createUser(User user) throws ApiException, ProcessingException;
52+
Uni<Void> createUser(User user) throws WebApplicationException, ProcessingException;
5553

5654
/**
5755
* Creates list of users with given input array
@@ -62,7 +60,7 @@ public interface UserApi {
6260
@POST
6361
@Path("/createWithArray")
6462
@Consumes({ "application/json" })
65-
Uni<Void> createUsersWithArrayInput(List<User> user) throws ApiException, ProcessingException;
63+
Uni<Void> createUsersWithArrayInput(List<User> user) throws WebApplicationException, ProcessingException;
6664

6765
/**
6866
* Creates list of users with given input array
@@ -73,7 +71,7 @@ public interface UserApi {
7371
@POST
7472
@Path("/createWithList")
7573
@Consumes({ "application/json" })
76-
Uni<Void> createUsersWithListInput(List<User> user) throws ApiException, ProcessingException;
74+
Uni<Void> createUsersWithListInput(List<User> user) throws WebApplicationException, ProcessingException;
7775

7876
/**
7977
* Delete user
@@ -83,7 +81,7 @@ public interface UserApi {
8381
*/
8482
@DELETE
8583
@Path("/{username}")
86-
Uni<Void> deleteUser(@PathParam("username") String username) throws ApiException, ProcessingException;
84+
Uni<Void> deleteUser(@PathParam("username") String username) throws WebApplicationException, ProcessingException;
8785

8886
/**
8987
* Get user by user name
@@ -94,7 +92,7 @@ public interface UserApi {
9492
@GET
9593
@Path("/{username}")
9694
@Produces({ "application/xml", "application/json" })
97-
Uni<User> getUserByName(@PathParam("username") String username) throws ApiException, ProcessingException;
95+
Uni<User> getUserByName(@PathParam("username") String username) throws WebApplicationException, ProcessingException;
9896

9997
/**
10098
* Logs user into the system
@@ -105,7 +103,7 @@ public interface UserApi {
105103
@GET
106104
@Path("/login")
107105
@Produces({ "application/xml", "application/json" })
108-
Uni<String> loginUser(@QueryParam("username") String username, @QueryParam("password") String password) throws ApiException, ProcessingException;
106+
Uni<String> loginUser(@QueryParam("username") String username, @QueryParam("password") String password) throws WebApplicationException, ProcessingException;
109107

110108
/**
111109
* Logs out current logged in user session
@@ -115,7 +113,7 @@ public interface UserApi {
115113
*/
116114
@GET
117115
@Path("/logout")
118-
Uni<Void> logoutUser() throws ApiException, ProcessingException;
116+
Uni<Void> logoutUser() throws WebApplicationException, ProcessingException;
119117

120118
/**
121119
* Updated user
@@ -126,5 +124,5 @@ public interface UserApi {
126124
@PUT
127125
@Path("/{username}")
128126
@Consumes({ "application/json" })
129-
Uni<Void> updateUser(@PathParam("username") String username, User user) throws ApiException, ProcessingException;
127+
Uni<Void> updateUser(@PathParam("username") String username, User user) throws WebApplicationException, ProcessingException;
130128
}

‎samples/client/petstore/java/microprofile-rest-client-3.0-jackson-with-xml/.openapi-generator/FILES‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ pom.xml
1212
src/main/java/org/openapitools/client/RFC3339DateFormat.java
1313
src/main/java/org/openapitools/client/RFC3339InstantDeserializer.java
1414
src/main/java/org/openapitools/client/RFC3339JavaTimeModule.java
15-
src/main/java/org/openapitools/client/api/ApiException.java
16-
src/main/java/org/openapitools/client/api/ApiExceptionMapper.java
1715
src/main/java/org/openapitools/client/api/PetApi.java
1816
src/main/java/org/openapitools/client/api/StoreApi.java
1917
src/main/java/org/openapitools/client/api/UserApi.java

‎samples/client/petstore/java/microprofile-rest-client-3.0-jackson-with-xml/src/main/java/org/openapitools/client/api/PetApi.java‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
import org.apache.cxf.jaxrs.ext.multipart.*;
2828

2929

30-
import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
3130
import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
3231

3332
/**
@@ -38,7 +37,6 @@
3837
*/
3938

4039
@RegisterRestClient(configKey="petstore")
41-
@RegisterProvider(ApiExceptionMapper.class)
4240
@Path("/pet")
4341
public interface PetApi {
4442

@@ -52,7 +50,7 @@ public interface PetApi {
5250

5351
@Consumes({ "application/json", "application/xml" })
5452
@Produces({ "application/xml", "application/json" })
55-
Pet addPet(Pet pet) throws ApiException, ProcessingException;
53+
Pet addPet(Pet pet) throws WebApplicationException, ProcessingException;
5654

5755
/**
5856
* Deletes a pet
@@ -62,7 +60,7 @@ public interface PetApi {
6260
*/
6361
@DELETE
6462
@Path("/{petId}")
65-
void deletePet(@PathParam("petId") Long petId, @HeaderParam("api_key") String apiKey) throws ApiException, ProcessingException;
63+
void deletePet(@PathParam("petId") Long petId, @HeaderParam("api_key") String apiKey) throws WebApplicationException, ProcessingException;
6664

6765
/**
6866
* Finds Pets by status
@@ -73,7 +71,7 @@ public interface PetApi {
7371
@GET
7472
@Path("/findByStatus")
7573
@Produces({ "application/xml", "application/json" })
76-
List<Pet> findPetsByStatus(@QueryParam("status") List<String> status) throws ApiException, ProcessingException;
74+
List<Pet> findPetsByStatus(@QueryParam("status") List<String> status) throws WebApplicationException, ProcessingException;
7775

7876
/**
7977
* Finds Pets by tags
@@ -86,7 +84,7 @@ public interface PetApi {
8684
@GET
8785
@Path("/findByTags")
8886
@Produces({ "application/xml", "application/json" })
89-
List<Pet> findPetsByTags(@QueryParam("tags") List<String> tags) throws ApiException, ProcessingException;
87+
List<Pet> findPetsByTags(@QueryParam("tags") List<String> tags) throws WebApplicationException, ProcessingException;
9088

9189
/**
9290
* Find pet by ID
@@ -97,7 +95,7 @@ public interface PetApi {
9795
@GET
9896
@Path("/{petId}")
9997
@Produces({ "application/xml", "application/json" })
100-
Pet getPetById(@PathParam("petId") Long petId) throws ApiException, ProcessingException;
98+
Pet getPetById(@PathParam("petId") Long petId) throws WebApplicationException, ProcessingException;
10199

102100
/**
103101
* Update an existing pet
@@ -109,7 +107,7 @@ public interface PetApi {
109107

110108
@Consumes({ "application/json", "application/xml" })
111109
@Produces({ "application/xml", "application/json" })
112-
Pet updatePet(Pet pet) throws ApiException, ProcessingException;
110+
Pet updatePet(Pet pet) throws WebApplicationException, ProcessingException;
113111

114112
/**
115113
* Updates a pet in the store with form data
@@ -120,7 +118,7 @@ public interface PetApi {
120118
@POST
121119
@Path("/{petId}")
122120
@Consumes({ "application/x-www-form-urlencoded" })
123-
void updatePetWithForm(@PathParam("petId") Long petId, @Multipart(value = "name", required = false) String name, @Multipart(value = "status", required = false) String status) throws ApiException, ProcessingException;
121+
void updatePetWithForm(@PathParam("petId") Long petId, @Multipart(value = "name", required = false) String name, @Multipart(value = "status", required = false) String status) throws WebApplicationException, ProcessingException;
124122

125123
/**
126124
* uploads an image
@@ -132,5 +130,5 @@ public interface PetApi {
132130
@Path("/{petId}/uploadImage")
133131
@Consumes({ "multipart/form-data" })
134132
@Produces({ "application/json" })
135-
ModelApiResponse uploadFile(@PathParam("petId") Long petId, @Multipart(value = "additionalMetadata", required = false) String additionalMetadata, @Multipart(value = "file" , required = false) Attachment _fileDetail) throws ApiException, ProcessingException;
133+
ModelApiResponse uploadFile(@PathParam("petId") Long petId, @Multipart(value = "additionalMetadata", required = false) String additionalMetadata, @Multipart(value = "file" , required = false) Attachment _fileDetail) throws WebApplicationException, ProcessingException;
136134
}

‎samples/client/petstore/java/microprofile-rest-client-3.0-jackson-with-xml/src/main/java/org/openapitools/client/api/StoreApi.java‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
import org.apache.cxf.jaxrs.ext.multipart.*;
2626

2727

28-
import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
2928
import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
3029

3130
/**
@@ -36,7 +35,6 @@
3635
*/
3736

3837
@RegisterRestClient(configKey="petstore")
39-
@RegisterProvider(ApiExceptionMapper.class)
4038
@Path("/store")
4139
public interface StoreApi {
4240

@@ -48,7 +46,7 @@ public interface StoreApi {
4846
*/
4947
@DELETE
5048
@Path("/order/{orderId}")
51-
void deleteOrder(@PathParam("orderId") String orderId) throws ApiException, ProcessingException;
49+
void deleteOrder(@PathParam("orderId") String orderId) throws WebApplicationException, ProcessingException;
5250

5351
/**
5452
* Returns pet inventories by status
@@ -59,7 +57,7 @@ public interface StoreApi {
5957
@GET
6058
@Path("/inventory")
6159
@Produces({ "application/json" })
62-
Map<String, Integer> getInventory() throws ApiException, ProcessingException;
60+
Map<String, Integer> getInventory() throws WebApplicationException, ProcessingException;
6361

6462
/**
6563
* Find purchase order by ID
@@ -70,7 +68,7 @@ public interface StoreApi {
7068
@GET
7169
@Path("/order/{orderId}")
7270
@Produces({ "application/xml", "application/json" })
73-
Order getOrderById(@PathParam("orderId") Long orderId) throws ApiException, ProcessingException;
71+
Order getOrderById(@PathParam("orderId") Long orderId) throws WebApplicationException, ProcessingException;
7472

7573
/**
7674
* Place an order for a pet
@@ -82,5 +80,5 @@ public interface StoreApi {
8280
@Path("/order")
8381
@Consumes({ "application/json" })
8482
@Produces({ "application/xml", "application/json" })
85-
Order placeOrder(Order order) throws ApiException, ProcessingException;
83+
Order placeOrder(Order order) throws WebApplicationException, ProcessingException;
8684
}

0 commit comments

Comments
 (0)