[jboss-jira] [JBoss JIRA] (WFWIP-292) Validate generated OpenAPI document

[Fabio Burzigotti (Jira)]

     [ https://issues.redhat.com/browse/WFWIP-292?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Fabio Burzigotti updated WFWIP-292:
-----------------------------------
    Description: 
Currently no validation is provided for generated document and actually the spec is not requesting for vendors to do that [1] but it would definitely be a key improvement for customers and users in general to know that the generated document is checked and appropriate action is taken in case content is not valid (e.g.: log WARN messages etc.).

Online Swagger Editor [2] was used to verify that non valid content was generated.

Also it should be evaluated whether to mention this behavior in community or product docs.

[1]
https://download.eclipse.org/microprofile/microprofile-open-api-1.1.2/microprofile-openapi-spec.html#_validation

[2]
https://editor.swagger.io/  

  was:
Currently no validation is provided for generated document and actually the spec is not requesting for vendors to do that [1] but it would definitely be a key improvement for customers and users in general to know that the generated document is checked and appropriate action is taken (e.g.: log WARN messages etc.).

Online Swagger Editor [2] was used to verify that non valid content was generated.

Also it should be evaluated whether to mention this behavior in community or product docs.

[1]
https://download.eclipse.org/microprofile/microprofile-open-api-1.1.2/microprofile-openapi-spec.html#_validation

[2]
https://editor.swagger.io/  



> Validate generated OpenAPI document  
> -------------------------------------
>
>                 Key: WFWIP-292
>                 URL: https://issues.redhat.com/browse/WFWIP-292
>             Project: WildFly WIP
>          Issue Type: Enhancement
>          Components: MP OpenAPI
>            Reporter: Fabio Burzigotti
>            Assignee: Paul Ferraro
>            Priority: Major
>
> Currently no validation is provided for generated document and actually the spec is not requesting for vendors to do that [1] but it would definitely be a key improvement for customers and users in general to know that the generated document is checked and appropriate action is taken in case content is not valid (e.g.: log WARN messages etc.).
> Online Swagger Editor [2] was used to verify that non valid content was generated.
> Also it should be evaluated whether to mention this behavior in community or product docs.
> [1]
> https://download.eclipse.org/microprofile/microprofile-open-api-1.1.2/microprofile-openapi-spec.html#_validation
> [2]
> https://editor.swagger.io/  



--
This message was sent by Atlassian Jira
(v7.13.8#713008)