You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geronimo.apache.org by Ivan Junckes Filho <iv...@gmail.com> on 2019/01/17 11:54:10 UTC
OpenAPI integration with metrics/health
Hey guys, I was trying to make the openapi document generated by
geronimo-openapi to work with swagger-ui. The issue is I can't execute
requests from swagger-ui in the endpoints generated (metrics, health,
openapi) by TomEE as they don't have a @ApiResponse annotation and
swagger-ui doesn't display the message without that.
What do you guys think of having this annotation by default in the
endpoints? At least for 200?
Or anyone has a better solution for this?
Re: OpenAPI integration with metrics/health
Posted by Ivan Junckes Filho <iv...@gmail.com>.
Cool thanks Romain.
On Fri, Jan 25, 2019 at 12:19 PM Romain Manni-Bucau <rm...@gmail.com>
wrote:
> likely end of next week it sounds feasible
>
> Romain Manni-Bucau
> @rmannibucau <https://twitter.com/rmannibucau> | Blog
> <https://rmannibucau.metawerx.net/> | Old Blog
> <http://rmannibucau.wordpress.com> | Github
> <https://github.com/rmannibucau> | LinkedIn
> <https://www.linkedin.com/in/rmannibucau> | Book
> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>
>
> Le ven. 25 janv. 2019 à 15:18, Ivan Junckes Filho <iv...@gmail.com>
> a écrit :
>
>> I was trying to fix this in TomEE side
>> https://issues.apache.org/jira/browse/GERONIMO-6689.
>>
>> But I just saw it got fixed in Geronimo side this week.
>>
>> @Romain Manni-Bucau <rm...@gmail.com> would you be able to do a
>> release with this change and add it to TomEE release if there is time?
>>
>> On Fri, Jan 18, 2019 at 10:46 AM Ivan Junckes Filho <
>> ivanjunckes@gmail.com> wrote:
>>
>>> Thanks Romain, I will have a look.
>>>
>>> On Fri, Jan 18, 2019 at 10:41 AM Romain Manni-Bucau <
>>> rmannibucau@gmail.com> wrote:
>>>
>>>> You can use:
>>>>
>>>> void start(@Observes @intiialzed(ApplicationScoped.class) Object event,
>>>> final GeronimoOpenAPIExtension ext, final Application app) {
>>>> final OpenAPI openapi = ext.getOrCreateOpenAPI(app);
>>>> }
>>>>
>>>> if you have a single app or collect them in the extension and call the
>>>> same method for all of them
>>>>
>>>> Romain Manni-Bucau
>>>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>>>> <https://rmannibucau.metawerx.net/> | Old Blog
>>>> <http://rmannibucau.wordpress.com> | Github
>>>> <https://github.com/rmannibucau> | LinkedIn
>>>> <https://www.linkedin.com/in/rmannibucau> | Book
>>>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>>>
>>>>
>>>> Le ven. 18 janv. 2019 à 13:00, Ivan Junckes Filho <
>>>> ivanjunckes@gmail.com> a écrit :
>>>>
>>>>> Cool I will have a look next week. Can you point out which event is it?
>>>>>
>>>>> On Thu, Jan 17, 2019 at 1:52 PM Romain Manni-Bucau <
>>>>> rmannibucau@gmail.com> wrote:
>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>> Le jeu. 17 janv. 2019 à 16:49, Ivan Junckes Filho <
>>>>>> ivanjunckes@gmail.com> a écrit :
>>>>>>
>>>>>>> On Thu, Jan 17, 2019 at 12:11 PM Romain Manni-Bucau <
>>>>>>> rmannibucau@gmail.com> wrote:
>>>>>>>
>>>>>>>> I would prefer to not leak specs between them since they are used
>>>>>>>> without the others today.
>>>>>>>>
>>>>>>>> What is missing for it to work, returned types are explicit no?
>>>>>>>>
>>>>>>> It misses ResponseCodes, without that swagger ui doesn't work.
>>>>>>>
>>>>>>
>>>>>> Ok, 200/204 should definitely work
>>>>>>
>>>>>>
>>>>>>> Last releases got some work to have it working OOTB so this can
>>>>>>>> likely be enhanced again if required.
>>>>>>>>
>>>>>>> What is OOTB?
>>>>>>>
>>>>>>
>>>>>> out of the box ;)
>>>>>>
>>>>>>
>>>>>>> Also something unclear is if they should appear or not in the
>>>>>>>> openapi report (we made the choice to do but it is not required AFAIK)
>>>>>>>>
>>>>>>>> In my opinion we should keep it, but have at list a basic
>>>>>>> configure. @ResponseCode 200 should be there as it is the expected response
>>>>>>> code.
>>>>>>>
>>>>>>
>>>>>> it must be implicit anyway
>>>>>>
>>>>>>
>>>>>>> Another option for tomee would be to enrich the OpenAPI with what it
>>>>>>>> need, there is the API for that.
>>>>>>>>
>>>>>>>> Can you elaborate?
>>>>>>>
>>>>>>
>>>>>> IIRC there is an event fired with OpenAPI model, tomee can observe it
>>>>>> and add all the doc it needs, including its internal endpoints or tomee
>>>>>> webapp
>>>>>>
>>>>>>
>>>>>>> Romain Manni-Bucau
>>>>>>>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>>>>>>>> <https://rmannibucau.metawerx.net/> | Old Blog
>>>>>>>> <http://rmannibucau.wordpress.com> | Github
>>>>>>>> <https://github.com/rmannibucau> | LinkedIn
>>>>>>>> <https://www.linkedin.com/in/rmannibucau> | Book
>>>>>>>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>>>>>>>
>>>>>>>>
>>>>>>>> Le jeu. 17 janv. 2019 à 14:49, Ivan Junckes Filho <
>>>>>>>> ivanjunckes@gmail.com> a écrit :
>>>>>>>>
>>>>>>>>> Hey guys, I was trying to make the openapi document generated by
>>>>>>>>> geronimo-openapi to work with swagger-ui. The issue is I can't execute
>>>>>>>>> requests from swagger-ui in the endpoints generated (metrics, health,
>>>>>>>>> openapi) by TomEE as they don't have a @ApiResponse annotation and
>>>>>>>>> swagger-ui doesn't display the message without that.
>>>>>>>>>
>>>>>>>>> What do you guys think of having this annotation by default in the
>>>>>>>>> endpoints? At least for 200?
>>>>>>>>>
>>>>>>>>> Or anyone has a better solution for this?
>>>>>>>>>
>>>>>>>>
Re: OpenAPI integration with metrics/health
Posted by Romain Manni-Bucau <rm...@gmail.com>.
likely end of next week it sounds feasible
Romain Manni-Bucau
@rmannibucau <https://twitter.com/rmannibucau> | Blog
<https://rmannibucau.metawerx.net/> | Old Blog
<http://rmannibucau.wordpress.com> | Github <https://github.com/rmannibucau> |
LinkedIn <https://www.linkedin.com/in/rmannibucau> | Book
<https://www.packtpub.com/application-development/java-ee-8-high-performance>
Le ven. 25 janv. 2019 à 15:18, Ivan Junckes Filho <iv...@gmail.com> a
écrit :
> I was trying to fix this in TomEE side
> https://issues.apache.org/jira/browse/GERONIMO-6689.
>
> But I just saw it got fixed in Geronimo side this week.
>
> @Romain Manni-Bucau <rm...@gmail.com> would you be able to do a
> release with this change and add it to TomEE release if there is time?
>
> On Fri, Jan 18, 2019 at 10:46 AM Ivan Junckes Filho <iv...@gmail.com>
> wrote:
>
>> Thanks Romain, I will have a look.
>>
>> On Fri, Jan 18, 2019 at 10:41 AM Romain Manni-Bucau <
>> rmannibucau@gmail.com> wrote:
>>
>>> You can use:
>>>
>>> void start(@Observes @intiialzed(ApplicationScoped.class) Object event,
>>> final GeronimoOpenAPIExtension ext, final Application app) {
>>> final OpenAPI openapi = ext.getOrCreateOpenAPI(app);
>>> }
>>>
>>> if you have a single app or collect them in the extension and call the
>>> same method for all of them
>>>
>>> Romain Manni-Bucau
>>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>>> <https://rmannibucau.metawerx.net/> | Old Blog
>>> <http://rmannibucau.wordpress.com> | Github
>>> <https://github.com/rmannibucau> | LinkedIn
>>> <https://www.linkedin.com/in/rmannibucau> | Book
>>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>>
>>>
>>> Le ven. 18 janv. 2019 à 13:00, Ivan Junckes Filho <iv...@gmail.com>
>>> a écrit :
>>>
>>>> Cool I will have a look next week. Can you point out which event is it?
>>>>
>>>> On Thu, Jan 17, 2019 at 1:52 PM Romain Manni-Bucau <
>>>> rmannibucau@gmail.com> wrote:
>>>>
>>>>>
>>>>>
>>>>>
>>>>> Le jeu. 17 janv. 2019 à 16:49, Ivan Junckes Filho <
>>>>> ivanjunckes@gmail.com> a écrit :
>>>>>
>>>>>> On Thu, Jan 17, 2019 at 12:11 PM Romain Manni-Bucau <
>>>>>> rmannibucau@gmail.com> wrote:
>>>>>>
>>>>>>> I would prefer to not leak specs between them since they are used
>>>>>>> without the others today.
>>>>>>>
>>>>>>> What is missing for it to work, returned types are explicit no?
>>>>>>>
>>>>>> It misses ResponseCodes, without that swagger ui doesn't work.
>>>>>>
>>>>>
>>>>> Ok, 200/204 should definitely work
>>>>>
>>>>>
>>>>>> Last releases got some work to have it working OOTB so this can
>>>>>>> likely be enhanced again if required.
>>>>>>>
>>>>>> What is OOTB?
>>>>>>
>>>>>
>>>>> out of the box ;)
>>>>>
>>>>>
>>>>>> Also something unclear is if they should appear or not in the openapi
>>>>>>> report (we made the choice to do but it is not required AFAIK)
>>>>>>>
>>>>>>> In my opinion we should keep it, but have at list a basic configure.
>>>>>> @ResponseCode 200 should be there as it is the expected response code.
>>>>>>
>>>>>
>>>>> it must be implicit anyway
>>>>>
>>>>>
>>>>>> Another option for tomee would be to enrich the OpenAPI with what it
>>>>>>> need, there is the API for that.
>>>>>>>
>>>>>>> Can you elaborate?
>>>>>>
>>>>>
>>>>> IIRC there is an event fired with OpenAPI model, tomee can observe it
>>>>> and add all the doc it needs, including its internal endpoints or tomee
>>>>> webapp
>>>>>
>>>>>
>>>>>> Romain Manni-Bucau
>>>>>>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>>>>>>> <https://rmannibucau.metawerx.net/> | Old Blog
>>>>>>> <http://rmannibucau.wordpress.com> | Github
>>>>>>> <https://github.com/rmannibucau> | LinkedIn
>>>>>>> <https://www.linkedin.com/in/rmannibucau> | Book
>>>>>>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>>>>>>
>>>>>>>
>>>>>>> Le jeu. 17 janv. 2019 à 14:49, Ivan Junckes Filho <
>>>>>>> ivanjunckes@gmail.com> a écrit :
>>>>>>>
>>>>>>>> Hey guys, I was trying to make the openapi document generated by
>>>>>>>> geronimo-openapi to work with swagger-ui. The issue is I can't execute
>>>>>>>> requests from swagger-ui in the endpoints generated (metrics, health,
>>>>>>>> openapi) by TomEE as they don't have a @ApiResponse annotation and
>>>>>>>> swagger-ui doesn't display the message without that.
>>>>>>>>
>>>>>>>> What do you guys think of having this annotation by default in the
>>>>>>>> endpoints? At least for 200?
>>>>>>>>
>>>>>>>> Or anyone has a better solution for this?
>>>>>>>>
>>>>>>>
Re: OpenAPI integration with metrics/health
Posted by Ivan Junckes Filho <iv...@gmail.com>.
I was trying to fix this in TomEE side
https://issues.apache.org/jira/browse/GERONIMO-6689.
But I just saw it got fixed in Geronimo side this week.
@Romain Manni-Bucau <rm...@gmail.com> would you be able to do a
release with this change and add it to TomEE release if there is time?
On Fri, Jan 18, 2019 at 10:46 AM Ivan Junckes Filho <iv...@gmail.com>
wrote:
> Thanks Romain, I will have a look.
>
> On Fri, Jan 18, 2019 at 10:41 AM Romain Manni-Bucau <rm...@gmail.com>
> wrote:
>
>> You can use:
>>
>> void start(@Observes @intiialzed(ApplicationScoped.class) Object event,
>> final GeronimoOpenAPIExtension ext, final Application app) {
>> final OpenAPI openapi = ext.getOrCreateOpenAPI(app);
>> }
>>
>> if you have a single app or collect them in the extension and call the
>> same method for all of them
>>
>> Romain Manni-Bucau
>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>> <https://rmannibucau.metawerx.net/> | Old Blog
>> <http://rmannibucau.wordpress.com> | Github
>> <https://github.com/rmannibucau> | LinkedIn
>> <https://www.linkedin.com/in/rmannibucau> | Book
>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>
>>
>> Le ven. 18 janv. 2019 à 13:00, Ivan Junckes Filho <iv...@gmail.com>
>> a écrit :
>>
>>> Cool I will have a look next week. Can you point out which event is it?
>>>
>>> On Thu, Jan 17, 2019 at 1:52 PM Romain Manni-Bucau <
>>> rmannibucau@gmail.com> wrote:
>>>
>>>>
>>>>
>>>>
>>>> Le jeu. 17 janv. 2019 à 16:49, Ivan Junckes Filho <
>>>> ivanjunckes@gmail.com> a écrit :
>>>>
>>>>> On Thu, Jan 17, 2019 at 12:11 PM Romain Manni-Bucau <
>>>>> rmannibucau@gmail.com> wrote:
>>>>>
>>>>>> I would prefer to not leak specs between them since they are used
>>>>>> without the others today.
>>>>>>
>>>>>> What is missing for it to work, returned types are explicit no?
>>>>>>
>>>>> It misses ResponseCodes, without that swagger ui doesn't work.
>>>>>
>>>>
>>>> Ok, 200/204 should definitely work
>>>>
>>>>
>>>>> Last releases got some work to have it working OOTB so this can likely
>>>>>> be enhanced again if required.
>>>>>>
>>>>> What is OOTB?
>>>>>
>>>>
>>>> out of the box ;)
>>>>
>>>>
>>>>> Also something unclear is if they should appear or not in the openapi
>>>>>> report (we made the choice to do but it is not required AFAIK)
>>>>>>
>>>>>> In my opinion we should keep it, but have at list a basic configure.
>>>>> @ResponseCode 200 should be there as it is the expected response code.
>>>>>
>>>>
>>>> it must be implicit anyway
>>>>
>>>>
>>>>> Another option for tomee would be to enrich the OpenAPI with what it
>>>>>> need, there is the API for that.
>>>>>>
>>>>>> Can you elaborate?
>>>>>
>>>>
>>>> IIRC there is an event fired with OpenAPI model, tomee can observe it
>>>> and add all the doc it needs, including its internal endpoints or tomee
>>>> webapp
>>>>
>>>>
>>>>> Romain Manni-Bucau
>>>>>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>>>>>> <https://rmannibucau.metawerx.net/> | Old Blog
>>>>>> <http://rmannibucau.wordpress.com> | Github
>>>>>> <https://github.com/rmannibucau> | LinkedIn
>>>>>> <https://www.linkedin.com/in/rmannibucau> | Book
>>>>>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>>>>>
>>>>>>
>>>>>> Le jeu. 17 janv. 2019 à 14:49, Ivan Junckes Filho <
>>>>>> ivanjunckes@gmail.com> a écrit :
>>>>>>
>>>>>>> Hey guys, I was trying to make the openapi document generated by
>>>>>>> geronimo-openapi to work with swagger-ui. The issue is I can't execute
>>>>>>> requests from swagger-ui in the endpoints generated (metrics, health,
>>>>>>> openapi) by TomEE as they don't have a @ApiResponse annotation and
>>>>>>> swagger-ui doesn't display the message without that.
>>>>>>>
>>>>>>> What do you guys think of having this annotation by default in the
>>>>>>> endpoints? At least for 200?
>>>>>>>
>>>>>>> Or anyone has a better solution for this?
>>>>>>>
>>>>>>
Re: OpenAPI integration with metrics/health
Posted by Ivan Junckes Filho <iv...@gmail.com>.
Thanks Romain, I will have a look.
On Fri, Jan 18, 2019 at 10:41 AM Romain Manni-Bucau <rm...@gmail.com>
wrote:
> You can use:
>
> void start(@Observes @intiialzed(ApplicationScoped.class) Object event,
> final GeronimoOpenAPIExtension ext, final Application app) {
> final OpenAPI openapi = ext.getOrCreateOpenAPI(app);
> }
>
> if you have a single app or collect them in the extension and call the
> same method for all of them
>
> Romain Manni-Bucau
> @rmannibucau <https://twitter.com/rmannibucau> | Blog
> <https://rmannibucau.metawerx.net/> | Old Blog
> <http://rmannibucau.wordpress.com> | Github
> <https://github.com/rmannibucau> | LinkedIn
> <https://www.linkedin.com/in/rmannibucau> | Book
> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>
>
> Le ven. 18 janv. 2019 à 13:00, Ivan Junckes Filho <iv...@gmail.com>
> a écrit :
>
>> Cool I will have a look next week. Can you point out which event is it?
>>
>> On Thu, Jan 17, 2019 at 1:52 PM Romain Manni-Bucau <rm...@gmail.com>
>> wrote:
>>
>>>
>>>
>>>
>>> Le jeu. 17 janv. 2019 à 16:49, Ivan Junckes Filho <iv...@gmail.com>
>>> a écrit :
>>>
>>>> On Thu, Jan 17, 2019 at 12:11 PM Romain Manni-Bucau <
>>>> rmannibucau@gmail.com> wrote:
>>>>
>>>>> I would prefer to not leak specs between them since they are used
>>>>> without the others today.
>>>>>
>>>>> What is missing for it to work, returned types are explicit no?
>>>>>
>>>> It misses ResponseCodes, without that swagger ui doesn't work.
>>>>
>>>
>>> Ok, 200/204 should definitely work
>>>
>>>
>>>> Last releases got some work to have it working OOTB so this can likely
>>>>> be enhanced again if required.
>>>>>
>>>> What is OOTB?
>>>>
>>>
>>> out of the box ;)
>>>
>>>
>>>> Also something unclear is if they should appear or not in the openapi
>>>>> report (we made the choice to do but it is not required AFAIK)
>>>>>
>>>>> In my opinion we should keep it, but have at list a basic configure.
>>>> @ResponseCode 200 should be there as it is the expected response code.
>>>>
>>>
>>> it must be implicit anyway
>>>
>>>
>>>> Another option for tomee would be to enrich the OpenAPI with what it
>>>>> need, there is the API for that.
>>>>>
>>>>> Can you elaborate?
>>>>
>>>
>>> IIRC there is an event fired with OpenAPI model, tomee can observe it
>>> and add all the doc it needs, including its internal endpoints or tomee
>>> webapp
>>>
>>>
>>>> Romain Manni-Bucau
>>>>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>>>>> <https://rmannibucau.metawerx.net/> | Old Blog
>>>>> <http://rmannibucau.wordpress.com> | Github
>>>>> <https://github.com/rmannibucau> | LinkedIn
>>>>> <https://www.linkedin.com/in/rmannibucau> | Book
>>>>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>>>>
>>>>>
>>>>> Le jeu. 17 janv. 2019 à 14:49, Ivan Junckes Filho <
>>>>> ivanjunckes@gmail.com> a écrit :
>>>>>
>>>>>> Hey guys, I was trying to make the openapi document generated by
>>>>>> geronimo-openapi to work with swagger-ui. The issue is I can't execute
>>>>>> requests from swagger-ui in the endpoints generated (metrics, health,
>>>>>> openapi) by TomEE as they don't have a @ApiResponse annotation and
>>>>>> swagger-ui doesn't display the message without that.
>>>>>>
>>>>>> What do you guys think of having this annotation by default in the
>>>>>> endpoints? At least for 200?
>>>>>>
>>>>>> Or anyone has a better solution for this?
>>>>>>
>>>>>
Re: OpenAPI integration with metrics/health
Posted by Romain Manni-Bucau <rm...@gmail.com>.
You can use:
void start(@Observes @intiialzed(ApplicationScoped.class) Object event,
final GeronimoOpenAPIExtension ext, final Application app) {
final OpenAPI openapi = ext.getOrCreateOpenAPI(app);
}
if you have a single app or collect them in the extension and call the same
method for all of them
Romain Manni-Bucau
@rmannibucau <https://twitter.com/rmannibucau> | Blog
<https://rmannibucau.metawerx.net/> | Old Blog
<http://rmannibucau.wordpress.com> | Github <https://github.com/rmannibucau> |
LinkedIn <https://www.linkedin.com/in/rmannibucau> | Book
<https://www.packtpub.com/application-development/java-ee-8-high-performance>
Le ven. 18 janv. 2019 à 13:00, Ivan Junckes Filho <iv...@gmail.com> a
écrit :
> Cool I will have a look next week. Can you point out which event is it?
>
> On Thu, Jan 17, 2019 at 1:52 PM Romain Manni-Bucau <rm...@gmail.com>
> wrote:
>
>>
>>
>>
>> Le jeu. 17 janv. 2019 à 16:49, Ivan Junckes Filho <iv...@gmail.com>
>> a écrit :
>>
>>> On Thu, Jan 17, 2019 at 12:11 PM Romain Manni-Bucau <
>>> rmannibucau@gmail.com> wrote:
>>>
>>>> I would prefer to not leak specs between them since they are used
>>>> without the others today.
>>>>
>>>> What is missing for it to work, returned types are explicit no?
>>>>
>>> It misses ResponseCodes, without that swagger ui doesn't work.
>>>
>>
>> Ok, 200/204 should definitely work
>>
>>
>>> Last releases got some work to have it working OOTB so this can likely
>>>> be enhanced again if required.
>>>>
>>> What is OOTB?
>>>
>>
>> out of the box ;)
>>
>>
>>> Also something unclear is if they should appear or not in the openapi
>>>> report (we made the choice to do but it is not required AFAIK)
>>>>
>>>> In my opinion we should keep it, but have at list a basic configure.
>>> @ResponseCode 200 should be there as it is the expected response code.
>>>
>>
>> it must be implicit anyway
>>
>>
>>> Another option for tomee would be to enrich the OpenAPI with what it
>>>> need, there is the API for that.
>>>>
>>>> Can you elaborate?
>>>
>>
>> IIRC there is an event fired with OpenAPI model, tomee can observe it and
>> add all the doc it needs, including its internal endpoints or tomee webapp
>>
>>
>>> Romain Manni-Bucau
>>>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>>>> <https://rmannibucau.metawerx.net/> | Old Blog
>>>> <http://rmannibucau.wordpress.com> | Github
>>>> <https://github.com/rmannibucau> | LinkedIn
>>>> <https://www.linkedin.com/in/rmannibucau> | Book
>>>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>>>
>>>>
>>>> Le jeu. 17 janv. 2019 à 14:49, Ivan Junckes Filho <
>>>> ivanjunckes@gmail.com> a écrit :
>>>>
>>>>> Hey guys, I was trying to make the openapi document generated by
>>>>> geronimo-openapi to work with swagger-ui. The issue is I can't execute
>>>>> requests from swagger-ui in the endpoints generated (metrics, health,
>>>>> openapi) by TomEE as they don't have a @ApiResponse annotation and
>>>>> swagger-ui doesn't display the message without that.
>>>>>
>>>>> What do you guys think of having this annotation by default in the
>>>>> endpoints? At least for 200?
>>>>>
>>>>> Or anyone has a better solution for this?
>>>>>
>>>>
Re: OpenAPI integration with metrics/health
Posted by Ivan Junckes Filho <iv...@gmail.com>.
Cool I will have a look next week. Can you point out which event is it?
On Thu, Jan 17, 2019 at 1:52 PM Romain Manni-Bucau <rm...@gmail.com>
wrote:
>
>
>
> Le jeu. 17 janv. 2019 à 16:49, Ivan Junckes Filho <iv...@gmail.com>
> a écrit :
>
>> On Thu, Jan 17, 2019 at 12:11 PM Romain Manni-Bucau <
>> rmannibucau@gmail.com> wrote:
>>
>>> I would prefer to not leak specs between them since they are used
>>> without the others today.
>>>
>>> What is missing for it to work, returned types are explicit no?
>>>
>> It misses ResponseCodes, without that swagger ui doesn't work.
>>
>
> Ok, 200/204 should definitely work
>
>
>> Last releases got some work to have it working OOTB so this can likely be
>>> enhanced again if required.
>>>
>> What is OOTB?
>>
>
> out of the box ;)
>
>
>> Also something unclear is if they should appear or not in the openapi
>>> report (we made the choice to do but it is not required AFAIK)
>>>
>>> In my opinion we should keep it, but have at list a basic configure.
>> @ResponseCode 200 should be there as it is the expected response code.
>>
>
> it must be implicit anyway
>
>
>> Another option for tomee would be to enrich the OpenAPI with what it
>>> need, there is the API for that.
>>>
>>> Can you elaborate?
>>
>
> IIRC there is an event fired with OpenAPI model, tomee can observe it and
> add all the doc it needs, including its internal endpoints or tomee webapp
>
>
>> Romain Manni-Bucau
>>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>>> <https://rmannibucau.metawerx.net/> | Old Blog
>>> <http://rmannibucau.wordpress.com> | Github
>>> <https://github.com/rmannibucau> | LinkedIn
>>> <https://www.linkedin.com/in/rmannibucau> | Book
>>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>>
>>>
>>> Le jeu. 17 janv. 2019 à 14:49, Ivan Junckes Filho <iv...@gmail.com>
>>> a écrit :
>>>
>>>> Hey guys, I was trying to make the openapi document generated by
>>>> geronimo-openapi to work with swagger-ui. The issue is I can't execute
>>>> requests from swagger-ui in the endpoints generated (metrics, health,
>>>> openapi) by TomEE as they don't have a @ApiResponse annotation and
>>>> swagger-ui doesn't display the message without that.
>>>>
>>>> What do you guys think of having this annotation by default in the
>>>> endpoints? At least for 200?
>>>>
>>>> Or anyone has a better solution for this?
>>>>
>>>
Re: OpenAPI integration with metrics/health
Posted by Romain Manni-Bucau <rm...@gmail.com>.
Le jeu. 17 janv. 2019 à 16:49, Ivan Junckes Filho <iv...@gmail.com> a
écrit :
> On Thu, Jan 17, 2019 at 12:11 PM Romain Manni-Bucau <rm...@gmail.com>
> wrote:
>
>> I would prefer to not leak specs between them since they are used without
>> the others today.
>>
>> What is missing for it to work, returned types are explicit no?
>>
> It misses ResponseCodes, without that swagger ui doesn't work.
>
Ok, 200/204 should definitely work
> Last releases got some work to have it working OOTB so this can likely be
>> enhanced again if required.
>>
> What is OOTB?
>
out of the box ;)
> Also something unclear is if they should appear or not in the openapi
>> report (we made the choice to do but it is not required AFAIK)
>>
>> In my opinion we should keep it, but have at list a basic configure.
> @ResponseCode 200 should be there as it is the expected response code.
>
it must be implicit anyway
> Another option for tomee would be to enrich the OpenAPI with what it need,
>> there is the API for that.
>>
>> Can you elaborate?
>
IIRC there is an event fired with OpenAPI model, tomee can observe it and
add all the doc it needs, including its internal endpoints or tomee webapp
> Romain Manni-Bucau
>> @rmannibucau <https://twitter.com/rmannibucau> | Blog
>> <https://rmannibucau.metawerx.net/> | Old Blog
>> <http://rmannibucau.wordpress.com> | Github
>> <https://github.com/rmannibucau> | LinkedIn
>> <https://www.linkedin.com/in/rmannibucau> | Book
>> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>>
>>
>> Le jeu. 17 janv. 2019 à 14:49, Ivan Junckes Filho <iv...@gmail.com>
>> a écrit :
>>
>>> Hey guys, I was trying to make the openapi document generated by
>>> geronimo-openapi to work with swagger-ui. The issue is I can't execute
>>> requests from swagger-ui in the endpoints generated (metrics, health,
>>> openapi) by TomEE as they don't have a @ApiResponse annotation and
>>> swagger-ui doesn't display the message without that.
>>>
>>> What do you guys think of having this annotation by default in the
>>> endpoints? At least for 200?
>>>
>>> Or anyone has a better solution for this?
>>>
>>
Re: OpenAPI integration with metrics/health
Posted by Ivan Junckes Filho <iv...@gmail.com>.
On Thu, Jan 17, 2019 at 12:11 PM Romain Manni-Bucau <rm...@gmail.com>
wrote:
> I would prefer to not leak specs between them since they are used without
> the others today.
>
> What is missing for it to work, returned types are explicit no?
>
It misses ResponseCodes, without that swagger ui doesn't work.
> Last releases got some work to have it working OOTB so this can likely be
> enhanced again if required.
>
What is OOTB?
> Also something unclear is if they should appear or not in the openapi
> report (we made the choice to do but it is not required AFAIK)
>
> In my opinion we should keep it, but have at list a basic configure.
@ResponseCode 200 should be there as it is the expected response code.
> Another option for tomee would be to enrich the OpenAPI with what it need,
> there is the API for that.
>
> Can you elaborate?
> Romain Manni-Bucau
> @rmannibucau <https://twitter.com/rmannibucau> | Blog
> <https://rmannibucau.metawerx.net/> | Old Blog
> <http://rmannibucau.wordpress.com> | Github
> <https://github.com/rmannibucau> | LinkedIn
> <https://www.linkedin.com/in/rmannibucau> | Book
> <https://www.packtpub.com/application-development/java-ee-8-high-performance>
>
>
> Le jeu. 17 janv. 2019 à 14:49, Ivan Junckes Filho <iv...@gmail.com>
> a écrit :
>
>> Hey guys, I was trying to make the openapi document generated by
>> geronimo-openapi to work with swagger-ui. The issue is I can't execute
>> requests from swagger-ui in the endpoints generated (metrics, health,
>> openapi) by TomEE as they don't have a @ApiResponse annotation and
>> swagger-ui doesn't display the message without that.
>>
>> What do you guys think of having this annotation by default in the
>> endpoints? At least for 200?
>>
>> Or anyone has a better solution for this?
>>
>
Re: OpenAPI integration with metrics/health
Posted by Romain Manni-Bucau <rm...@gmail.com>.
I would prefer to not leak specs between them since they are used without
the others today.
What is missing for it to work, returned types are explicit no?
Last releases got some work to have it working OOTB so this can likely be
enhanced again if required.
Also something unclear is if they should appear or not in the openapi
report (we made the choice to do but it is not required AFAIK)
Another option for tomee would be to enrich the OpenAPI with what it need,
there is the API for that.
Romain Manni-Bucau
@rmannibucau <https://twitter.com/rmannibucau> | Blog
<https://rmannibucau.metawerx.net/> | Old Blog
<http://rmannibucau.wordpress.com> | Github <https://github.com/rmannibucau> |
LinkedIn <https://www.linkedin.com/in/rmannibucau> | Book
<https://www.packtpub.com/application-development/java-ee-8-high-performance>
Le jeu. 17 janv. 2019 à 14:49, Ivan Junckes Filho <iv...@gmail.com> a
écrit :
> Hey guys, I was trying to make the openapi document generated by
> geronimo-openapi to work with swagger-ui. The issue is I can't execute
> requests from swagger-ui in the endpoints generated (metrics, health,
> openapi) by TomEE as they don't have a @ApiResponse annotation and
> swagger-ui doesn't display the message without that.
>
> What do you guys think of having this annotation by default in the
> endpoints? At least for 200?
>
> Or anyone has a better solution for this?
>