Hi Steven,

 

For the VF-C APIs, We have the link in wiki, they are in HTML format that
generated by Swagger. It need time to convert it to  readthedocs  format. 

We are now looking through the documentation Guidelines and call for
volunteers to do this. I will feedback to you if this work has progress.

 

 

Best Regards,

Yan

发件人: WRIGHT, STEVEN A [mailto:[email protected]] 
发送时间: 2017年9月1日 20:56
收件人: [email protected]; 'Wenyao Guan'
抄送: GLOVER, GREG L; BENNETT, RICH; 'Gildas Lanilis';
[email protected]; [email protected]; 'Lingli Deng';
[email protected]
主题: RE: [VFC] documentation on APIs

 

Yan, Wenyao,

 

Even if the interface remains proprietary, it would still make sense to have
a general cross reference back to where the VFC functionality is officially
documented in readthedocs.io but nothing on VFC exists there yet. 

 

My concern is when the release controlled VFC documentation will be
available at readthedocs.io. I’m not seeking any changes in VFC
functionality. 

 


best regards
Steven Wright, MBA, PhD, JD.

Tech Integration

AT&T Services Inc.
1057 Lenox Park Blvd NE, STE 4D28
Atlanta, GA 30319
P: 470.415.3156

 <mailto:[email protected]> [email protected]

 <http://www.linkedin.com/in/drstevenawright/>
www.linkedin.com/in/drstevenawright/

 

From: 杨艳 [mailto:[email protected]] 
Sent: Wednesday, August 30, 2017 11:42 PM
To: 'Wenyao Guan' <[email protected]>; WRIGHT, STEVEN A
<[email protected]>
Cc: GLOVER, GREG L <[email protected]>; BENNETT, RICH <[email protected]>; 'Gildas
Lanilis' <[email protected]>; [email protected];
[email protected]; 'Lingli Deng' <[email protected]>;
[email protected]
Subject: 答复: [VFC] documentation on APIs

 

Hi Steven and  Wenyao,

 

Thanks Wenyao to help clarify. 

Yes .Currently VF-C has provided a list of APIs but not include the VNF API
, because  the VNFs are managed by vendor VNFM directly in VF-C, so there is
no requirement for VNF API in ONAP R1 .

 

Best Regards,

Yan

发件人: Wenyao Guan [mailto:[email protected]] 
发送时间: 2017年8月31日 11:01
收件人: 'WRIGHT, STEVEN A'; [email protected]
抄送: 'GLOVER, GREG L'; 'BENNETT, RICH'; 'Gildas Lanilis';
[email protected]; [email protected]; 'Lingli Deng';
[email protected]
主题: 答复: [VFC] documentation on APIs

 

Hi Steven,

 

As I am undertaking the VNFRQTS-89, I talked with Yan about the VNFs API to
VF-C. 

For VF-C in ONAP R1, the VNFs are managed by specific VNFM which is provided
by VNF providers so there is no VNF API is exposed to VF-C.

Hence there is no documentations needed for the unexposed APIs. I think this
should be specified in our VNF Requirements relevant docs. 

 

 <mailto:[email protected]> @'杨艳' Please correct me if any
mistake.

 

Thank you.

 

Best Regards,

Wenyao

发件人: WRIGHT, STEVEN A [mailto:[email protected]] 
发送时间: 2017年8月31日 4:20
收件人: [email protected]
抄送: GLOVER, GREG L <[email protected]>; BENNETT, RICH <[email protected]>;
Gildas Lanilis <[email protected]>; [email protected];
[email protected]; [email protected]
主题: [VFC] documentation on APIs

 

With the API freeze at the M3 milestone, I am interested in  the
availability of the Amsterdam release VF-C API documentation from the VF-C
project.

 

While there is some VF-C API documentation on the wiki at:
https://wiki.onap.org/display/DW/VF-C+R1+Deliverables
<https://urldefense.proofpoint.com/v2/url?u=https-3A__wiki.onap.org_display_
DW_VF-2DC-2BR1-2BDeliverables&d=DwMFbw&c=LFYZ-o9_HUMeMTSQicvjIg&r=PVu8DKytqB
ISpqDc36NHSA&m=dihE_sNp1rY9ghkDf-_NC5mif02DKK6ZfY36IsNrE2s&s=ZeL7VuBQ7VPX8L0
HgCluMmON3ocMYh7qzulyk3eCsok&e=>  , the Documentation project  provides the
documentation tool chain for all ONAP projects ( refer Documentation section
M1 Release planning documentation). The Documentation Project tool chain
delivers release-controlled ONAP documentation to
http://onap.readthedocs.io/en/latest/index.html
<https://urldefense.proofpoint.com/v2/url?u=http-3A__onap.readthedocs.io_en_
latest_index.html&d=DwMFbw&c=LFYZ-o9_HUMeMTSQicvjIg&r=PVu8DKytqBISpqDc36NHSA
&m=dihE_sNp1rY9ghkDf-_NC5mif02DKK6ZfY36IsNrE2s&s=HxbkDbtuHnqMOjc9en58jyhTDyM
TvsX0MoiM2Nz0sSk&e=> 

 

There is currently no documentation on VF-C APIs available at
http://onap.readthedocs.io/en/latest/index.html
<https://urldefense.proofpoint.com/v2/url?u=http-3A__onap.readthedocs.io_en_
latest_index.html&d=DwMFbw&c=LFYZ-o9_HUMeMTSQicvjIg&r=PVu8DKytqBISpqDc36NHSA
&m=dihE_sNp1rY9ghkDf-_NC5mif02DKK6ZfY36IsNrE2s&s=HxbkDbtuHnqMOjc9en58jyhTDyM
TvsX0MoiM2Nz0sSk&e=> 

(The documentation tool chain/Jenkins jobs are up and working now for other
projects) 

 

Can the VF-C project/PTL  identify a contact person to work on the
documentation aspects of VF-C? 

Ideally the contact should be identified here
<https://urldefense.proofpoint.com/v2/url?u=https-3A__wiki.onap.org_display_
DW_Doc-2BProject-2BCoverage-2BMatrix&d=DwMFbw&c=LFYZ-o9_HUMeMTSQicvjIg&r=PVu
8DKytqBISpqDc36NHSA&m=dihE_sNp1rY9ghkDf-_NC5mif02DKK6ZfY36IsNrE2s&s=4eRQHfqK
M4f9i6xbVxsOC-HwdSzSDOMOWQQJd680XLU&e=> .

The general process on documenting projects in ONAP is described here
<https://urldefense.proofpoint.com/v2/url?u=http-3A__onap.readthedocs.io_en_
latest_guide_onap-2Ddeveloper_how-2Dto-2Duse-2Ddocs_index.html&d=DwMFbw&c=LF
YZ-o9_HUMeMTSQicvjIg&r=PVu8DKytqBISpqDc36NHSA&m=dihE_sNp1rY9ghkDf-_NC5mif02D
KK6ZfY36IsNrE2s&s=Lu9JUkkW6YiaJaYjfCEXRxBVlhRIfCj35R0fS4dZ3-o&e=> .

 

VNFs have requirements to support VF-C APIs. From VNFRQTS project, we are
trying to complete VNFRQTS-89
<https://urldefense.proofpoint.com/v2/url?u=https-3A__jira.onap.org_browse_V
NFRQTS-2D89&d=DwMFbw&c=LFYZ-o9_HUMeMTSQicvjIg&r=PVu8DKytqBISpqDc36NHSA&m=dih
E_sNp1rY9ghkDf-_NC5mif02DKK6ZfY36IsNrE2s&s=uYBY8sFwXv0zabWGahzIliKSqHkevV8p-
0y5T-KSNwU&e=>  in our current sprint-3.   To complete this, we need at
least a chapter heading available at
http://onap.readthedocs.io/en/latest/index.html
<https://urldefense.proofpoint.com/v2/url?u=http-3A__onap.readthedocs.io_en_
latest_index.html&d=DwMFbw&c=LFYZ-o9_HUMeMTSQicvjIg&r=PVu8DKytqBISpqDc36NHSA
&m=dihE_sNp1rY9ghkDf-_NC5mif02DKK6ZfY36IsNrE2s&s=HxbkDbtuHnqMOjc9en58jyhTDyM
TvsX0MoiM2Nz0sSk&e=>  for our requirements deliverable to point to for VF-C
API documentation. Our VNFRQTS Sprint 3 is due to complete September 12, so
we would appreciate if you could have the VF-C API documentation outline up
at  http://onap.readthedocs.io/en/latest/index.html
<https://urldefense.proofpoint.com/v2/url?u=http-3A__onap.readthedocs.io_en_
latest_index.html&d=DwMFbw&c=LFYZ-o9_HUMeMTSQicvjIg&r=PVu8DKytqBISpqDc36NHSA
&m=dihE_sNp1rY9ghkDf-_NC5mif02DKK6ZfY36IsNrE2s&s=HxbkDbtuHnqMOjc9en58jyhTDyM
TvsX0MoiM2Nz0sSk&e=>  within the next week.

 

Please advise if you need help to achieve this.


best regards
Steven Wright, MBA, PhD, JD.

Tech Integration

AT&T Services Inc.
1057 Lenox Park Blvd NE, STE 4D28
Atlanta, GA 30319
P: 470.415.3156

 <mailto:[email protected]> [email protected]

 
<https://urldefense.proofpoint.com/v2/url?u=http-3A__www.linkedin.com_in_drs
tevenawright_&d=DwMFbw&c=LFYZ-o9_HUMeMTSQicvjIg&r=PVu8DKytqBISpqDc36NHSA&m=d
ihE_sNp1rY9ghkDf-_NC5mif02DKK6ZfY36IsNrE2s&s=phzuuEJfMCMgJKGEL_M0YfAuzn3wUkC
qcMp7gKNcLOY&e=> www.linkedin.com/in/drstevenawright/

 

_______________________________________________
onap-discuss mailing list
[email protected]
https://lists.onap.org/mailman/listinfo/onap-discuss

Reply via email to