[Starlingx-discuss] API requests: stx-nfv
Barton.Wensley at windriver.com
Thu Dec 6 13:38:30 UTC 2018
Good analysis - see my replies in your email below…
From: Arce Moreno, Abraham [mailto:abraham.arce.moreno at intel.com]
Sent: December 4, 2018 4:25 PM
To: starlingx-discuss at lists.starlingx.io
Subject: [Starlingx-discuss] API requests: stx-nfv
As a result of time spent within stx-nfv and with the objective to align our
REST API Documentation  with our REST APIs, we are kindly requesting your
comments for questions "?" under each section [ Section ] [Sub Section]
- The require X-Auth-Token is in place to authenticate:
$ curl -i -X POST http://10.10.10.2:5000/v2.0/tokens
$ export TOKEN=...
- StarlingX is configured as Standard Controller: 2 Controllers, 2 Computes.
[ Project Information ]
When we look at the name and description reported out by
curl -i http://10.10.10.2:4545/
we have the same name and description between documentation  and
information via API Query:
Description: NFV - Virtual Infrastructure Manager
? Anything to add / change to the name and / or description?
[Bart] The current response seems OK to me.
[ /api ]
Here we are showing 3 different views of what we are seeing within stx-nfv
- Our initial "Migration WADL to RST", see history here 
- What we have documented in our "Current Official API Documentation" pages 
- What the "API Query Output" is actually showing with
curl -i http://10.10.10.2:4545/api/...
[ /api ] [ Migration WADL to RST ]
FYI Only. Migration from WADL to RST format requested us to move "NFV VIM API v1"
(NFV VIM Service REST API) into stx-nfv repository, see  for the history.
[ /api ] [ Current Official API Documentation ]
Current Official API documentation  includes the following REST API methods
under "API Versions" details:
And the only documented API REST methods documented are:
-  Patch Strategy
-  Upgrade Strategy
? Is "orchestration" not expected to be documented even if we have the GET
[Bart] The orchestration level is just a grouping for sw-patch and sw-upgrade. The GET method just returns the links to those and that is documented in  - what else would you want to add?
[ /api ] [ API Query Output ]
API queries output shows these API REST methods:
? Our "Current Official API Documentation" does not have "openstack"
and "virtualised-resources", should they be added?
[Bart] Good question. We have never officially supported the openstack or virtualised-resources APIs and we know that some of them don’t work. I would be open to removing these from our API if that would be less confusing.
[ Project Repository ] [ Directory nfv-doc ]
We took a look at the project repository and we found the "nfv-doc" directory 
with the following categories:
- Software Image Management
- Virtualised Network Resource
- Virtualised Storage Resource
- Virtualised Compute Resource
? Since we have our "Current Official API Documentation", should we put a patch
to remove this directory? Any reason to keep it?
[Bart] I think we should remove the directory.
[ Project Repository ] [ Directory nfv-tests ]
Looking this nfv-tests  it includes 3 categories:
? Is there any restructure required in this nfv-tests directory?
? Is there any need to think about a general test strategy which includes all
StarlingX projects moved its execution into another place? e.g. Zuul
[Bart] Once the basic devstack setup is working for stx-nfv, we can look at adding new testcases to be executed in that environment. This won’t replace the existing testcases, but supplement them.
? Is this directory still valid? If not should we put a patch to remove it?
[Bart] The directory is still valid.
Thanks for your initial support.
Starlingx-discuss mailing list
Starlingx-discuss at lists.starlingx.io
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the Starlingx-discuss