Ok for Swagger, I will post a PR. About the website, let me know when you want me to start working on it (I already have a repo on my github account).
regards, François Papon [email protected] Le 01/08/2018 à 18:25, Serge Huber a écrit : > Feel free to help out on Swagger, I have little to no experience with it. > > As for the GraphQL side, it's very experimental code that is > constantly changing right now, so be warned that things might change > quite significantly at any point but feel free to look at it and give > feedback or even contribute! > > cheers, > Serge... > > Serge Huber > CTO & Co-Founder > > T +41 22 361 3424 > 9 route des Jeunes | 1227 Acacias | Switzerland > jahia.com > SKYPE | LINKEDIN | TWITTER | VCARD > > >> JOIN OUR COMMUNITY to evaluate, get trained and to discover why Jahia is a >> leading User Experience Platform (UXP) for Digital Transformation. > > On Wed, Aug 1, 2018 at 9:00 AM Francois Papon > <[email protected]> wrote: >> Cool, >> >> If needed, I can help on the Swagger and the GraphQL integration ;) >> >> regards, >> >> François Papon >> [email protected] >> Yupiik - https://www.yupiik.com >> >> Le 31/07/2018 à 23:01, Serge Huber a écrit : >>> Hello François, >>> >>> Thanks for clarifying that I wasn't aware that you could use Swagger >>> that way. That makes sense. >>> >>> For GraphQL yes the final version of the CXS specification I'm also >>> co-developing has switched from REST to GraphQL, and I'm currently >>> implementing that in a branch to validate the design of the GraphQL >>> schema. It's a challenge because we are doing some advanced stuff with >>> GraphQL but the API is already a lot more powerful than the REST API. >>> >>> cheers, >>> Serge... >>> On Tue, Jul 31, 2018 at 6:25 PM Francois Papon >>> <[email protected]> wrote: >>>> Hi Serge, >>>> >>>> Thanks for your feedback :) >>>> >>>> I see the Miredot documentation and for me it's good. >>>> >>>> I propose to add Swagger (not to replace Miredot) to have a GUI to >>>> simulate request and response for developers. >>>> >>>> I already used the cxf-swagger-feature in a Karaf project and the only >>>> bug I found it's the refresh of the json when updating the bundle in a >>>> started instance. >>>> >>>> I have in mind to propose a page on the website dedicated to the API >>>> like this : >>>> >>>> https://projects.tmforum.org/wiki/display/API/Open+API+Table >>>> >>>> I saw a JIRA about GraphQL integration, it's great :) >>>> >>>> regards, >>>> >>>> François Papon >>>> [email protected] >>>> >>>> Le 31/07/2018 à 19:48, Serge Huber a écrit : >>>>> Hello François, >>>>> >>>>> Thank you for your proposal, I really like the new design ! >>>>> >>>>> For me, the user documentation could be reformated to make it easier >>>>> to browse and of course, it always needs improving and detailing. >>>>> >>>>> Concerning the REST API documentation, currently, we use another tool >>>>> to generate it from the source code, and it is capable of documenting >>>>> the JSON structure at the same time. The whole source code was >>>>> documented to work with this plugin (http://www.miredot.com/) for >>>>> which we got a free license since it is an Apache project. Are you >>>>> suggesting we replace this with Swagger (we evaluated it at the time >>>>> but it was missing some features for generating from the code) ? >>>>> >>>>> Regards, >>>>> Serge... >>>>> On Tue, Jul 31, 2018 at 2:42 PM Francois Papon >>>>> <[email protected]> wrote: >>>>>> Hi, >>>>>> >>>>>> I'm new with the Apache Unomi project and I would like to make some >>>>>> proposals around the website and the documentation :) >>>>>> >>>>>> *1 - Website :* >>>>>> >>>>>> Actually, the website is auto generate and link to the project release >>>>>> livecycle, however we could made some changes any time, like posting >>>>>> news, uses cases... >>>>>> >>>>>> That's why I think the website can have he's dedicated repository and >>>>>> could be only build on html static pages. >>>>>> >>>>>> I started a WIP with the home page and you can have a preview here : >>>>>> https://openobject.fr/unomi >>>>>> >>>>>> *2 - User guide :* >>>>>> >>>>>> The user guide is good and could be link to the release, may be to major >>>>>> release ? >>>>>> >>>>>> We have the documentation in md format for Github and html for the >>>>>> website, we also could have a pdf from the html. >>>>>> >>>>>> *3 - API Rest documentation :* >>>>>> >>>>>> May be we could provided an instance of Swagger from the website for >>>>>> developers, it's convenient for have some request/response (their is an >>>>>> existing cxf-swagger feature for generating the json). >>>>>> >>>>>> >>>>>> If you are interesting, I can help on this items :) >>>>>> >>>>>> regards, >>>>>> >>>>>> -- >>>>>> François Papon >>>>>> [email protected] >>>>>>
