Planning Document: version 1.4

[jon-nfc]

Version 1.3 intent is the full redesign of the API in preperation for moving the UI to use the react freamwork.

Details

basic restructure of files will be as follows:

• Serializers will now go in each modules directory under path serializers/

• ViewSet to be used and will be placed in each module directory under path viewsets/

• unit tests to only cover non-functional tests

• test that check/confirm functionality are to be setup as functional tests

---

API v2 Endpoint Creation MR Checklist

- [ ] :new: Serializer Created _ path: `<module name>/serializers`_

    - [ ] :heavy_check_mark:  Validations from form included in serializer
    - [ ] :heavy_check_mark:  Validations from view included in serializer
    - [ ] :heavy_check_mark: All related fields using its base serializer

    - [ ] :ballot_box_with_check: Related Serializers that Don't exist are created

- [ ] :new: ViewSet Created _ path: `<module name>/viewsets`_

    - [ ] :heavy_check_mark: ViewSet added to `api/urls.py`
    - [ ] :heavy_check_mark: ViewSet added to Module `viewsets/index.py`

- :test_tube: Tests

    - [ ] :test_tube: ViewSet Permission tests _`test_<model name>_permission_viewset.py`_

    - [ ] :test_tube: API Fields rendering tests _`test_<model name>_api_v2.py`_

    - [ ] :test_tube: Serializer validation tests - _`test_<model name>_serializer.py`_

        _each validation conducted is checked to ensure it works_

---

Links

• Blocks: feat: version 1.4 #344

• Related: Remove depreciated API path #343

• Related: Planning Document: version 2.0.0 #349

• Related: chore: initial work centurion_erp_ui#1

Requirements for Milestone

The following items must be met for this release to occur.

• Unit Testing #15

• API redesign #248

• new Serializer base class

  • unit tests for serializer base class

• new viewset base class

  • unit tests for new viewset class

• ALL current v1 API paths to be marked depreciated at the class level

  from drf_spectacular.utils import extend_schema
  
  @extend_schema(deprecated=True)
  class DeviceViewSet(OrganizationMixin, viewsets.ModelViewSet):

• Restructure views unit tests so they run against the UI

• 🧪 Ensure that models have Meta.verbose_name

  • used by api to get view name

• 🧪 Ensure that models have Meta.verbose_name_plural

  • used by api to get view name

• 🧪 Ensure that models have Meta.ordering

  • ensures that the results are always returned in the same order

• [ ] 🧪 Ensure that models property documentation: str = <docs url> this isn't going to be inforced as it's also possible to specify as part of the viewset.

• Model fields that are blank = False dont have a default value set

  • write unit test to ensure that if blank = False that no default is set

• 🧪 Write tests to ensure model fields has help_text

• 🧪 Write tests to ensure model fields has verbose_name

• 🧪 Serializer validation checks, Organization

• 🧪 Serializer validation checks, Team

• 🧪 Serializer validation checks, TeamUser

• Add Device Operating System Endpoint #362

• Update docker to use nginX web server #363

  • [] update docker to use gunicorn Update docker to use nginX web server #363

  • [ ] Update Django to be on a websocket Update docker to use nginX web server #363

• fix drf spectacular warnings #361

• API v2 Endpoints for tickets ALL Types

• API v2 Unit Tests for external links

• Add Missing Related tickets Unit Tests #367 unknown which tests are missing, has serializer, viewset and api fields

• Finish core Unit tests and features #368

• 🧪 Test to ensure ViewSet is using the correct serializer

• 🧪 Test to ensure inventory upload works

• 🧪 Test slash commands #376

• 🧪 Test to ensure that when ticket assigned a user/team the ticket status changes to "assigned"

• 🧪 fix skipped ticket tests

• Device Software Endpoint incorrectly functioning #386

• Prevent any Exception from having the server return HTTP/500 #387

• As part of the metadata page provide the urls for the relationship fields #388

• Add to milestone tab the fetching of related tickets

Milestone Non-Critical Tasks

The tasks within this section are not crucial to the release of this milestone. As such they mey be moved to the next milestone.

• [Tests] Audit History Entry tests #46

• [test] write permissions tests for notes #49

• UI Migration #307

• Posting to API with incorrect status #316

• API fields for devices #317 possibly complete in API v2

• Editing a ticket tasks comment returns error #323

• Ability to remove ticket linked items #324

• Tickets can be linked to themselves #326

• Update model documentation for UI fields #347

• Audit history and notes test for core module

  history and notes missing api v2 tests

• Refactor ALL models to have a get_url function #366