nofusscomputing/centurion_erp
1
0
Fork 0
Code Issues Wiki Activity

feat(project_management): Add Project Milestone API v2 endpoint

Browse Source 
ref: #248 #357
This commit is contained in:
Jon Lockwood
2024-10-22 11:22:26 +09:30
parent a708644809
commit 11e3b04b46
6 changed files with 229 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/api/urls.py
View File

@ -90,6 +90,7 @@ from itim.viewsets import (
from project_management.viewsets import (
index as project_management_v2,
project as project_v2,
project_milestone as project_milestone_v2
)
from settings.viewsets import (
@ -177,6 +178,7 @@ router.register('v2/itim/service/(?P<service_id>[0-9]+)/notes', notes_v2.ViewSet
router.register('v2/project_management', project_management_v2.Index, basename='_api_v2_project_management_home')
router.register('v2/project_management/project', project_v2.ViewSet, basename='_api_v2_project')
router.register('v2/project_management/project/(?P<project_id>[0-9]+)/milestone', project_milestone_v2.ViewSet, basename='_api_v2_project_milestone')
router.register('v2/settings', settings_index_v2.Index, basename='_api_v2_settings_home')
router.register('v2/settings/cluster_type', cluster_type_v2.ViewSet, basename='_api_v2_cluster_type')

2
app/api/views/project_management/project_milestone.py
View File

@ -9,7 +9,7 @@ from api.serializers.project_management.project_milestone import ProjectMileston
from api.views.mixin import OrganizationPermissionAPI
@extend_schema(deprecated = True )
class View(OrganizationMixin, viewsets.ModelViewSet):
permission_classes = [

4
app/itam/serializers/device_software.py
View File

@ -1,8 +1,8 @@
from rest_framework import serializers
from rest_framework.fields import empty
from rest_framework.reverse import reverse
from rest_framework import serializers
from rest_framework.fields import empty
from access.serializers.organization import OrganizationBaseSerializer

5
app/project_management/serializers/project.py
View File

@ -56,6 +56,7 @@ class ProjectModelSerializer(ProjectBaseSerializer):
'model_id': item.pk
}
),
'milestone': reverse("API:_api_v2_project_milestone-list", request=self._context['view'].request, kwargs={'project_id': item.pk}),
'notes': reverse("API:_api_v2_cluster_notes-list", request=self._context['view'].request, kwargs={'cluster_id': item.pk}),
'tickets': 'ToDo'
}
@ -65,8 +66,6 @@ class ProjectModelSerializer(ProjectBaseSerializer):
model = Project
fields = '__all__'
fields = [
'id',
'external_ref',
@ -87,8 +86,6 @@ class ProjectModelSerializer(ProjectBaseSerializer):
'manager_team',
'team_members',
'is_deleted',
'is_global',
'created',
'modified',

129
app/project_management/serializers/project_milestone.py Normal file
View File

@ -0,0 +1,129 @@
from rest_framework import serializers
from rest_framework.fields import empty
from rest_framework.reverse import reverse
from access.serializers.organization import OrganizationBaseSerializer
from project_management.models.project_milestone import ProjectMilestone
from project_management.serializers.project import Project, ProjectBaseSerializer
class ProjectMilestoneBaseSerializer(serializers.ModelSerializer):
display_name = serializers.SerializerMethodField('get_display_name')
def get_display_name(self, item):
return str( item )
url = serializers.SerializerMethodField('get_url')
def get_url(self, item):
return reverse(
"API:_api_v2_project_milestone-detail",
request=self._context['view'].request,
kwargs={
'project_id': item.project.id,
'pk': item.pk
}
)
class Meta:
model = ProjectMilestone
fields = [
'id',
'display_name',
'name',
'url',
]
read_only_fields = [
'id',
'display_name',
'name',
'url',
]
class ProjectMilestoneModelSerializer(ProjectMilestoneBaseSerializer):
_urls = serializers.SerializerMethodField('get_url')
def get_url(self, item):
return {
'_self': reverse(
"API:_api_v2_project_milestone-detail",
request=self._context['view'].request,
kwargs={
'project_id': item.project.id,
'pk': item.pk
}
),
}
class Meta:
model = ProjectMilestone
fields = [
'id',
'organization',
'display_name',
'name',
'description',
'start_date',
'finish_date',
'project',
'is_global',
'created',
'modified',
'_urls',
]
read_only_fields = [
'id',
'display_name',
'created',
'modified',
'_urls',
]
def __init__(self, instance=None, data=empty, **kwargs):
super().__init__(instance=instance, data=data, **kwargs)
self.fields.fields['project'].read_only = True
self.fields.fields['organization'].read_only = True
def is_valid(self, *, raise_exception=False):
is_valid = super().is_valid(raise_exception=raise_exception)
project = Project.objects.get(
pk = int(self._kwargs['context']['view'].kwargs['project_id'])
)
self.validated_data.update({
'organization': project.organization,
'project': project
})
return is_valid
class ProjectMilestoneViewSerializer(ProjectMilestoneModelSerializer):
organization = OrganizationBaseSerializer( many = False, read_only = True )
project = ProjectBaseSerializer( many = False, read_only = True )

94
app/project_management/viewsets/project_milestone.py Normal file
View File

@ -0,0 +1,94 @@
from drf_spectacular.utils import extend_schema, extend_schema_view, OpenApiResponse
from api.viewsets.common import ModelViewSet
from project_management.serializers.project_milestone import (
ProjectMilestone,
ProjectMilestoneModelSerializer,
ProjectMilestoneViewSerializer
)
@extend_schema_view(
create=extend_schema(
summary = 'Create a cluster',
description='',
responses = {
201: OpenApiResponse(description='Device created', response=ProjectMilestoneViewSerializer),
400: OpenApiResponse(description='Validation failed.'),
403: OpenApiResponse(description='User is missing create permissions'),
}
),
destroy = extend_schema(
summary = 'Delete a cluster',
description = '',
responses = {
204: OpenApiResponse(description=''),
403: OpenApiResponse(description='User is missing delete permissions'),
}
),
list = extend_schema(
summary = 'Fetch all clusters',
description='',
responses = {
200: OpenApiResponse(description='', response=ProjectMilestoneViewSerializer),
403: OpenApiResponse(description='User is missing view permissions'),
}
),
retrieve = extend_schema(
summary = 'Fetch a single cluster',
description='',
responses = {
200: OpenApiResponse(description='', response=ProjectMilestoneViewSerializer),
403: OpenApiResponse(description='User is missing view permissions'),
}
),
update = extend_schema(exclude = True),
partial_update = extend_schema(
summary = 'Update a cluster',
description = '',
responses = {
200: OpenApiResponse(description='', response=ProjectMilestoneViewSerializer),
403: OpenApiResponse(description='User is missing change permissions'),
}
),
)
class ViewSet( ModelViewSet ):
filterset_fields = []
search_fields = [
'name',
'description',
]
model = ProjectMilestone
documentation: str = 'https://nofusscomputing.com/docs/not_model_docs'
view_description = 'Physical Devices'
def get_queryset(self):
queryset = super().get_queryset()
queryset = queryset.filter( project_id = self.kwargs['project_id'])
self.queryset = queryset
return self.queryset
def get_serializer_class(self):
if (
self.action == 'list'
or self.action == 'retrieve'
):
return globals()[str( self.model._meta.verbose_name).replace(' ', '') + 'ViewSerializer']
return globals()[str( self.model._meta.verbose_name).replace(' ', '') + 'ModelSerializer']