nofusscomputing/centurion_erp
1
0
Fork 0
Code Issues Wiki Activity

feat(itim): Add Cluster Type API v2 endpoint

Browse Source 
ref: #248 #356
This commit is contained in:
Jon Lockwood
2024-10-21 15:09:19 +09:30
parent f1c5ebca71
commit 02822cc70d
6 changed files with 202 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
app/api/react_ui_metadata.py
View File

@ -148,6 +148,17 @@ class ReactUIMetadata(OverRideJSONAPIMetadata):
}
]
},
{
"display_name": "ITIM",
"name": "itim",
"pages": [
{
"display_name": "Services",
"name": "service",
"link": "/itim/service"
},
]
},
{
"display_name": "Config Management",
"name": "config_management",

3
app/api/urls.py
View File

@ -80,6 +80,7 @@ from itam.viewsets import (
from itim.viewsets import (
index as itim_v2,
cluster_type as cluster_type_v2,
service as service_v2,
)
@ -170,6 +171,8 @@ 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/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')
router.register('v2/settings/cluster_type/(?P<cluster_type_id>[0-9]+)/notes', notes_v2.ViewSet, basename='_api_v2_cluster_type_notes')
router.register('v2/settings/device_model', device_model_v2.ViewSet, basename='_api_v2_device_model')
router.register('v2/settings/device_type', device_type_v2.ViewSet, basename='_api_v2_device_type')
router.register('v2/settings/external_link', external_link_v2.ViewSet, basename='_api_v2_external_link')

14
app/itim/models/clusters.py
View File

@ -65,7 +65,7 @@ class ClusterType(TenancyObject):
"layout": "double",
"left": [
'organization',
'name'
'name',
'is_global',
],
"right": [
@ -82,18 +82,6 @@ class ClusterType(TenancyObject):
}
]
},
{
"name": "Rendered Config",
"slug": "config_management",
"sections": [
{
"layout": "single",
"fields": [
"rendered_config",
]
}
]
},
{
"name": "Tickets",
"slug": "ticket",

92
app/itim/serializers/cluster_type.py Normal file
View File

@ -0,0 +1,92 @@
from rest_framework.reverse import reverse
from rest_framework import serializers
from access.serializers.organization import OrganizationBaseSerializer
from itam.serializers.device import DeviceBaseSerializer
from itim.models.clusters import ClusterType
class ClusterTypeBaseSerializer(serializers.ModelSerializer):
display_name = serializers.SerializerMethodField('get_display_name')
def get_display_name(self, item):
return str( item )
url = serializers.HyperlinkedIdentityField(
view_name="API:_api_v2_cluster_type-detail", format="html"
)
class Meta:
model = ClusterType
fields = [
'id',
'display_name',
'name',
'url',
]
read_only_fields = [
'id',
'display_name',
'name',
'url',
]
class ClusterTypeModelSerializer(ClusterTypeBaseSerializer):
_urls = serializers.SerializerMethodField('get_url')
def get_url(self, item):
return {
'_self': reverse("API:_api_v2_cluster_type-detail", request=self._context['view'].request, kwargs={'pk': item.pk}),
'history': reverse(
"API:_api_v2_model_history-list",
request=self._context['view'].request,
kwargs={
'model_class': self.Meta.model._meta.model_name,
'model_id': item.pk
}
),
'notes': reverse("API:_api_v2_cluster_type_notes-list", request=self._context['view'].request, kwargs={'cluster_type_id': item.pk}),
}
class Meta:
model = ClusterType
fields = [
'id',
'organization',
'display_name',
'name',
'model_notes',
'config',
'is_global',
'created',
'modified',
'_urls',
]
read_only_fields = [
'id',
'display_name',
'created',
'modified',
'_urls',
]
class ClusterTypeViewSerializer(ClusterTypeModelSerializer):
organization = OrganizationBaseSerializer( many = False, read_only = True )

85
app/itim/viewsets/cluster_type.py Normal file
View File

@ -0,0 +1,85 @@
from drf_spectacular.utils import extend_schema, extend_schema_view, OpenApiResponse
from api.viewsets.common import ModelViewSet
from itim.serializers.cluster_type import (
ClusterType,
ClusterTypeModelSerializer,
ClusterTypeViewSerializer
)
@extend_schema_view(
create=extend_schema(
summary = 'Create a cluster type',
description='',
responses = {
201: OpenApiResponse(description='Device created', response=ClusterTypeViewSerializer),
400: OpenApiResponse(description='Validation failed.'),
403: OpenApiResponse(description='User is missing create permissions'),
}
),
destroy = extend_schema(
summary = 'Delete a cluster type',
description = '',
responses = {
204: OpenApiResponse(description=''),
403: OpenApiResponse(description='User is missing delete permissions'),
}
),
list = extend_schema(
summary = 'Fetch all cluster types',
description='',
responses = {
200: OpenApiResponse(description='', response=ClusterTypeViewSerializer),
403: OpenApiResponse(description='User is missing view permissions'),
}
),
retrieve = extend_schema(
summary = 'Fetch a single cluster type',
description='',
responses = {
200: OpenApiResponse(description='', response=ClusterTypeViewSerializer),
403: OpenApiResponse(description='User is missing view permissions'),
}
),
update = extend_schema(exclude = True),
partial_update = extend_schema(
summary = 'Update a cluster type',
description = '',
responses = {
200: OpenApiResponse(description='', response=ClusterTypeViewSerializer),
403: OpenApiResponse(description='User is missing change permissions'),
}
),
)
class ViewSet( ModelViewSet ):
filterset_fields = [
'organization',
'is_global',
]
search_fields = [
'name',
]
model = ClusterType
documentation: str = 'https://nofusscomputing.com/docs/not_model_docs'
view_description = 'Physical Devices'
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']

10
app/settings/viewsets/index.py
View File

@ -60,6 +60,15 @@ class Index(CommonViewSet):
"model": "software_category"
}
]
},
{
"name": "ITIM",
"links": [
{
"name": "Cluster Type",
"model": "cluster_type"
},
]
}
]
@ -72,6 +81,7 @@ class Index(CommonViewSet):
return Response(
{
"cluster_type": reverse('API:_api_v2_cluster_type-list', request=request),
"device_model": reverse('API:_api_v2_device_model-list', request=request),
"device_type": reverse('API:_api_v2_device_type-list', request=request),
"external_link": reverse('API:_api_v2_external_link-list', request=request),