From a241c7043b2496004c8f2ea18a6f4376de91a61e Mon Sep 17 00:00:00 2001 From: maopengzhang Date: Mon, 6 Aug 2018 19:49:43 +0800 Subject: SOL003 API Align code guide SOL003 API ALign -VNFLCM code guide Change-Id: I1f32479b1f77553f215f643f1ce6a8ca8ef553f4 Issue-ID: VFC-635 Signed-off-by: maopengzhang --- lcm/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/lcm/README.md b/lcm/README.md index 65717d61..159c1036 100644 --- a/lcm/README.md +++ b/lcm/README.md @@ -13,3 +13,21 @@ See the License for the specific language governing permissions and limitations under the License. Micro service of vnf life cycle management. + +1. Code structure guide + ./ vnflcm project files + ./docker vnflcm docker related scripts + ./logs vnflcm log file + ./lcm vnf life cycle management + ./nf vnf life cycle API& logic + ./ API url and const + ./views API related VNF views, each operation is a view + ./serializers API related request and response parametes. + Suggest related to sol003, each datatype is a file. + Common datatypes are put into the common file + ./biz VNF LCM mangement busyness logic files + ./tests all the test case. At least each API should have a test case + ./jobs vnf lcm related job + ./pub common class, including database, external micro service API, utils, and config parameters. + ./samples vnflcm micro service health check + ./swagger auto-generate vnflcm swagger -- cgit 1.2.3-korg