docs: Align price lists OpenAPI and architecture with API#6031
Open
docs: Align price lists OpenAPI and architecture with API#6031
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
github-actions
Bot
added
the
smokes-required
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
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.
bacciotti
added
ok-to-skip-smokes
Contributor
Author
|
/retest |
myersCody
approved these changes
May 1, 2026
github-actions
Bot
added
smokes-required
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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