Open Stack

Posting to openstack-docs mailing list.

---------- Forwarded message ----------
From: Paul Michali (pcm) <pcm at cisco.com>
Date: Thu, Mar 19, 2015 at 11:48 AM
Subject: Re: OpenStack Networking API documentation...
To: "Elke Vorheis -X (evorheis - TRILYON INC at Cisco)" <evorheis at cisco.com>,
"nchase at mirantis.com" <nchase at mirantis.com>, "Matt Kassawara (
mkassawara at gmail.com)" <mkassawara at gmail.com>
Cc: Sumit Naiksatam <sumitnaiksatam at gmail.com>, "Brian Bowen (brbowen)" <
brbowen at cisco.com>, "Patrick Amor (pamor)" <pamor at cisco.com>, "Sridar
Kandaswamy (skandasw)" <skandasw at cisco.com>


 Just a follow-up… I emailed openstack-dev mailing list in the community,
hoping someone replies. I didn’t get any responses when trying on the
documentation IRC (several times).

 I have the JSON files for VPNaaS  pulled in, and I took the LBaaS XML
section and cloned it to make a VPNaaS one. Now, there is a LBaaS WADL
file, and I have the XML file for VPN that has similar content and need to
do the conversion.

 I *could* take my text editor and try to manually build the VPNaaS WADL
file, using the LBaaS one as a guide, but before I go to those lengths, I’d
like to know if there is an easier way (some tool, semi-automated method,
whatever) to do this.

 I tried to generate-sources, after just creating the XML section for
VPNaaS, with it still referencing the LBaaS WADL, and Maven gave an error
and failed the build.

 In addition, the WADL file has some namespace(?) entries at the top, and I
have no knowledge of how to fill that out.

 Any advice/guidance/pointers, before I get to far in converting this stuff?


   PCM (Paul Michali)

 MAIL …..…. pcm at cisco.com
IRC ……..… pc_m (irc.freenode.com)
TW ………... @pmichali
GPG Key … 4525ECC253E31A83
Fingerprint .. 307A 96BB 1A4C D2C7 931D 8D2D 4525 ECC2 53E3 1A83




 On Mar 18, 2015, at 1:16 PM, Elke Vorheis -X (evorheis - TRILYON INC at
Cisco) <evorheis at cisco.com> wrote:

  Matt and/or Nick,

 Paul is looking for some help with the resurrection of APIs form json
files. Do you know of anyone who has done this? I briefly spoke with Paul
and suggested that possibly one of you may know of someone or could
possibly advise Paul re the task on hand. He was also thinking of
contacting Anne.

 Any light that you could shed on this matter would probably be much
appreciated by Paul and his team.

 Thanks, Elke

   <image001.jpg>
   *Elke Vorheis*
Trilyon at Cisco
evorheis at cisco.com

   <image002.gif>Think before you print.
   This email may contain confidential and privileged material for the sole
use of the intended recipient. Any review, use, distribution or disclosure
by others is strictly prohibited. If you are not the intended recipient (or
authorized to receive for the recipient), please contact the sender by
reply email and delete all copies of this message.
 For corporate legal information go to:
http://www.cisco.com/web/about/doing_business/legal/cri/index.html


  *From:* Paul Michali (pcm)
*Sent:* Tuesday, March 17, 2015 3:57 AM

*To:* Elke Vorheis -X (evorheis - TRILYON INC at Cisco)
*Cc:* Sumit Naiksatam; Brian Bowen (brbowen); Patrick Amor (pamor); Sridar
Kandaswamy (skandasw)
*Subject:* Re: OpenStack Networking API documentation...

 Here is the one and only XML file for VPN, along with a pair
(request/response) of  JSON files used. Note, in the commit mentioned, all
the XML files were removed, and replaced with a link to the doc web page
(which doesn’t have any VPN info):

  commit 3825fdc3752f124b5951bacc91f36f1eb3b68970
  Author: Anne Gentle <anne at openstack.org>
  Date:   Fri Aug 8 10:34:18 2014 -0500

      Removes WADL references and replaces with links to API Ref

      Change-Id: Ie28876acb2c8e0837a87dd475ef235f54dcf4c03


  Regards,


   PCM (Paul Michali)

  MAIL …..…. pcm at cisco.com
  IRC ……..… pc_m (irc.freenode.com)
  TW ………... @pmichali
  GPG Key … 4525ECC253E31A83
  Fingerprint .. 307A 96BB 1A4C D2C7 931D 8D2D 4525 ECC2 53E3 1A83





 On Mar 16, 2015, at 6:30 PM, Elke Vorheis -X (evorheis - TRILYON INC at
Cisco) <evorheis at cisco.com> wrote:

  Yes, please send one file. Thanks, Elke

    <image001.jpg>
    *Elke Vorheis*
Trilyon at Cisco
evorheis at cisco.com

    <image002.gif>Think before you print.
    This email may contain confidential and privileged material for the
sole use of the intended recipient. Any review, use, distribution or
disclosure by others is strictly prohibited. If you are not the intended
recipient (or authorized to receive for the recipient), please contact the
sender by reply email and delete all copies of this message.
  For corporate legal information go to:
http://www.cisco.com/web/about/doing_business/legal/cri/index.html


   *From:* Paul Michali (pcm)
*Sent:* Monday, March 16, 2015 2:48 PM
*To:* Elke Vorheis -X (evorheis - TRILYON INC at Cisco)
*Cc:* Sumit Naiksatam; Brian Bowen (brbowen); Patrick Amor (pamor)
*Subject:* Re: OpenStack Networking API documentation...

  Hi,

   I asked the community, and found out that the old netconn-api repository
has the info. It looks like on 8/8/2014 they removed the WADL for VPN. The
commit was 3825fdc. So 3302e05 has the latest information (one XML file
that uses all the JSON files).

   The JSON files were last modified on 11/26/2013 and 10/8/2013, so the
3302e05 commit gets the latest.

   The question then becomes, how do we convert this to the new format?  I
can provide the files if needed to see what we have now.

   Regards,


    PCM (Paul Michali)

   MAIL …..…. pcm at cisco.com
   IRC ……..… pc_m (irc.freenode.com)
   TW ………... @pmichali
   GPG Key … 4525ECC253E31A83
   Fingerprint .. 307A 96BB 1A4C D2C7 931D 8D2D 4525 ECC2 53E3 1A83





  On Mar 16, 2015, at 4:17 PM, Elke Vorheis -X (evorheis - TRILYON INC at
Cisco) <evorheis at cisco.com> wrote:

   Hi Paul,

   If you have a chance, can u pls give me a call at 650 291-1375. Thanks,
Elke

     <image001.jpg>
     *Elke Vorheis*
Trilyon at Cisco
evorheis at cisco.com

    <image002.gif>Think before you print.
     This email may contain confidential and privileged material for the
sole use of the intended recipient. Any review, use, distribution or
disclosure by others is strictly prohibited. If you are not the intended
recipient (or authorized to receive for the recipient), please contact the
sender by reply email and delete all copies of this message.
   For corporate legal information go to:
http://www.cisco.com/web/about/doing_business/legal/cri/index.html


    *From:* Paul Michali (pcm)
*Sent:* Monday, March 16, 2015 12:55 PM
*To:* Elke Vorheis -X (evorheis - TRILYON INC at Cisco)
*Cc:* Sumit Naiksatam; Brian Bowen (brbowen); Patrick Amor (pamor)
*Subject:* OpenStack Networking API documentation...

   Hi Elke,

    I work under Lew Tucker’s group on OpenStack and have been leading the
VPNaaS project for the community (Sumit, CCed, leads the Firewall project).

    We had documentation on our data model and REST API on a wiki (
https://wiki.openstack.org/wiki/Neutron/VPNaaS). At some point, a long
while back, I created REST API documentation for the
http://docs.openstack.org/api/ wiki under the Networking section and
updated it for V2.0.

    Unfortunately, at some point they overhauled that site and changed the
formatting, and in that process the VPN (and Firewall) documentation was
lost (don’t know why it was not included).

    I just found out recently that it is missing (I don’t usually need to
reference the REST APIs as I deal with the code all the time and use the
CLI), and would like to restore that documentation.

    I see the old documentation at
https://github.com/openstack-attic/netconn-api, which has the JSON
examples, but nothing else, and of course we still have the wiki mentioned
above (although it is v1 and I not sure what changed in v2).  I looked at
the git hub repo for the latest (
http://git.openstack.org/cgit/openstack/api-site/) and there is nothing in
the history for VPN (or Firewall that I can tell). I heard that it requires
some conversion to WADL (don’t know much about it at all).

    I talked to Edgar Magana, who said you are very familiar with the
conversion process needed for this.  Would you be able to provide some
guidance on what needs to be done, and how we can go about
converting/restoring the VPN (and Firewall) documentation? If not, do you
know who we can seek out?

    I’m clueless on the WADL stuff, but have basic HTML/XML understanding.


    Thanks in advance!

     PCM (Paul Michali)

    MAIL …..…. pcm at cisco.com
    IRC ……..… pc_m (irc.freenode.com)
    TW ………... @pmichali
    GPG Key … 4525ECC253E31A83
    Fingerprint .. 307A 96BB 1A4C D2C7 931D 8D2D 4525 ECC2 53E3 1A83


  <section_neutron-ext-vpnaas.xml><ipsec-site-connection-create-req.json>
<ipsec-site-connection-create-res.json>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150319/a1f560a1/attachment-0001.html>