docs(development): add device model to api docs

!27
This commit is contained in:
2024-06-16 05:00:45 +09:30
parent 320d3f1a13
commit f861295b1c
9 changed files with 56 additions and 4 deletions

View File

@ -8,7 +8,6 @@ about: https://gitlab.com/nofusscomputing/infrastructure/configuration-managemen
This section contains the application API documentation to assist in application development. The target audience is anyone whom would be developing the application.
- [Models](./models/index.md)
## Testing
- [Unit Testing](tests/index.md)
- [Unit Testing](./tests/index.md)

View File

@ -0,0 +1,11 @@
---
title: History Save
description: No Fuss Computings django ITSM device model
date: 2024-06-16
template: project.html
about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
---
::: app.core.mixin.history_save.SaveHistory
options:
inherited_members: true

View File

@ -0,0 +1,17 @@
---
title: django ITSM Models
description: No Fuss Computings django ITSM device model
date: 2024-06-16
template: project.html
about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
---
Models within the Django ITSM application:
- core
- [History Save](./core_history_save.md)
- itam
- [Device](./itam_device.md)

View File

@ -0,0 +1,11 @@
---
title: Device Model
description: No Fuss Computings django ITSM device model
date: 2024-06-16
template: project.html
about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
---
::: app.itam.models.device.Device
options:
inherited_members: true

View File

@ -18,6 +18,7 @@ naming of test classes is in `CamelCase` in format `<Model Name><what's being te
Test setup is written in a method called `setUpTestData` and is to contain the setup for all tests within the test class.
Example of a model history test class.
``` py
import pytest
@ -81,6 +82,7 @@ Items to test include, and are not limited to:
- saves history with parent pk and parent class
add to model class the following
``` py
@property