Jump to: navigation, search

Difference between revisions of "StarlingX/Developer Guide/API Documentation"

(StarlingX API Brand New)
Line 29: Line 29:
 
The projects falling into this category are the following:
 
The projects falling into this category are the following:
  
* [0] NFVI Orchestration
+
* [http://git.openstack.org/cgit/openstack/stx-nfv/ NFVI Orchestration]
* [1] High Availability/Process Monitoring/Service Management
+
* [http://git.openstack.org/cgit/openstack/stx-ha/ High Availability/Process Monitoring/Service Management]
* [2] StarlingX System Configuration Management
+
* [http://git.openstack.org/cgit/openstack/stx-config/ StarlingX System Configuration Management]
* [3] Horizon plugins for new StarlingX services
+
* [http://git.openstack.org/cgit/openstack/stx-gui/ Horizon plugins for new StarlingX services]
* [4] Installation/Update/Patching/Backup/Restore
+
* [http://git.openstack.org/cgit/openstack/stx-update/ Installation/Update/Patching/Backup/Restore]
 
<br>
 
<br>
All projects in the Flock should be included.  I think there is a dependency on some of the code restructuring activities that are underway, we need to make sure these activities don't collide.
+
All projects in the Flock should be included.  I think there is a dependency on some of the code restructuring activities that are underway, we need to make sure these activities don't collide.
  
 
=== StarlingX API Existing ===
 
=== StarlingX API Existing ===

Revision as of 16:39, 7 August 2018

Intro

StarlingX team is working in collaboration with Tech Writing team to document StarlingX APIs, this page reflects the research on what it means for StarlingX.

History

OpenStack API

For this activity we are initially be considering from API Documentation 2 separate efforts for each project:

  • API Guide .. the concepts in the API
  • API Ref .. a reference for the API

Both concepts (API Guide) and the ref (API Ref) need to be be written at the same time. The new OpenStack approach allows for tags to go in the code.

StarlingX API

We categorize the StarlingX APIs in 2:

  • Brand New APIs from StarlingX projects
  • Existing APIs from OpenStack projects

StarlingX should not document other OpenStack API's.

StarlingX API Brand New

The projects falling into this category are the following:


All projects in the Flock should be included. I think there is a dependency on some of the code restructuring activities that are underway, we need to make sure these activities don't collide.

StarlingX API Existing

We have not gone through a deeper review if we are modifying/adding new calls into the OpenStack projects however if we are and we need to document them:

  • There is official OpenStack <Project> API documentation, we can make references to them for the existing calls
  • What about the modifications/additions? Should we document them? What is the best place for this? We were talking in our weekly call about stx-docs is a good place for things without a repo, is this a good example?
  • Any easy way besides "find + grep" to get where those API modifications are happening?

StarlingX API Unit Tests

OpenStack projects includes Unit Tests. To be considered if this is required.