[openstack-dev] [api] Open API 3.0 for OpenStack API

Gilles Dubreuil gdubreui at redhat.com
Tue Sep 4 00:37:35 UTC 2018



On 30/08/18 13:56, Edison Xiang wrote:
> Hi Ed Leafe,
>
> Thanks your reply.
> Open API defines a standard interface description for REST APIs.
> Open API 3.0 can make a description(schema) for current OpenStack REST 
> API.
> It will not change current OpenStack API.
> I am not a GraphQL expert. I look up something about GraphQL.
> In my understanding, GraphQL will get current OpenAPI together and 
> provide another APIs based on Relay,

Not sure what you mean here, could you please develop?


> and Open API is used to describe REST APIs and GraphQL is used to 
> describe Relay APIs.

There is no such thing as "Relay APIs".
GraphQL povides a de-facto API Schema and Relay provides extensions on 
top to facilitate re-fetching, paging and more.
GraphQL and OpenAPI have a different feature scope and both have pros 
and cons.
GraphQL is delivering API without using REST verbs as all requests are 
undone using POST and its data.
Beyond that what would be great (and it will ultimately come) is to have 
both of them working together.

The idea of the GraphQL Proof of Concept is see what it can bring and at 
what cost such as effort and trade-offs.
And to compare this against the effort to adapt OpenStack APIs to use 
Open API.

BTW what's the status of Open API 3.0 in regards of Microversion?

Regards,
Gilles

>
> Best Regards,
> Edison Xiang
>
> On Wed, Aug 29, 2018 at 9:33 PM Ed Leafe <ed at leafe.com 
> <mailto:ed at leafe.com>> wrote:
>
>     On Aug 29, 2018, at 1:36 AM, Edison Xiang <xiang.edison at gmail.com
>     <mailto:xiang.edison at gmail.com>> wrote:
>     >
>     > As we know, Open API 3.0 was released on July, 2017, it is about
>     one year ago.
>     > Open API 3.0 support some new features like anyof, oneof and
>     allof than Open API 2.0(Swagger 2.0).
>     > Now OpenStack projects do not support Open API.
>     > Also I found some old emails in the Mail List about supporting
>     Open API 2.0 in OpenStack.
>
>     There is currently an effort by some developers to investigate the
>     possibility of using GraphQL with OpenStack APIs. What would Open
>     API 3.0 provide that GraphQL would not? I’m asking because I don’t
>     know enough about Open API to compare them.
>
>
>     -- Ed Leafe
>
>
>
>
>
>
>     __________________________________________________________________________
>     OpenStack Development Mailing List (not for usage questions)
>     Unsubscribe:
>     OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
>     <http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe>
>     http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
>
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

-- 
Gilles Dubreuil
Senior Software Engineer - Red Hat - Openstack DFG Integration
Email: gilles at redhat.com
GitHub/IRC: gildub
Mobile: +61 400 894 219

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20180904/299c17ed/attachment.html>


More information about the OpenStack-dev mailing list