Bug 47 - Paths: SOL002 VNF Indicator Interface
Summary: Paths: SOL002 VNF Indicator Interface
Status: CONFIRMED
Alias: None
Product: NFV
Classification: Unclassified
Component: Nfv-Openapis (show other bugs)
Version: unspecified
Hardware: PC Windows
Assignee: Michele Carignani
 
Reported: 2018-03-20 23:09 CET by Ernest Bayha
Modified: 2018-03-20 23:09 CET (History)
0 users

See Also:
Version number of the related document:
OpenAPI issue category: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ernest Bayha 2018-03-20 23:09:58 CET
A review of the SOL003 LCM interface demonstrates that the approach taken for documenting the methods and resources is DIFFERENT than the approach taken for the SOL002 VNF indicators interface. This is probably due to different authors writing the OpenAPIs. However, the OpenAPIs should have a common "look and feel" and should only differ in content and not in documentation style across the OpenAPIs for the various GSs.

PREFERRED approach: method /resource

ex: POST /subscriptions (from SOL003 VNF LCM OpenAPI)

DO NOT PREFER approach in SOL002 VNF Indicator OpenAPI

ex: Query multiple indicators (though reference to OpenAPI symbol GET /indicators is ok)

The Description field in the SOL002 VNF indicator OpenAPI should be copied from the text describing the appropriate method for a given resource. The following text for the VNF Indicator "Get a list of indicators. Support of attribute based filtering via query parameters." is not directly copied from the GS NFV-SOL002. Best to avoid introducing new text that does not appear in the GS. Use instead "This resource represents VNF indicators. The client can use this resource to query multiple VNF indicators."

Do we need to copy the attribute-based filtering text?