Re: Early Users for possible OASIS SwaggerHub offering to boost uptake of APIs

[Andreas Kuehne <kuehne@trustable.de>]

Hi Chet,

I don't think anyone can avoid to be present on SwaggerHub with a
relevant interface specifications. We learned that even the conservative
ETSI is producing OpenAPI definitions!

For DSS-X we have a list of goals we consider as a 'must' for a
successful standard. and having it available at SwaggerHub is definitely
on this list. To maximize reuse and minimize redundancy we started to
work with MarkDown to re-use parts from the specification document in
the OpenAPI's explanation sections directly.

But suffering from the departure of Stefan and having made some
commitments regarding the availability of DSS-X core 2.0 we currently
building new Word-based version. After having done the duties we'll come
back to the fun parts!

Greetings,

Andreas
> Happy New Year Andreas,
>
> I just looked at the DSS-X 2.0 apis on Swaggerhub MY hub. It looks like you
> tried 3 different times.
>
> So what's your conclusion if I may ask? It doesn't look like you've done
> anything with it since September. Do you see it as being useful? I'd like
> to hear any thoughts or reactions you have before deciding what to do next.
>
> Thanks much!
>
> /chet
>
> On Mon, Oct 1, 2018 at 10:30 AM Chet Ensign <chet.ensign@oasis-open.org>
> wrote:
>
>> Hi Andreas - The Oasis-Open can be deleted. I recall that one not working
>> properly. I'm not sure what the best way to set up on SH is at this point.
>> That is, do we set it up as an organization like on GitHub or is it under a
>> single user account who then sets up one or more teams under it. I'll need
>> to research the best way to do that.
>>
>> I saw the email about OAS 3.0 as well. Be interested to see what you find
>> out.
>>
>> Best,
>>
>> /chet
>>
>>
>> On Sun, Sep 30, 2018 at 7:17 AM akuehne <akuehne@trustable.eu> wrote:
>>
>>> Hi Chet,
>>>
>>> I uploaded a simplistic of DSS-X core 2.0 as OAS 3.0 and it works as
>>> expected. But I do miss the code generation section.
>>> Another try with DSS-X core 2.0 formatted as Swagger 2.0 failed with the
>>> hint 'no version', but the file starts with
>>>
>>> {
>>>     "swagger": "2.0",
>>> ...
>>>
>>> Strange! Last year the Swagger format was the only way to generate code.
>>> But the mails I received in the meantime promised full support for OAS 3.0,
>>> too. I'll check back with the documentation.
>>>
>>> Do you expect me to use 'Oasis.Open' and 'Oasis-Open' should be deleted?
>>> Or is this user intended for other purposes?
>>>
>>> Greetings,
>>>
>>> Andreas
>>>
>>>
>>> Hi Andreas,
>>>
>>> O.K. Based on your swift and enthusiastic response, I have set up an
>>> account on Swaggerhub named Oasis.Open. The password is SH2test9run.
>>>
>>> Andreas, feel free to log in to the account and do some work there. I will
>>> get back to the folks there to let them know we are taking this step.
>>>
>>> I added both of you as collaborators. (Twice actually because the first
>>> account I had set up under my own name and that one I deleted.) I hit the
>>> submit key before adding Trey so I'll see if I can figure out how to add
>>> him now.
>>>
>>> As Stefan said, our goal is to do some proof of concept work that we can
>>> demonstrate to others (such as the folks on the original email) to gauge
>>> the degree of interest in other TCs.
>>>
>>> Andreas, please let me know if you can get in ok and have what you need
>>> there. I'm going to follow up with the SmartBear folks and let them know we
>>> are taking this step.
>>>
>>> Thanks & feel free to barrage me with questions or feedback.
>>>
>>> Best,
>>>
>>> /chet
>>>
>>>
>>> On Fri, Sep 14, 2018 at 5:30 AM Andreas Kuehne <kuehne@trustable.de> <kuehne@trustable.de> wrote:
>>>
>>>
>>> Hi Stefan,
>>>
>>> the DSS-X TC is eager to use SwaggwerHub! Especially to show the
>>> additional for JSON.
>>>
>>> I would like to point out the distinct aspects SwaggerHub offers:
>>>
>>> - another option for our specification 'to be found'.
>>> - option for client and server side code generation (both
>>> interactive/online and integrated into build pipeline)
>>> - interactive client to explore a given endpoint
>>>
>>> The last option is quite interesting as it's the 'Beginner's Guide'
>>> taken to the internet age. But this requires a publicly available server
>>> implementing the related spec and valid sample calls included into the
>>> OAS/Swagger spec. TCs may consider the pros and cons of this option as
>>> it an ongoing effort to keep a instance up and running for presumably a
>>> long period.
>>>
>>> And of course there are hick-ups with Swagger: We struggled to get the
>>> generated JavaScript-Code up and running. Two bugs need to be reported.
>>> Nevertheless I consider it worth the effort.
>>>
>>>
>>> Greetings,
>>>
>>> Andreas
>>>
>>>
>>>
>>> Gents,
>>>
>>> following up on an initial idea from Andreas Kuehne to use SwaggerHub
>>> for acceleration of go to market of the DSS-X Core Version 2 JSON
>>> Schema whch was seconded by Ralf Handl and also by Trey Darley
>>> the Technical Advisory Board (TAB) is preparing to enter a show case
>>> phase.
>>>
>>> The TAB agreed to support TCs willing to start including this "service"
>>> in their artifact arsenal and made an adhoc selection of TC's where
>>> ready to show arteifacts are assumed to be available.
>>>
>>> Thus, this mail kindly asks:
>>>
>>> Would your TC like to showcase it's APIs and ease potential
>>> implementers to start with automatically generated clients and servers
>>> in various host languages as offered by SwaggerHub?
>>>
>>> Please get in touch with me and Chet, so that we can funnel via a
>>> first trial single user account for OASIS a maximally broad spectrum
>>> of APIs so that
>>> a) other TC's more easily get an idea of what the
>>> possible effect on go to market acceleration could be
>>> b) the TCs find out, if this suits their APIs and schemas/languages
>>> and c) if OASIS can sign a yearly contract based on sound needs and
>>> benefits
>>>
>>> All the best,
>>> Stefan
>>>
>>>
>>> --
>>> Andreas KÃhne
>>> phone: +49 177 293 24 97
>>> mailto: kuehne@trustable.de
>>>
>>> Trustable Ltd. Niederlassung Deutschland Gartenheimstr. 39C - 30659
>>> Hannover Amtsgericht Hannover HRB 212612
>>>
>>> Director Andreas KÃhne
>>>
>>> Company UK Company No: 5218868 Registered in England and Wales
>>>
>>>
>>>
>>>
>>>
>>>
>> --
>>
>> /chet
>> ----------------
>>
>> Looking forward to Borderless Cyber 2018
>> <https://us18.borderlesscyber.org/en/>, 3-5 Oct, Washington, D.C.
>> *Organized by The World Bank, OASIS, and Georgetown University*
>>
>> Chet Ensign
>> Chief Technical Community Steward
>> OASIS: Advancing open standards for the information society
>> http://www.oasis-open.org
>>
>> Primary: +1 973-996-2298
>> Mobile: +1 201-341-1393
>>
>

-- 
Andreas KÃhne 
phone: +49 177 293 24 97 
mailto: kuehne@trustable.de

Trustable Ltd. Niederlassung Deutschland Gartenheimstr. 39C - 30659 Hannover Amtsgericht Hannover HRB 212612

Director Andreas KÃhne

Company UK Company No: 5218868 Registered in England and Wales