docs: Align price lists OpenAPI and architecture with API#6031
docs: Align price lists OpenAPI and architecture with API#6031bacciotti wants to merge 3 commits into
Conversation
- List: document filter/order_by bracket params, currency filter, 400s
- Add POST /price-lists/{uuid}/duplicate/ operation
- PriceListOut: assigned_cost_model_count, assigned_cost_models
- Architecture: Settings-style queries, duplicate action, response fields
Made-with: Cursor
There was a problem hiding this comment.
Code Review
This pull request updates the Price List API documentation and OpenAPI specification to include a new duplication endpoint and enhanced filtering and ordering capabilities. The response schema for price lists now includes cost model assignment details. Feedback was provided regarding a potential naming mismatch for the path parameter price_list_uuid compared to the backend's expected lookup field.
|
/retest |
|
🤖 CI Triager — Diagnosis Check: Red Hat Konflux / koku-ci / koku Changed files: Action: Add the Generated automatically. Review before applying. |
Summary
Aligns OpenAPI (
docs/specs/openapi.json) and architecture (docs/architecture/price-lists/api-and-lifecycle.md) with the current Price Lists API: Settings-stylefilter/order_by, strict list query validation,POST .../duplicate/, and inlineassigned_cost_models/assigned_cost_model_counton list/detail responses.Verification
python3 -m json.tool docs/specs/openapi.json— valid JSON.pipenv run tox -e py311 -- cost_models.test.test_price_list_view— OK (with Postgres onlocalhost:15432).Changes
GET /price-lists/name/uuid/enabled/orderingparams withPriceListQueryFilter+PriceListQueryOrderBy(deepObject),QueryOffset/QueryLimit; documented top-level param restriction; added 400 response.POST /price-lists/{price_list_uuid}/duplicate/(duplicatePriceList).PriceListOut:assigned_cost_model_count,assigned_cost_models(items →PriceListAffectedCostModel).@never_cacheon duplicate.Release notes