./ project files
./docker docker related scripts
./logs log file
- ./genericparser generic parser management
+ ./catalog generic parser management
./packages package life cycle API& logic
./ API url definition
./views API related views, each operation is a view
@swagger_auto_schema(
method='POST',
operation_description="On distribute NS package",
+ tags=["NS packages API"],
request_body=NsPackageDistributeRequestSerializer,
responses={
status.HTTP_202_ACCEPTED: NsPackageDistributeResponseSerializer,
@swagger_auto_schema(
method='GET',
operation_description="Query NS packages",
+ tags=["NS packages API"],
request_body=no_body,
responses={
status.HTTP_200_OK: NsPackagesSerializer,
@swagger_auto_schema(
method='POST',
operation_description="On distribute Nf package",
+ tags=["NF packages API"],
request_body=NfPackageDistributeRequestSerializer(),
responses={
status.HTTP_202_ACCEPTED: PostJobResponseSerializer,
@swagger_auto_schema(
method='GET',
operation_description="Query Nf packages",
+ tags=["NF packages API"],
request_body=no_body,
responses={
status.HTTP_200_OK: NfPackagesSerializer,
@swagger_auto_schema(
method='DELETE',
operation_description="Delete one NS package",
+ tags=["NS packages API"],
request_body=no_body,
manual_parameters=[
openapi.Parameter(
@swagger_auto_schema(
method='GET',
operation_description="Query one NS package",
+ tags=["NS packages API"],
request_body=no_body,
manual_parameters=[
openapi.Parameter(
@swagger_auto_schema(
method='POST',
operation_description="On distribute Service package",
+ tags=["Service packages API"],
request_body=ServicePackageDistributeRequestSerializer,
responses={
status.HTTP_202_ACCEPTED: "",
@swagger_auto_schema(
method='GET',
operation_description="Query Service packages",
+ tags=["Service packages API"],
request_body=no_body,
responses={
status.HTTP_200_OK: ServicePackagesSerializer,
@swagger_auto_schema(
method='DELETE',
operation_description="Delete one Service package",
+ tags=["Service packages API"],
request_body=no_body,
manual_parameters=[
openapi.Parameter(
@swagger_auto_schema(
method='GET',
operation_description="Query one Service package",
+ tags=["Service packages API"],
request_body=no_body,
manual_parameters=[
openapi.Parameter(
@swagger_auto_schema(
method='DELETE',
operation_description="Delete one Nf package",
+ tags=["NF packages API"],
request_body=no_body,
manual_parameters=[
openapi.Parameter(
@swagger_auto_schema(
method='GET',
operation_description="Query one Nf package",
+ tags=["NF packages API"],
request_body=no_body,
manual_parameters=[
openapi.Parameter(
@swagger_auto_schema(
method='POST',
operation_description="Parse model(NS, Service, VNF, PNF)",
+ tags=["Parser API"],
request_body=ParseModelRequestSerializer,
responses={
status.HTTP_202_ACCEPTED: ParseModelResponseSerializer,
@swagger_auto_schema(
method='POST',
operation_description="Parse NS model",
+ tags=["Parser API"],
request_body=ParseModelRequestSerializer,
responses={
status.HTTP_202_ACCEPTED: ParseModelResponseSerializer,
@swagger_auto_schema(
method='POST',
operation_description="Parse NF model",
+ tags=["Parser API"],
request_body=ParseModelRequestSerializer,
responses={
status.HTTP_202_ACCEPTED: ParseModelResponseSerializer,
class HealthCheckView(APIView):
@swagger_auto_schema(
+ tags=["Health check API"],
responses={
status.HTTP_200_OK: 'Active'})
def get(self, request, format=None):
@swagger_auto_schema(
method='GET',
operation_description="Query a NSD",
+ tags=["NSD API"],
request_body=no_body,
responses={
status.HTTP_200_OK: NsdInfoSerializer(),
@swagger_auto_schema(
method='DELETE',
operation_description="Delete a NSD",
+ tags=["NSD API"],
request_body=no_body,
responses={
status.HTTP_204_NO_CONTENT: "No content",
@swagger_auto_schema(
method='POST',
operation_description="Create a NSD",
+ tags=["NSD API"],
request_body=CreateNsdInfoRequestSerializer(),
responses={
status.HTTP_201_CREATED: NsdInfoSerializer(),
@swagger_auto_schema(
method='GET',
operation_description="Query multiple NSDs",
+ tags=["NSD API"],
request_body=no_body,
responses={
status.HTTP_200_OK: NsdInfosSerializer(),
@swagger_auto_schema(
method='PUT',
operation_description="Upload NSD content",
+ tags=["NSD API"],
request_body=no_body,
responses={
status.HTTP_204_NO_CONTENT: 'PNFD file',
@swagger_auto_schema(
method='GET',
operation_description="Download NSD content",
+ tags=["NSD API"],
request_body=no_body,
responses={
status.HTTP_204_NO_CONTENT: "No content",
@swagger_auto_schema(
method='POST',
operation_description="Create Subscription for NSD Management",
+ tags=["NSD API"],
request_body=NsdmSubscriptionRequestSerializer(),
responses={
status.HTTP_201_CREATED: NsdmSubscriptionSerializer,
@swagger_auto_schema(
method='GET',
operation_description="Query subscriptions for Nsd Management",
+ tags=["NSD API"],
request_body=no_body,
responses={
status.HTTP_200_OK: NsdmSubscriptionsSerializer(),
@swagger_auto_schema(
method='GET',
operation_description="Query subscriptions for Nsd Management",
+ tags=["NSD API"],
request_body=no_body,
responses={
status.HTTP_200_OK: NsdmSubscriptionSerializer(),
@swagger_auto_schema(
method='DELETE',
operation_description="Delete subscription for Nsd Management",
+ tags=["NSD API"],
request_body=no_body,
responses={
status.HTTP_204_NO_CONTENT: 'No_Content',
@swagger_auto_schema(
method='GET',
operation_description="Query a PNFD",
+ tags=["PNFD API"],
request_body=no_body,
responses={
status.HTTP_200_OK: PnfdInfoSerializer(),
@swagger_auto_schema(
method='DELETE',
operation_description="Delete a PNFD",
+ tags=["PNFD API"],
request_body=no_body,
responses={
status.HTTP_204_NO_CONTENT: "No content",
@swagger_auto_schema(
method='POST',
operation_description="Create a PNFD",
+ tags=["PNFD API"],
request_body=CreatePnfdInfoRequestSerializer(),
responses={
status.HTTP_201_CREATED: PnfdInfoSerializer(),
@swagger_auto_schema(
method='GET',
operation_description="Query multiple PNFDs",
+ tags=["PNFD API"],
request_body=no_body,
responses={
status.HTTP_200_OK: PnfdInfosSerializer(),
@swagger_auto_schema(
method='PUT',
operation_description="Upload PNFD content",
+ tags=["PNFD API"],
request_body=no_body,
responses={
status.HTTP_204_NO_CONTENT: "No content",
@swagger_auto_schema(
method='GET',
operation_description="Fetch PNFD content",
+ tags=["PNFD API"],
request_body=no_body,
responses={
status.HTTP_204_NO_CONTENT: 'PNFD file',
@swagger_auto_schema(
method='POST',
operation_description="Parse PNF model",
+ tags=["Parser API"],
request_body=ParseModelRequestSerializer,
responses={
status.HTTP_202_ACCEPTED: ParseModelResponseSerializer,
class FetchVnfPkgmArtifactsView(APIView):
@swagger_auto_schema(
+ tags=["VNF Package API"],
responses={
status.HTTP_200_OK: "HTTP_200_OK",
status.HTTP_404_NOT_FOUND: ProblemDetailsSerializer(),
class CreateQuerySubscriptionView(APIView):
@swagger_auto_schema(
+ tags=["VNF Package API"],
request_body=PkgmSubscriptionRequestSerializer,
responses={
status.HTTP_201_CREATED: PkgmSubscriptionSerializer(),
return Response(data=subscription_info.data, status=status.HTTP_201_CREATED)
@swagger_auto_schema(
+ tags=["VNF Package API"],
responses={
status.HTTP_200_OK: PkgmSubscriptionSerializer(),
status.HTTP_400_BAD_REQUEST: ProblemDetailsSerializer(),
class QueryTerminateSubscriptionView(APIView):
@swagger_auto_schema(
+ tags=["VNF Package API"],
responses={
status.HTTP_200_OK: PkgmSubscriptionSerializer(),
status.HTTP_404_NOT_FOUND: ProblemDetailsSerializer(),
return Response(data=subscription_serializer.data, status=status.HTTP_200_OK)
@swagger_auto_schema(
+ tags=["VNF Package API"],
responses={
status.HTTP_204_NO_CONTENT: "",
status.HTTP_404_NOT_FOUND: ProblemDetailsSerializer(),
@swagger_auto_schema(
method="GET",
operation_description="Query multiple VNF package resource",
+ tags=["VNF Package API"],
request_body=no_body,
responses={
status.HTTP_200_OK: VnfPkgInfosSerializer(),
@swagger_auto_schema(
method="POST",
operation_description="Create an individual VNF package resource",
+ tags=["VNF Package API"],
request_body=CreateVnfPkgInfoRequestSerializer,
responses={
status.HTTP_201_CREATED: VnfPkgInfoSerializer(),
@swagger_auto_schema(
method='PUT',
operation_description="Upload VNF package content",
+ tags=["VNF Package API"],
request_body=no_body,
responses={
status.HTTP_202_ACCEPTED: "Successfully",
@swagger_auto_schema(
method="GET",
operation_description="Fetch VNF package content",
+ tags=["VNF Package API"],
request_body=no_body,
responses={
status.HTTP_200_OK: VnfPkgInfosSerializer(),
@swagger_auto_schema(
method='POST',
operation_description="Upload VNF package content from uri",
+ tags=["VNF Package API"],
request_body=UploadVnfPackageFromUriRequestSerializer,
responses={
status.HTTP_202_ACCEPTED: "Successfully",
@swagger_auto_schema(
method='GET',
operation_description="Query an individual VNF package resource",
+ tags=["VNF Package API"],
request_body=no_body,
responses={
status.HTTP_200_OK: VnfPkgInfoSerializer(),
@swagger_auto_schema(
method='DELETE',
operation_description="Delete an individual VNF package resource",
+ tags=["VNF Package API"],
request_body=no_body,
responses={
status.HTTP_204_NO_CONTENT: "No content",
"swagger": "2.0",
"info": {
"version": "1.0.0",
- "title": "ONAP VFC Catalog Rest API",
- "description": "VFC Catalog Management API.",
+ "title": "ONAP Modeling etsicatalog Rest API",
+ "description": "Modeling etsicatalog Management API.",
"contact": {
- "name": "ONAP VFC team",
+ "name": "ONAP Modeling team",
"email": "onap-discuss@lists.onap.org",
- "url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/catalog"
+ "url": "https://gerrit.onap.org/r/#/admin/projects/modeling/etsicatalog"
}
},
"basePath": "/api/catalog/v1",
# Add code for generating swagger automatically.
swagger_info = openapi.Info(
- title="VFC Catalog API",
+ title="Modeling etsicatalog API",
default_version='v1',
description="""
class SwaggerJsonView(APIView):
def get(self, request):
- json_file = os.path.join(os.path.dirname(__file__), 'vfc.catalog.swagger.json')
+ json_file = os.path.join(os.path.dirname(__file__), 'etsicatalog.swagger.json')
f = open(json_file)
json_data = json.JSONDecoder().decode(f.read())
f.close()