[teiid-issues] [JBoss JIRA] (TEIIDSB-62) OpenApi 3.0 Support for OData

[Steven Hawkins (Jira)]

    [ https://issues.jboss.org/browse/TEIIDSB-62?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13744733#comment-13744733 ] 

Steven Hawkins commented on TEIIDSB-62:
---------------------------------------

> The ask is to have "openapi.json" as the endpoint if we change to anything else it may not serve the need.

I think the ask was to not use anything with swagger in the url.  Whether it's opeanapi, openapi.json, or openapi_v2.json shouldn't matter correct?

> openapi.json with accepts header map to 3.0

Which is a small breaking change...

So we can:

1. follow microprofile and make /openapi require a json content type and return the 2.0 document.  openapi.json would continue to server the 3.0 document.
2. just use openapi_v2.json for the 2.0 document.
3. reuse openapi.json for both 2 and 3 and specify what header we expect as the discriminator.

I prefer the solutions in that order - 1 is based upon some reference.  2 is a very small code change.  3 is a small breaking change and requires the use of a non-standard header property.


> OpenApi 3.0 Support for OData
> -----------------------------
>
>                 Key: TEIIDSB-62
>                 URL: https://issues.jboss.org/browse/TEIIDSB-62
>             Project: Teiid Spring Boot
>          Issue Type: Feature Request
>            Reporter: Ramesh Reddy
>            Assignee: Ramesh Reddy
>            Priority: Major
>             Fix For: 1.1.0
>
>
> Support OpenAPI 3.0 document generation with OData service 



--
This message was sent by Atlassian Jira
(v7.12.1#712002)