greebo/svg-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(backend): harden pricing mutation contract and sync backend docs

Browse Source 
- add typed response schemas for pricing write endpoints
- add stale draft version guard for pricing mutations
- unify pricing API contract around expected_scheme_version_id
- update API route map
- add smoke regression checklist for backend routes and artifact flows
This commit is contained in:
greebo
2026-03-19 19:11:33 +03:00
parent c7c9184a71
commit fbeac890be
5 changed files with 197 additions and 215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

225
backend/app/api/routes/pricing.py
View File

@@ -15,32 +15,35 @@ from app.repositories.pricing import (
update_pricing_category,
)
from app.repositories.scheme_version_pricing import replace_scheme_version_pricing_snapshot
from app.repositories.schemes import get_scheme_record_by_scheme_id
from app.schemas.pricing import (
DeleteResponse,
PriceRuleCreateRequest,
PriceRuleCreateResponse,
PriceRuleItem,
PriceRuleUpdateRequest,
PriceRuleUpdateResponse,
PricingBundleResponse,
PricingCategoryCreateRequest,
PricingCategoryCreateResponse,
PricingCategoryItem,
PricingCategoryUpdateRequest,
PricingCategoryUpdateResponse,
)
from app.security.auth import require_api_key
from app.services.draft_guard import get_current_draft_context
from app.services.draft_guard import validate_expected_draft_version_if_provided
router = APIRouter()
async def _refresh_current_draft_snapshot_if_possible(
*,
scheme_id: str,
expected_scheme_version_id: str | None = None,
) -> dict | None:
scheme, version = await get_current_draft_context(
async def _refresh_current_draft_snapshot_if_possible(scheme_id: str) -> dict | None:
context = await validate_expected_draft_version_if_provided(
scheme_id=scheme_id,
expected_scheme_version_id=expected_scheme_version_id,
expected_scheme_version_id=None,
)
if context is None:
return None
scheme, version = context
return await replace_scheme_version_pricing_snapshot(
scheme_id=scheme.scheme_id,
scheme_version_id=version.scheme_version_id,
@@ -79,51 +82,48 @@ async def get_pricing_bundle(scheme_id: str, role: str = Depends(require_api_key
)
@router.post(f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/categories")
@router.post(
f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/categories",
response_model=PricingCategoryCreateResponse,
)
async def create_pricing_category_endpoint(
scheme_id: str,
payload: PricingCategoryCreateRequest,
expected_scheme_version_id: str | None = Query(default=None),
role: str = Depends(require_api_key),
):
scheme, version = await get_current_draft_context(
await validate_expected_draft_version_if_provided(
scheme_id=scheme_id,
expected_scheme_version_id=expected_scheme_version_id,
)
pricing_category_id = await create_pricing_category(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
name=payload.name,
code=payload.code,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(
scheme_id=scheme.scheme_id,
expected_scheme_version_id=version.scheme_version_id,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(scheme_id)
await create_audit_event(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
event_type="pricing.category.created",
object_type="pricing_category",
object_ref=pricing_category_id,
details={
"name": payload.name,
"code": payload.code,
"scheme_version_id": version.scheme_version_id,
"snapshot": snapshot,
},
details={"name": payload.name, "code": payload.code, "snapshot": snapshot},
)
return {
"pricing_category_id": pricing_category_id,
"scheme_id": scheme.scheme_id,
"scheme_version_id": version.scheme_version_id,
"name": payload.name,
"code": payload.code,
}
return PricingCategoryCreateResponse(
pricing_category_id=pricing_category_id,
scheme_id=scheme_id,
name=payload.name,
code=payload.code,
)
@router.put(f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/categories/{{pricing_category_id}}")
@router.put(
f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/categories/{{pricing_category_id}}",
response_model=PricingCategoryUpdateResponse,
)
async def update_pricing_category_endpoint(
scheme_id: str,
pricing_category_id: str,
@@ -131,91 +131,81 @@ async def update_pricing_category_endpoint(
expected_scheme_version_id: str | None = Query(default=None),
role: str = Depends(require_api_key),
):
scheme, version = await get_current_draft_context(
await validate_expected_draft_version_if_provided(
scheme_id=scheme_id,
expected_scheme_version_id=expected_scheme_version_id,
)
row = await update_pricing_category(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
pricing_category_id=pricing_category_id,
name=payload.name,
code=payload.code,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(
scheme_id=scheme.scheme_id,
expected_scheme_version_id=version.scheme_version_id,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(scheme_id)
await create_audit_event(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
event_type="pricing.category.updated",
object_type="pricing_category",
object_ref=pricing_category_id,
details={
"name": payload.name,
"code": payload.code,
"scheme_version_id": version.scheme_version_id,
"snapshot": snapshot,
},
details={"name": payload.name, "code": payload.code, "snapshot": snapshot},
)
return {
"pricing_category_id": row.pricing_category_id,
"scheme_id": row.scheme_id,
"scheme_version_id": version.scheme_version_id,
"name": row.name,
"code": row.code,
}
return PricingCategoryUpdateResponse(
pricing_category_id=row.pricing_category_id,
scheme_id=row.scheme_id,
name=row.name,
code=row.code,
)
@router.delete(f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/categories/{{pricing_category_id}}")
@router.delete(
f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/categories/{{pricing_category_id}}",
response_model=DeleteResponse,
)
async def delete_pricing_category_endpoint(
scheme_id: str,
pricing_category_id: str,
expected_scheme_version_id: str | None = Query(default=None),
role: str = Depends(require_api_key),
):
scheme, version = await get_current_draft_context(
await validate_expected_draft_version_if_provided(
scheme_id=scheme_id,
expected_scheme_version_id=expected_scheme_version_id,
)
await delete_pricing_category(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
pricing_category_id=pricing_category_id,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(
scheme_id=scheme.scheme_id,
expected_scheme_version_id=version.scheme_version_id,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(scheme_id)
await create_audit_event(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
event_type="pricing.category.deleted",
object_type="pricing_category",
object_ref=pricing_category_id,
details={
"scheme_version_id": version.scheme_version_id,
"snapshot": snapshot,
},
details={"snapshot": snapshot},
)
return {
"deleted": True,
"pricing_category_id": pricing_category_id,
"scheme_version_id": version.scheme_version_id,
}
return DeleteResponse(
deleted=True,
pricing_category_id=pricing_category_id,
)
@router.post(f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/rules")
@router.post(
f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/rules",
response_model=PriceRuleCreateResponse,
)
async def create_price_rule_endpoint(
scheme_id: str,
payload: PriceRuleCreateRequest,
expected_scheme_version_id: str | None = Query(default=None),
role: str = Depends(require_api_key),
):
scheme, version = await get_current_draft_context(
await validate_expected_draft_version_if_provided(
scheme_id=scheme_id,
expected_scheme_version_id=expected_scheme_version_id,
)
@@ -229,20 +219,17 @@ async def create_price_rule_endpoint(
)
price_rule_id = await create_price_rule(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
pricing_category_id=payload.pricing_category_id,
target_type=payload.target_type,
target_ref=payload.target_ref,
amount=amount,
currency=payload.currency,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(
scheme_id=scheme.scheme_id,
expected_scheme_version_id=version.scheme_version_id,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(scheme_id)
await create_audit_event(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
event_type="pricing.rule.created",
object_type="price_rule",
object_ref=price_rule_id,
@@ -252,24 +239,25 @@ async def create_price_rule_endpoint(
"target_ref": payload.target_ref,
"amount": payload.amount,
"currency": payload.currency,
"scheme_version_id": version.scheme_version_id,
"snapshot": snapshot,
},
)
return {
"price_rule_id": price_rule_id,
"scheme_id": scheme.scheme_id,
"scheme_version_id": version.scheme_version_id,
"pricing_category_id": payload.pricing_category_id,
"target_type": payload.target_type,
"target_ref": payload.target_ref,
"amount": payload.amount,
"currency": payload.currency,
}
return PriceRuleCreateResponse(
price_rule_id=price_rule_id,
scheme_id=scheme_id,
pricing_category_id=payload.pricing_category_id,
target_type=payload.target_type,
target_ref=payload.target_ref,
amount=payload.amount,
currency=payload.currency,
)
@router.put(f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/rules/{{price_rule_id}}")
@router.put(
f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/rules/{{price_rule_id}}",
response_model=PriceRuleUpdateResponse,
)
async def update_price_rule_endpoint(
scheme_id: str,
price_rule_id: str,
@@ -277,7 +265,7 @@ async def update_price_rule_endpoint(
expected_scheme_version_id: str | None = Query(default=None),
role: str = Depends(require_api_key),
):
scheme, version = await get_current_draft_context(
await validate_expected_draft_version_if_provided(
scheme_id=scheme_id,
expected_scheme_version_id=expected_scheme_version_id,
)
@@ -291,7 +279,7 @@ async def update_price_rule_endpoint(
)
row = await update_price_rule(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
price_rule_id=price_rule_id,
pricing_category_id=payload.pricing_category_id,
target_type=payload.target_type,
@@ -299,13 +287,10 @@ async def update_price_rule_endpoint(
amount=amount,
currency=payload.currency,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(
scheme_id=scheme.scheme_id,
expected_scheme_version_id=version.scheme_version_id,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(scheme_id)
await create_audit_event(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
event_type="pricing.rule.updated",
object_type="price_rule",
object_ref=price_rule_id,
@@ -315,57 +300,51 @@ async def update_price_rule_endpoint(
"target_ref": payload.target_ref,
"amount": payload.amount,
"currency": payload.currency,
"scheme_version_id": version.scheme_version_id,
"snapshot": snapshot,
},
)
return {
"price_rule_id": row.price_rule_id,
"scheme_id": row.scheme_id,
"scheme_version_id": version.scheme_version_id,
"pricing_category_id": row.pricing_category_id,
"target_type": row.target_type,
"target_ref": row.target_ref,
"amount": str(row.amount),
"currency": row.currency,
}
return PriceRuleUpdateResponse(
price_rule_id=row.price_rule_id,
scheme_id=row.scheme_id,
pricing_category_id=row.pricing_category_id,
target_type=row.target_type,
target_ref=row.target_ref,
amount=str(row.amount),
currency=row.currency,
)
@router.delete(f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/rules/{{price_rule_id}}")
@router.delete(
f"{settings.api_v1_prefix}/schemes/{{scheme_id}}/pricing/rules/{{price_rule_id}}",
response_model=DeleteResponse,
)
async def delete_price_rule_endpoint(
scheme_id: str,
price_rule_id: str,
expected_scheme_version_id: str | None = Query(default=None),
role: str = Depends(require_api_key),
):
scheme, version = await get_current_draft_context(
await validate_expected_draft_version_if_provided(
scheme_id=scheme_id,
expected_scheme_version_id=expected_scheme_version_id,
)
await delete_price_rule(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
price_rule_id=price_rule_id,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(
scheme_id=scheme.scheme_id,
expected_scheme_version_id=version.scheme_version_id,
)
snapshot = await _refresh_current_draft_snapshot_if_possible(scheme_id)
await create_audit_event(
scheme_id=scheme.scheme_id,
scheme_id=scheme_id,
event_type="pricing.rule.deleted",
object_type="price_rule",
object_ref=price_rule_id,
details={
"scheme_version_id": version.scheme_version_id,
"snapshot": snapshot,
},
details={"snapshot": snapshot},
)
return {
"deleted": True,
"price_rule_id": price_rule_id,
"scheme_version_id": version.scheme_version_id,
}
return DeleteResponse(
deleted=True,
price_rule_id=price_rule_id,
)