1.Update API endpoint; 2. update swagger information.
[modeling/etsicatalog.git] / catalog / packages / const.py
1 # Copyright 2018 ZTE Corporation.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #         http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 from catalog.pub.utils.jobutil import enum
16
17 PKG_STATUS = enum(
18     CREATED="CREATED",
19     UPLOADING="UPLOADING",
20     PROCESSING="PROCESSING",
21     ONBOARDED="ONBOARDED",
22     IN_USE="IN_USE",
23     NOT_IN_USE="NOT_IN_USE",
24     ENABLED="ENABLED",
25     DISABLED="DISABLED"
26 )
27
28 AUTH_TYPES = [
29     "BASIC",
30     "OAUTH2_CLIENT_CREDENTIALS",
31     "TLS_CERT"
32 ]
33
34 BASIC = "BASIC"
35
36 OAUTH2_CLIENT_CREDENTIALS = "OAUTH2_CLIENT_CREDENTIALS"
37
38 NOTIFICATION_TYPES = [
39     "VnfPackageOnboardingNotification",
40     "VnfPackageChangeNotification"
41 ]
42 PKG_CHANGE_TYPE = enum(OP_STATE_CHANGE="OP_STATE_CHANGE", PKG_DELETE="PKG_DELETE")
43
44 PKG_NOTIFICATION_TYPE = enum(ONBOARDING="VnfPackageOnboardingNotification",
45                              CHANGE="VnfPackageChangeNotification")
46
47 NSD_NOTIFICATION_TYPE = enum(NSD_ONBOARDING="NsdOnBoardingNotification",
48                              NSD_ONBOARDING_FAILURE="NsdOnboardingFailureNotification",
49                              NSD_CHANGE="NsdChangeNotification",
50                              NSD_DELETION="NsdDeletionNotification",
51                              PNFD_ONBOARDING="PnfdOnBoardingNotification",
52                              PNFD_ONBOARDING_FAILURE="PnfdOnBoardingFailureNotification",
53                              PNFD_DELETION="PnfdDeletionNotification")
54
55 PKG_URL_PREFIX = "api/vnfpkgm/v1"
56
57 NSD_URL_PREFIX = "api/nsd/v1"
58
59 VNFPKG_SUBSCRIPTION_ROOT_URI = "api/vnfpkgm/v1/subscriptions/"
60
61 NSDM_SUBSCRIPTION_ROOT_URI = "api/nsd/v1/subscriptions/"
62
63 NSDM_NOTIFICATION_FILTERS = [
64     "notificationTypes",
65     "nsdInfoId",
66     "nsdName",
67     "nsdId",
68     "nsdVersion",
69     "nsdDesigner",
70     "nsdInvariantId",
71     "vnfPkgIds",
72     "pnfdInfoIds",
73     "nestedNsdInfoIds",
74     "nsdOnboardingState",
75     "nsdOperationalState",
76     "nsdUsageState",
77     "pnfdId",
78     "pnfdName",
79     "pnfdVersion",
80     "pnfdProvider",
81     "pnfdInvariantId",
82     "pnfdOnboardingState",
83     "pnfdUsageState"
84 ]
85
86 NSDM_NOTIFICATION_TYPES = [
87     "NsdOnBoardingNotification",
88     "NsdOnboardingFailureNotification",
89     "NsdChangeNotification",
90     "NsdDeletionNotification",
91     "PnfdOnBoardingNotification",
92     "PnfdOnBoardingFailureNotification",
93     "PnfdDeletionNotification"
94 ]
95
96 # API swagger tag
97 TAG_CATALOG_API = "Catalog interface"
98
99 TAG_PARSER_API = "Parser interface"
100
101 TAG_NSD_API = "NSD Management interface"
102
103 TAG_PNFD_API = "NSD Management interface"
104
105 TAG_VNF_PACKAGE_API = "VNF Package Management interface"
106
107 TAG_HEALTH_CHECK = "Health Check interface"