summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authormaopengzhang <zhang.maopeng1@zte.com.cn>2018-08-15 19:04:45 +0800
committermaopengzhang <zhang.maopeng1@zte.com.cn>2018-08-16 13:52:42 +0800
commit70d9e11d563d58d316734fd0c5307dcc99d70f9a (patch)
tree2f2c1c7bf02f4cdeb6c909e834de5f968029beba /README.md
parent35b5bb6b423691ed1819732bae4e41864112810e (diff)
SOL003 API Align
SOL003 API ALign - catalog api align Change-Id: I38b454a4292d6ea612679b585b744c209a1160bb Issue-ID: VFC-635 Signed-off-by: maopengzhang <zhang.maopeng1@zte.com.cn>
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 15867162..9f3141f5 100644
--- a/README.md
+++ b/README.md
@@ -13,3 +13,22 @@
# limitations under the License.
# Micro service of nfvo catalog.
+
+1. Code structure guide
+ ./ project files
+ ./docker docker related scripts
+ ./logs log file
+ ./catalog catalog management
+ ./packages package life cycle API& logic
+ ./ API url definition
+ ./views API related views, each operation is a view
+ ./serializers API related request and response parametes.
+ Suggest related to sol003/sol005, each datatype is a file.
+ Common datatypes are put into the common file
+ ./biz Package mangement busyness logic files
+ ./tests All the test case. At least each API should have a test case
+ ./jobs Related job
+ ./pub Common class, including database, external micro service API, utils, and config parameters.
+ ./samples Catalog micro service health check
+ ./swagger Auto-generate catalog swagger json or yaml files
+ ./static/catalog package storage