Steven,

DCAEGEN2 has the API documents under 
https://wiki.onap.org/display/DW/DCAE+API+Documentation.  They are in Swagger 
generated HTML format.  At the time of generation this was known as the most 
complete format for API specification.  Converting to the new readthedocs 
format is a new requirement that we did not know about and planned for before.  
Currently we have no spare resources to work on this conversion task.

I issued a call for volunteer during DCAE’s weekly meeting earlier this 
morning.  So far no one responded.  I will keep you updated if the situation 
changes.

Lusheng Ji
DCAE PTL




From: "WRIGHT, STEVEN A" <[email protected]>
Date: Wednesday, August 30, 2017 at 1:56 PM
To: "JI, LUSHENG (LUSHENG)" <[email protected]>
Cc: "GLOVER, GREG L" <[email protected]>, "BENNETT, RICH" <[email protected]>, Gildas 
Lanilis <[email protected]>, "[email protected]" 
<[email protected]>
Subject: [DCAE] documentation on APIs

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

While there is some DCAE API documentation on the wiki at: 
https://wiki.onap.org/display/DW/DCAE+API+Documentation , 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

There is currently no documentation on DCAE APIs available at  
http://onap.readthedocs.io/en/latest/index.html
(The documentation tool chain/Jenkins jobs are up and working now for other 
projects)

Can the DCAE project/PTL  identify a contact person to work on the 
documentation aspects of DCAE?
Ideally the contact should be identified 
here<https://wiki.onap.org/display/DW/Doc+Project+Coverage+Matrix>.
The general process on documenting projects in ONAP is described 
here<http://onap.readthedocs.io/en/latest/guide/onap-developer/how-to-use-docs/index.html>.

VNFs have requirements to support DCAE APIs. From VNFRQTS project, we are 
trying to complete 
VNFRQTS-90<https://jira.onap.org/secure/RapidBoard.jspa?rapidView=63&projectKey=VNFRQTS&view=planning&selectedIssue=VNFRQTS-90>
 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 for our 
requirements deliverable to point to for DCAE API documentation. Our VNFRQTS 
Sprint 3 is due to complete September 12, so  we would appreciate if you could 
have the DCAE API documentation outline up at  
http://onap.readthedocs.io/en/latest/index.html within the next week.

Please advise if you need help to achieve this.

best regards
Steven Wright, MBA, PhD, JD.
[ech Integration]
AT&T Services Inc.
1057 Lenox Park Blvd NE, STE 4D28
Atlanta, GA 30319
P: 470.415.3156

[email protected]<mailto:[email protected]>
www.linkedin.com/in/drstevenawright/<http://www.linkedin.com/in/drstevenawright/>

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

Reply via email to