Skip to content

Commit 5b0e1a3

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
TASK: Updating RAML types, Postman and OAS definition
1 parent cd07396 commit 5b0e1a3

17 files changed

+353
-47
lines changed

‎oas/api/openapi.yaml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76510,6 +76510,28 @@ components:
7651076510
value:
7651176511
type: "integer"
7651276512
format: "int64"
76513+
ProductSearchFacetResultStats:
76514+
allOf:
76515+
- $ref: '#/components/schemas/ProductSearchFacetResult'
76516+
- type: "object"
76517+
required:
76518+
- count
76519+
- max
76520+
- min
76521+
properties:
76522+
name:
76523+
type: "string"
76524+
min:
76525+
{}
76526+
max:
76527+
{}
76528+
mean:
76529+
{}
76530+
sum:
76531+
{}
76532+
count:
76533+
type: "integer"
76534+
format: "int64"
7651376535
ProductSearchFacetScopeEnum:
7651476536
type: "string"
7651576537
enum:
@@ -76520,6 +76542,31 @@ components:
7652076542
x-annotation-enumDescriptions:
7652176543
all: "Count all Products (or Product Variants) without considering the search query."
7652276544
query: "Only count the Products (or Product Variants) that match the search query."
76545+
ProductSearchFacetStatsExpression:
76546+
allOf:
76547+
- $ref: '#/components/schemas/ProductSearchFacetExpression'
76548+
- type: "object"
76549+
required:
76550+
- stats
76551+
properties:
76552+
stats:
76553+
$ref: '#/components/schemas/ProductSearchFacetStatsValue'
76554+
ProductSearchFacetStatsValue:
76555+
type: "object"
76556+
required:
76557+
- field
76558+
- name
76559+
properties:
76560+
name:
76561+
type: "string"
76562+
scope:
76563+
$ref: '#/components/schemas/ProductSearchFacetScopeEnum'
76564+
filter:
76565+
$ref: '#/components/schemas/SearchQuery'
76566+
field:
76567+
type: "string"
76568+
fieldType:
76569+
$ref: '#/components/schemas/SearchFieldType'
7652376570
AssignedProductReference:
7652476571
type: "object"
7652576572
required:

‎uml/api/ProductSearchFacetExpression.puml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ interface ProductSearchFacetDistinctExpression [[ProductSearchFacetDistinctExpre
2020
interface ProductSearchFacetRangesExpression [[ProductSearchFacetRangesExpression.svg]] extends ProductSearchFacetExpression {
2121
ranges: [[ProductSearchFacetRangesValue.svg ProductSearchFacetRangesValue]]
2222
}
23+
interface ProductSearchFacetStatsExpression [[ProductSearchFacetStatsExpression.svg]] extends ProductSearchFacetExpression {
24+
stats: [[ProductSearchFacetStatsValue.svg ProductSearchFacetStatsValue]]
25+
}
2326

2427
interface ProductSearchRequest [[ProductSearchRequest.svg]] {
2528
query: [[SearchQuery.svg SearchQuery]]

‎uml/api/ProductSearchFacetResult.puml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ interface ProductSearchFacetResultCount [[ProductSearchFacetResultCount.svg]] ex
2020
name: String
2121
value: Long
2222
}
23+
interface ProductSearchFacetResultStats [[ProductSearchFacetResultStats.svg]] extends ProductSearchFacetResult {
24+
name: String
25+
min: [[Object.svg Object]]
26+
max: [[Object.svg Object]]
27+
mean: [[Object.svg Object]]
28+
sum: [[Object.svg Object]]
29+
count: Long
30+
}
2331

2432
interface ProductPagedSearchResponse [[ProductPagedSearchResponse.svg]] {
2533
total: Long

‎uml/api/ProductSearchFacetResultStats.puml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
@startuml
2+
3+
hide empty fields
4+
hide empty methods
5+
legend
6+
|= |= line |
7+
|<back:black> </back>| inheritance |
8+
|<back:green> </back>| property reference |
9+
|<back:blue> </back>| discriminated class |
10+
endlegend
11+
interface ProductSearchFacetResultStats [[ProductSearchFacetResultStats.svg]] extends ProductSearchFacetResult {
12+
name: String
13+
min: [[Object.svg Object]]
14+
max: [[Object.svg Object]]
15+
mean: [[Object.svg Object]]
16+
sum: [[Object.svg Object]]
17+
count: Long
18+
}
19+
interface ProductSearchFacetResult [[ProductSearchFacetResult.svg]] {
20+
name: String
21+
}
22+
23+
24+
25+
26+
27+
@enduml

‎uml/api/ProductSearchFacetScopeEnum.puml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,15 @@ interface ProductSearchFacetRangesValue [[ProductSearchFacetRangesValue.svg]] {
3434
language: String
3535
fieldType: [[SearchFieldType.svg SearchFieldType]]
3636
}
37+
interface ProductSearchFacetStatsValue [[ProductSearchFacetStatsValue.svg]] {
38+
name: String
39+
scope: [[ProductSearchFacetScopeEnum.svg ProductSearchFacetScopeEnum]]
40+
filter: [[SearchQuery.svg SearchQuery]]
41+
field: String
42+
fieldType: [[SearchFieldType.svg SearchFieldType]]
43+
}
3744
ProductSearchFacetScopeEnum --> ProductSearchFacetCountValue #green;text:green : "scope"
3845
ProductSearchFacetScopeEnum --> ProductSearchFacetDistinctValue #green;text:green : "scope"
3946
ProductSearchFacetScopeEnum --> ProductSearchFacetRangesValue #green;text:green : "scope"
47+
ProductSearchFacetScopeEnum --> ProductSearchFacetStatsValue #green;text:green : "scope"
4048
@enduml

‎uml/api/ProductSearchFacetStatsExpression.puml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
@startuml
2+
3+
hide empty fields
4+
hide empty methods
5+
legend
6+
|= |= line |
7+
|<back:black> </back>| inheritance |
8+
|<back:green> </back>| property reference |
9+
|<back:blue> </back>| discriminated class |
10+
endlegend
11+
interface ProductSearchFacetStatsExpression [[ProductSearchFacetStatsExpression.svg]] extends ProductSearchFacetExpression {
12+
stats: [[ProductSearchFacetStatsValue.svg ProductSearchFacetStatsValue]]
13+
}
14+
interface ProductSearchFacetExpression [[ProductSearchFacetExpression.svg]] {
15+
}
16+
17+
18+
19+
20+
21+
@enduml

‎uml/api/ProductSearchFacetStatsValue.puml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
@startuml
2+
3+
hide empty fields
4+
hide empty methods
5+
legend
6+
|= |= line |
7+
|<back:black> </back>| inheritance |
8+
|<back:green> </back>| property reference |
9+
|<back:blue> </back>| discriminated class |
10+
endlegend
11+
interface ProductSearchFacetStatsValue [[ProductSearchFacetStatsValue.svg]] {
12+
name: String
13+
scope: [[ProductSearchFacetScopeEnum.svg ProductSearchFacetScopeEnum]]
14+
filter: [[SearchQuery.svg SearchQuery]]
15+
field: String
16+
fieldType: [[SearchFieldType.svg SearchFieldType]]
17+
}
18+
19+
20+
21+
interface ProductSearchFacetStatsExpression [[ProductSearchFacetStatsExpression.svg]] {
22+
stats: [[ProductSearchFacetStatsValue.svg ProductSearchFacetStatsValue]]
23+
}
24+
25+
ProductSearchFacetStatsValue --> ProductSearchFacetStatsExpression #green;text:green : "stats"
26+
@enduml

‎uml/api/SearchFieldType.puml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@ interface ProductSearchFacetRangesValue [[ProductSearchFacetRangesValue.svg]] {
4848
language: String
4949
fieldType: [[SearchFieldType.svg SearchFieldType]]
5050
}
51+
interface ProductSearchFacetStatsValue [[ProductSearchFacetStatsValue.svg]] {
52+
name: String
53+
scope: [[ProductSearchFacetScopeEnum.svg ProductSearchFacetScopeEnum]]
54+
filter: [[SearchQuery.svg SearchQuery]]
55+
field: String
56+
fieldType: [[SearchFieldType.svg SearchFieldType]]
57+
}
5158
interface SearchSorting [[SearchSorting.svg]] {
5259
field: String
5360
language: String
@@ -58,5 +65,6 @@ interface SearchSorting [[SearchSorting.svg]] {
5865
}
5966
SearchFieldType --> ProductSearchFacetDistinctValue #green;text:green : "fieldType"
6067
SearchFieldType --> ProductSearchFacetRangesValue #green;text:green : "fieldType"
68+
SearchFieldType --> ProductSearchFacetStatsValue #green;text:green : "fieldType"
6169
SearchFieldType --> SearchSorting #green;text:green : "fieldType"
6270
@enduml

‎uml/api/SearchQuery.puml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,13 @@ interface ProductSearchFacetRangesValue [[ProductSearchFacetRangesValue.svg]] {
121121
language: String
122122
fieldType: [[SearchFieldType.svg SearchFieldType]]
123123
}
124+
interface ProductSearchFacetStatsValue [[ProductSearchFacetStatsValue.svg]] {
125+
name: String
126+
scope: [[ProductSearchFacetScopeEnum.svg ProductSearchFacetScopeEnum]]
127+
filter: [[SearchQuery.svg SearchQuery]]
128+
field: String
129+
fieldType: [[SearchFieldType.svg SearchFieldType]]
130+
}
124131
interface SearchSorting [[SearchSorting.svg]] {
125132
field: String
126133
language: String
@@ -143,5 +150,6 @@ SearchQuery --> ProductSearchRequest #green;text:green : "postFilter"
143150
SearchQuery --> ProductSearchFacetCountValue #green;text:green : "filter"
144151
SearchQuery --> ProductSearchFacetDistinctValue #green;text:green : "filter"
145152
SearchQuery --> ProductSearchFacetRangesValue #green;text:green : "filter"
153+
SearchQuery --> ProductSearchFacetStatsValue #green;text:green : "filter"
146154
SearchQuery --> SearchSorting #green;text:green : "filter"
147155
@enduml

0 commit comments

Comments
 (0)