Skip to content

Update predefined item model to include the ids of all groups in which the current item is included #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update predefined item model to include the ids of all groups in which the current item is included #25

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93f4f8c
Update predefined item model to include the ids of all groups in whic…
SajedHassan Aug 4, 2022
2648642
Update predefined items and group | [Product page] CRM-19576
SajedHassan Aug 12, 2022
9a24563
Update products API with the new performance improvements and seriali…
SajedHassan Nov 8, 2022
b180cc2
Serialize products collection from index endpoints directly into the …
SajedHassan Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
206 changes: 192 additions & 14 deletions swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1755,7 +1755,17 @@ paths:
description:
tags:
- Predefined Items
parameters: []
parameters:
- $ref: '#/components/parameters/query_predefined_items_search'
- $ref: '#/components/parameters/query_date_filter'
- $ref: '#/components/parameters/query_since'
- $ref: '#/components/parameters/query_until'
- $ref: '#/components/parameters/query_modified_since'
- $ref: '#/components/parameters/query_unmodified_since'
- $ref: '#/components/parameters/query_sort_by'
- $ref: '#/components/parameters/query_order'
- $ref: '#/components/parameters/query_page'
- $ref: '#/components/parameters/query_per_page'
responses:
200:
description: OK
Expand All @@ -1774,9 +1784,7 @@ paths:
predefined_items:
type: array
items:
properties:
predefined_item:
$ref: '#/components/schemas/Predefined_item'
$ref: '#/components/schemas/Predefined_item'
400:
$ref: '#/components/responses/400'
401:
Expand Down Expand Up @@ -1848,6 +1856,55 @@ paths:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
/predefined_items/with_groups:
get:
summary: Get the list of predefined groups and items (for the logged API user's account)
description: ''
tags:
- Predefined Items
parameters:
- $ref: '#/components/parameters/query_predefined_item_groups_include_items'
- $ref: '#/components/parameters/query_predefined_items_search'
- $ref: '#/components/parameters/query_date_filter'
- $ref: '#/components/parameters/query_since'
- $ref: '#/components/parameters/query_until'
- $ref: '#/components/parameters/query_modified_since'
- $ref: '#/components/parameters/query_unmodified_since'
- $ref: '#/components/parameters/query_sort_by'
- $ref: '#/components/parameters/query_order'
- $ref: '#/components/parameters/query_page'
- $ref: '#/components/parameters/query_per_page'
responses:
200:
description: OK
content:
application/json:
schema:
properties:
status:
$ref: '#/components/schemas/Success/properties/status'
message:
$ref: '#/components/schemas/Success/properties/message'
timestamp:
$ref: '#/components/schemas/Success/properties/timestamp'
data:
properties:
predefined_items_with_groups:
type: array
items:
$ref: '#/components/schemas/Predefined_item_group'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
403:
$ref: '#/components/responses/403'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
/predefined_items/{predefined_item_id}:
get:
summary: Get a specific predefined item
Expand Down Expand Up @@ -1931,8 +1988,8 @@ paths:
$ref: '#/components/schemas/Success/properties/timestamp'
data:
properties:
predefined_action:
$ref: '#/components/schemas/Predefined_action'
predefined_item:
$ref: '#/components/schemas/Predefined_item'
400:
$ref: '#/components/responses/400'
401:
Expand Down Expand Up @@ -1970,10 +2027,21 @@ paths:
/predefined_item_groups:
get:
summary: Get the list of predefined item groups (for the logged API user's account)
description:
description: ''
tags:
- Predefined Item Groups
parameters: []
parameters:
- $ref: '#/components/parameters/query_predefined_item_groups_include_items'
- $ref: '#/components/parameters/query_predefined_items_search'
- $ref: '#/components/parameters/query_date_filter'
- $ref: '#/components/parameters/query_since'
- $ref: '#/components/parameters/query_until'
- $ref: '#/components/parameters/query_modified_since'
- $ref: '#/components/parameters/query_unmodified_since'
- $ref: '#/components/parameters/query_sort_by'
- $ref: '#/components/parameters/query_order'
- $ref: '#/components/parameters/query_page'
- $ref: '#/components/parameters/query_per_page'
responses:
200:
description: OK
Expand All @@ -1992,9 +2060,7 @@ paths:
predefined_item_groups:
type: array
items:
properties:
predefined_item_group:
$ref: '#/components/schemas/Predefined_item_group'
$ref: '#/components/schemas/Predefined_item_group'
400:
$ref: '#/components/responses/400'
401:
Expand All @@ -2009,7 +2075,7 @@ paths:
$ref: '#/components/responses/500'
post:
summary: Create a new predefined item group
description:
description: ''
tags:
- Predefined Item Groups
parameters: []
Expand All @@ -2023,9 +2089,23 @@ paths:
type: string
description: Name of the predefined item group
example: Electronics
description:
type: string
description: Description of the predefined item group
example: Electronics devices
items_ids:
type: array
description: List of IDs of the predefined/deal items in the predefined item group
items:
type: string
format: bson-id
example:
- 5c79510e9007ba3f7519e819
- 5c9a53349007ba58f13c8118
deal_items:
type: array
description: List of IDs of the predefined/deal items in the predefined item group
deprecated: true
items:
type: string
format: bson-id
Expand All @@ -2047,7 +2127,7 @@ paths:
$ref: '#/components/schemas/Success/properties/timestamp'
data:
properties:
predefined_item:
predefined_item_group:
$ref: '#/components/schemas/Predefined_item_group'
400:
$ref: '#/components/responses/400'
Expand Down Expand Up @@ -2098,6 +2178,53 @@ paths:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
put:
summary: Update a specific predefined item group
description:
Copy link
Member

@vladimir-konnov vladimir-konnov Nov 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SajedHassan should it be description: ''?

tags:
- Predefined Item Groups
parameters:
- $ref: '#/components/parameters/path_predefined_item_group_id'
requestBody:
required: true
content:
application/json:
schema:
properties:
name:
type: string
description: Name of the predefined item
example: Solar panels
description:
type: string
description: Description text of the predefined item
example: Photovoltaic solar panels (2019 model)
items_ids:
type: array
description: List of IDs of the predefined/deal items in the predefined item group
items:
type: string
format: bson-id
example:
- 5c79510e9007ba3f7519e819
- 5c9a53349007ba58f13c8118
responses:
200:
description: OK
content:
application/json:
schema:
properties:
status:
$ref: '#/components/schemas/Success/properties/status'
message:
$ref: '#/components/schemas/Success/properties/message'
timestamp:
$ref: '#/components/schemas/Success/properties/timestamp'
data:
properties:
predefined_item_group:
$ref: '#/components/schemas/Predefined_item_group'
delete:
summary: Delete a specific predefined item group
description:
Expand Down Expand Up @@ -9641,6 +9768,10 @@ components:
type: string
description: Description text of the predefined item
example: Photovoltaic solar panels (2019 model)
type:
type: string
description: Type of the entry (item ot subitem)
example: item
cost:
type: number
format: float
Expand All @@ -9654,13 +9785,15 @@ components:
position:
type: integer
format: int32
deprecated: true
description: Position of the predefined item in the items list
readOnly: true
example: 1
item_group_id:
type: string
format: bson-id
description: ID of the predefined item group (or empty if the item is not in a group)
deprecated: true
description: ID of the first predefined item group in which the current item is included (or empty if the item is not in a group)
readOnly: true
example: 5c9a53599007ba58f13c8119
Deal_item:
Expand Down Expand Up @@ -9751,21 +9884,50 @@ components:
type: string
description: Name of the predefined item group
example: Electronics
description:
type: string
description: Description text of the deal item
example: Photovoltaic solar panels (2019 model)
type:
type: string
description: Type of the entry
example: group
position:
type: integer
format: int32
deprecated: true
description: Position of the group in the list of predefined item groups
readOnly: true
example: 1
count:
type: integer
format: int32
deprecated: true
description: Number of predefined items in the predefined item group
readOnly: true
example: 2
subcount:
type: integer
format: int32
description: Number of predefined items in the predefined item group
readOnly: true
example: 2
cost:
type: number
format: float
readOnly: true
description: Cost of the predefined item
example: 95.00
price:
type: number
format: float
readOnly: true
description: Price of the predefined item
example: 149.99
item_ids:
type: array
description: List of IDs of the predefined/deal items in the predefined item group
deprecated: true
readOnly: true
items:
type: string
Expand Down Expand Up @@ -10784,6 +10946,22 @@ components:
schema:
type: string
example: Jack Aranda
query_predefined_items_search:
name: search
in: query
required: false
description: Search by name
schema:
type: string
example: Partner
query_predefined_item_groups_include_items:
name: include_items
in: query
required: false
description: Determine whether to include the group items in the response or not
schema:
type: boolean
example: false
query_contacts_owner_id:
name: owner_id
in: query
Expand Down