The equipment plugin is now the machines plugin, ending the UI-vs-code vocabulary split while the contract is pre-1.0 and nothing external depends on the old names. - plugins/equipment -> plugins/machines: manifest, class, /api/machines, machines.* permissions, registry key (with an auto-migrating load shim for existing installs). - Tables: equipment -> machines (equipmentid -> machineid) and equipmenttypes -> machinetypes, renamed in the plugin's own migration chain (machines0002rename), idempotent for both upgrading and fresh installs. - The legacy core machinetypes lookup actually types the vendor MODELS catalog, so it is renamed losslessly to modeltypes (models.modeltypeid, /api/modeltypes, Model Types settings page) rather than collapsed, freeing the machinetypes name. Core migration 7d17_machines_rename also flips data in place: assettypes row equipment -> machine, auditlog entitytype, identifier_/search_ settings keys, permission rows, and renames alembic_version_equipment. - Frontend: machinesApi/modeltypesApi, item.machine response shape, assettype value compares 'equipment' -> 'machine' (map, search, custom fields, relationships), routes machines.js with plugin gating retagged, /print/machine-badge, Machine Types (subtypes) and Model Types (catalog) settings pages, machines-by-type report id. - Docs swept; ADRs left as history per the authoring rule. Upgrade: flask db upgrade then flask plugin upgrade-all. Verified: dev DB flipped live (262 machines, 35 modeltypes, 95 models retyped, zero equipment tables remain); fresh scratch-MySQL install produces the new names; 341 tests green; naming/style green; frontend builds; live E2E on machines list/detail, PC relationships, map, reports, and both settings pages. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
157 lines
4.4 KiB
Python
157 lines
4.4 KiB
Python
"""Models (vendor model catalog) API endpoints - Full CRUD."""
|
|
|
|
from flask import Blueprint, request
|
|
from flask_jwt_extended import jwt_required
|
|
|
|
from shopdb.extensions import db
|
|
from shopdb.core.models import Model
|
|
from shopdb.utils.responses import (
|
|
success_response,
|
|
error_response,
|
|
paginated_response,
|
|
ErrorCodes
|
|
)
|
|
from shopdb.utils.pagination import get_pagination_params, paginate_query
|
|
|
|
from shopdb.utils.authz import require_permission, require_role
|
|
|
|
models_bp = Blueprint('models', __name__)
|
|
|
|
|
|
@models_bp.route('', methods=['GET'])
|
|
@jwt_required(optional=True)
|
|
def list_models():
|
|
"""List all vendor catalog models."""
|
|
page, per_page = get_pagination_params(request)
|
|
|
|
query = Model.query
|
|
|
|
if request.args.get('active', 'true').lower() != 'false':
|
|
query = query.filter(Model.isactive == True)
|
|
|
|
if vendor_id := request.args.get('vendor', type=int):
|
|
query = query.filter(Model.vendorid == vendor_id)
|
|
|
|
if modeltype_id := request.args.get('modeltype', type=int):
|
|
query = query.filter(Model.modeltypeid == modeltype_id)
|
|
|
|
if search := request.args.get('search'):
|
|
query = query.filter(Model.modelnumber.ilike(f'%{search}%'))
|
|
|
|
query = query.order_by(Model.modelnumber)
|
|
|
|
items, total = paginate_query(query, page, per_page)
|
|
|
|
data = []
|
|
for m in items:
|
|
d = m.to_dict()
|
|
d['vendor'] = m.vendor.vendor if m.vendor else None
|
|
d['modeltype'] = m.modeltype.modeltype if m.modeltype else None
|
|
data.append(d)
|
|
|
|
return paginated_response(data, page, per_page, total)
|
|
|
|
|
|
@models_bp.route('/<int:model_id>', methods=['GET'])
|
|
@jwt_required(optional=True)
|
|
def get_model(model_id: int):
|
|
"""Get a single model."""
|
|
m = db.session.get(Model, model_id)
|
|
|
|
if not m:
|
|
return error_response(
|
|
ErrorCodes.NOT_FOUND,
|
|
f'Model with ID {model_id} not found',
|
|
http_code=404
|
|
)
|
|
|
|
data = m.to_dict()
|
|
data['vendor'] = m.vendor.to_dict() if m.vendor else None
|
|
data['modeltype'] = m.modeltype.to_dict() if m.modeltype else None
|
|
|
|
return success_response(data)
|
|
|
|
|
|
@models_bp.route('', methods=['POST'])
|
|
@jwt_required()
|
|
@require_role('admin')
|
|
def create_model():
|
|
"""Create a new model."""
|
|
data = request.get_json()
|
|
|
|
if not data or not data.get('modelnumber'):
|
|
return error_response(ErrorCodes.VALIDATION_ERROR, 'modelnumber is required')
|
|
|
|
# Check duplicate
|
|
existing = Model.query.filter_by(
|
|
modelnumber=data['modelnumber'],
|
|
vendorid=data.get('vendorid')
|
|
).first()
|
|
if existing:
|
|
return error_response(
|
|
ErrorCodes.CONFLICT,
|
|
f"Model '{data['modelnumber']}' already exists for this vendor",
|
|
http_code=409
|
|
)
|
|
|
|
m = Model(
|
|
modelnumber=data['modelnumber'],
|
|
vendorid=data.get('vendorid'),
|
|
modeltypeid=data.get('modeltypeid'),
|
|
description=data.get('description'),
|
|
imageurl=data.get('imageurl'),
|
|
documentationurl=data.get('documentationurl'),
|
|
notes=data.get('notes')
|
|
)
|
|
|
|
db.session.add(m)
|
|
db.session.commit()
|
|
|
|
return success_response(m.to_dict(), message='Model created', http_code=201)
|
|
|
|
|
|
@models_bp.route('/<int:model_id>', methods=['PUT'])
|
|
@jwt_required()
|
|
@require_role('admin')
|
|
def update_model(model_id: int):
|
|
"""Update a model."""
|
|
m = db.session.get(Model, model_id)
|
|
|
|
if not m:
|
|
return error_response(
|
|
ErrorCodes.NOT_FOUND,
|
|
f'Model with ID {model_id} not found',
|
|
http_code=404
|
|
)
|
|
|
|
data = request.get_json()
|
|
if not data:
|
|
return error_response(ErrorCodes.VALIDATION_ERROR, 'No data provided')
|
|
|
|
for key in ['modelnumber', 'vendorid', 'modeltypeid', 'description', 'imageurl', 'documentationurl', 'notes', 'isactive']:
|
|
if key in data:
|
|
setattr(m, key, data[key])
|
|
|
|
db.session.commit()
|
|
return success_response(m.to_dict(), message='Model updated')
|
|
|
|
|
|
@models_bp.route('/<int:model_id>', methods=['DELETE'])
|
|
@jwt_required()
|
|
@require_role('admin')
|
|
def delete_model(model_id: int):
|
|
"""Delete (deactivate) a model."""
|
|
m = db.session.get(Model, model_id)
|
|
|
|
if not m:
|
|
return error_response(
|
|
ErrorCodes.NOT_FOUND,
|
|
f'Model with ID {model_id} not found',
|
|
http_code=404
|
|
)
|
|
|
|
m.isactive = False
|
|
db.session.commit()
|
|
|
|
return success_response(message='Model deleted')
|