Hi Roger, We have looked at swg2rst Sphinx directive, tried it on one of the projects that provide swagger json, and believe that it should be considered one way to publish REST API documentation. Let's discuss at the Tuesday meeting.
Thank you. Rich From: [email protected] [mailto:[email protected]] On Behalf Of Roger Maitland Sent: Monday, September 11, 2017 3:04 PM To: [email protected] Subject: [onap-discuss] [doc] Documenting HTTP/REST APIs Hello doc team, Many (if not all?) of the ONAP teams are using Swagger<https://urldefense.proofpoint.com/v2/url?u=https-3A__swagger.io_&d=DwMFAg&c=LFYZ-o9_HUMeMTSQicvjIg&r=hFukw2tKoSir9RviUoS0RA&m=tDZXRa4eotIn4gG86kKMal3SOtd_0W3L5PmypH2qorM&s=37gPc9gz2RkL5LFIDw7z9lw_V72iTcbF335xtHjVU9s&e=> to document their HTTP/REST APIs currently. I understand that official ONAP documentation will be in reStructuredText<https://urldefense.proofpoint.com/v2/url?u=http-3A__docutils.sourceforge.net_rst.html&d=DwMFAg&c=LFYZ-o9_HUMeMTSQicvjIg&r=hFukw2tKoSir9RviUoS0RA&m=tDZXRa4eotIn4gG86kKMal3SOtd_0W3L5PmypH2qorM&s=1VX4GB5z2fRKvlLHGKrGKzuOqTtat3K1m62AHQD6E84&e=> format. Is the expectation that API documentation be translated to rst format? If so, have any tools - like swg2rst<https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_Arello-2DMobile_swagger2rst&d=DwMFAg&c=LFYZ-o9_HUMeMTSQicvjIg&r=hFukw2tKoSir9RviUoS0RA&m=tDZXRa4eotIn4gG86kKMal3SOtd_0W3L5PmypH2qorM&s=IZ2bFDfjMl0rHeltb2qO11hCN2LG73arKLvAAS4tgCQ&e=> - been explored to automate this process? Is there time to discuss this topic during tomorrow's [doc] meeting (September 12th)? Thanks, Roger Maitland [amdocs-a] Amdocs a Platinum member of ONAP<https://urldefense.proofpoint.com/v2/url?u=https-3A__www.amdocs.com_open-2Dnetwork_nfv-2Dpowered-2Dby-2Donap&d=DwMFAg&c=LFYZ-o9_HUMeMTSQicvjIg&r=hFukw2tKoSir9RviUoS0RA&m=tDZXRa4eotIn4gG86kKMal3SOtd_0W3L5PmypH2qorM&s=kLFjOo8JXaMHMZitd1xr_lAxJwzV-nQ8aWMXyUYsfo0&e=> This message and the information contained herein is proprietary and confidential and subject to the Amdocs policy statement, you may review at https://www.amdocs.com/about/email-disclaimer<https://urldefense.proofpoint.com/v2/url?u=https-3A__www.amdocs.com_about_email-2Ddisclaimer&d=DwMFAg&c=LFYZ-o9_HUMeMTSQicvjIg&r=hFukw2tKoSir9RviUoS0RA&m=tDZXRa4eotIn4gG86kKMal3SOtd_0W3L5PmypH2qorM&s=LINpnt9E7tlfwx7KMw65gVpLysS6vurg7Vd7YOzswe8&e=>
_______________________________________________ onap-discuss mailing list [email protected] https://lists.onap.org/mailman/listinfo/onap-discuss
