API redesign

[jon-nfc]

API has no real structure, redesign so that ui can be separated.

Details

Down the track the UI will be separated from the API. For this to occur, the API needs to be suitable.

Models

• defines layout
• Must define __str__ function that will be used by serializer as field display_name
• must define table_fields

Layout

Each model, not including tickets will be required to define its layout. this will be used by the UI to build the page layout for the model.

UI layout types are:

• Detail layout is a primary models page. This lay displays all information pertinent to the model. This is inclusive of child models and linked items.

• List layout is used as the landing page for models. it's a essentially a table view of all items the user has access to.

• Settings layout is for models that are considered settings for other models. i.e. category field.

• Ticket layout is for all models that have model ticket. this is regardless of the actual ticket type. The UI will distinguish between the different types.

Table Fields

Used to render the model in a table. All Models are required to specify this field.

Serializers

Serializes to be separated into three types:

• Base
• Model
• Display

Base Serializer

provides the basic details to show in place for a related model. To contains id, display_name and url.

Model Serializer

user for the creation and update of an item and contains ALL fields defined in display order, including any additional fields as specified within the View Serializer. these additional fields must be set as read_only=True

Display Serializer

Used to serializer to display the data. related fields are redefined to use their own base serializer.

defines parameter _urls: dict that always contains key _self which is the items detail view url.

Views

• Updates API meta with table fields and layout for list and detail views respectively.

Requirements

• normalised URLs
• follows nav structure

Links

• Blocks: chore: initial work centurion_erp_ui#1

• Related: API Browser #58

• Related: AWX Browser #59

• Related: Github API Browser #129

• Related: Gitlab API Browser #128

• Related: OSV API browser #130

• Related: PyPi API Browser #132

• Related UI Migration #307

• Related: Team Users API Endpoint requires refactoring #351

Tasks

• UI Proof of concept #319

• chore: initial work centurion_erp_ui#1

• Depreciate ALL API v1 endpoints

• plan redesign

• Work created from feat(core): ticket model #252

  • unit test /api/core/tickets

  • unit test /api/core/tickets/*/comments

  • unit test /api/core/tickets/*/comments/*

  • ensure only import user can set the following ticket fields

    Requirements

    • any date field
    • external_system
    • external_ref
    • Any user field

Potential new issues

• Separate UI code from API