Skip to content

Commit e904fe5

Browse files
algolia-botClaraMuller
algolia-bot
and
ClaraMuller
committed
feat(specs): make response fields required for composition list endpoint (#4821) (generated) [skip ci]
Co-authored-by: Clara Muller <[email protected]>
1 parent 95f3208 commit e904fe5

File tree

36 files changed

+108
-102
lines changed

36 files changed

+108
-102
lines changed

‎clients/algoliasearch-client-javascript/packages/client-composition/model/listCompositionsResponse.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ export type ListCompositionsResponse = {
1616
/**
1717
* Current page.
1818
*/
19-
page?: number;
19+
page: number;
2020

2121
/**
2222
* Number of items per page.
2323
*/
24-
hitsPerPage?: number;
24+
hitsPerPage: number;
2525

2626
/**
2727
* Number of items.
2828
*/
29-
nbHits?: number;
29+
nbHits: number;
3030
};

‎docs/bundled/composition-full.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4474,8 +4474,11 @@ components:
44744474
description: Number of items.
44754475
example: 200
44764476
required:
4477+
- hitsPerPage
44774478
- items
4479+
- nbHits
44784480
- nbPages
4481+
- page
44794482
responses:
44804483
BadRequest:
44814484
description: Bad request or request arguments.

‎docs/bundled/insights-snippets.json

Lines changed: 11 additions & 11 deletions
Large diffs are not rendered by default.

‎docs/snippets/csharp/src/Insights.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ public async Task SnippetForInsightsClientPushEvents1()
509509
Index = "products",
510510
UserToken = "user-123456",
511511
AuthenticatedUserToken = "user-123456",
512-
Timestamp = 1746230400000L,
512+
Timestamp = 1746489600000L,
513513
ObjectIDs = new List<string> { "9780545139700", "9780439784542" },
514514
QueryID = "43b15df305339e827f0ac0bdc5ebcaa7",
515515
}
@@ -522,7 +522,7 @@ public async Task SnippetForInsightsClientPushEvents1()
522522
Index = "products",
523523
UserToken = "user-123456",
524524
AuthenticatedUserToken = "user-123456",
525-
Timestamp = 1746230400000L,
525+
Timestamp = 1746489600000L,
526526
ObjectIDs = new List<string> { "9780545139700", "9780439784542" },
527527
}
528528
),

‎docs/snippets/dart/lib/insights.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@ void snippetForpushEvents1() async {
566566
index: "products",
567567
userToken: "user-123456",
568568
authenticatedUserToken: "user-123456",
569-
timestamp: 1746230400000,
569+
timestamp: 1746489600000,
570570
objectIDs: [
571571
"9780545139700",
572572
"9780439784542",
@@ -579,7 +579,7 @@ void snippetForpushEvents1() async {
579579
index: "products",
580580
userToken: "user-123456",
581581
authenticatedUserToken: "user-123456",
582-
timestamp: 1746230400000,
582+
timestamp: 1746489600000,
583583
objectIDs: [
584584
"9780545139700",
585585
"9780439784542",

‎docs/snippets/go/src/insights.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/snippets/java/src/test/java/com/algolia/Insights.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ void snippetForPushEvents1() throws Exception {
490490
.setIndex("products")
491491
.setUserToken("user-123456")
492492
.setAuthenticatedUserToken("user-123456")
493-
.setTimestamp(1746230400000L)
493+
.setTimestamp(1746489600000L)
494494
.setObjectIDs(Arrays.asList("9780545139700", "9780439784542"))
495495
.setQueryID("43b15df305339e827f0ac0bdc5ebcaa7"),
496496
new ViewedObjectIDs()
@@ -499,7 +499,7 @@ void snippetForPushEvents1() throws Exception {
499499
.setIndex("products")
500500
.setUserToken("user-123456")
501501
.setAuthenticatedUserToken("user-123456")
502-
.setTimestamp(1746230400000L)
502+
.setTimestamp(1746489600000L)
503503
.setObjectIDs(Arrays.asList("9780545139700", "9780439784542"))
504504
)
505505
)

‎docs/snippets/javascript/src/insights.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ export async function snippetForPushEvents1(): Promise<void> {
453453
index: 'products',
454454
userToken: 'user-123456',
455455
authenticatedUserToken: 'user-123456',
456-
timestamp: 1746230400000,
456+
timestamp: 1746489600000,
457457
objectIDs: ['9780545139700', '9780439784542'],
458458
queryID: '43b15df305339e827f0ac0bdc5ebcaa7',
459459
},
@@ -463,7 +463,7 @@ export async function snippetForPushEvents1(): Promise<void> {
463463
index: 'products',
464464
userToken: 'user-123456',
465465
authenticatedUserToken: 'user-123456',
466-
timestamp: 1746230400000,
466+
timestamp: 1746489600000,
467467
objectIDs: ['9780545139700', '9780439784542'],
468468
},
469469
],

‎docs/snippets/kotlin/src/main/kotlin/com/algolia/snippets/Insights.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ class SnippetInsightsClient {
533533
index = "products",
534534
userToken = "user-123456",
535535
authenticatedUserToken = "user-123456",
536-
timestamp = 1746230400000L,
536+
timestamp = 1746489600000L,
537537
objectIDs = listOf("9780545139700", "9780439784542"),
538538
queryID = "43b15df305339e827f0ac0bdc5ebcaa7",
539539
),
@@ -543,7 +543,7 @@ class SnippetInsightsClient {
543543
index = "products",
544544
userToken = "user-123456",
545545
authenticatedUserToken = "user-123456",
546-
timestamp = 1746230400000L,
546+
timestamp = 1746489600000L,
547547
objectIDs = listOf("9780545139700", "9780439784542"),
548548
),
549549
),

‎docs/snippets/php/src/Insights.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -589,7 +589,7 @@ public function snippetForPushEvents1(): void
589589
'index' => 'products',
590590
'userToken' => 'user-123456',
591591
'authenticatedUserToken' => 'user-123456',
592-
'timestamp' => 1746230400000,
592+
'timestamp' => 1746489600000,
593593
'objectIDs' => [
594594
'9780545139700',
595595

@@ -603,7 +603,7 @@ public function snippetForPushEvents1(): void
603603
'index' => 'products',
604604
'userToken' => 'user-123456',
605605
'authenticatedUserToken' => 'user-123456',
606-
'timestamp' => 1746230400000,
606+
'timestamp' => 1746489600000,
607607
'objectIDs' => [
608608
'9780545139700',
609609

‎docs/snippets/python/insights.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,7 @@ def snippet_for_push_events1():
634634
"index": "products",
635635
"userToken": "user-123456",
636636
"authenticatedUserToken": "user-123456",
637-
"timestamp": 1746230400000,
637+
"timestamp": 1746489600000,
638638
"objectIDs": [
639639
"9780545139700",
640640
"9780439784542",
@@ -647,7 +647,7 @@ def snippet_for_push_events1():
647647
"index": "products",
648648
"userToken": "user-123456",
649649
"authenticatedUserToken": "user-123456",
650-
"timestamp": 1746230400000,
650+
"timestamp": 1746489600000,
651651
"objectIDs": [
652652
"9780545139700",
653653
"9780439784542",

‎docs/snippets/ruby/insights.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ def snippet_for_push_events1
487487
index: "products",
488488
user_token: "user-123456",
489489
authenticated_user_token: "user-123456",
490-
timestamp: 1746230400000,
490+
timestamp: 1746489600000,
491491
object_ids: ["9780545139700", "9780439784542"],
492492
query_id: "43b15df305339e827f0ac0bdc5ebcaa7"
493493
),
@@ -497,7 +497,7 @@ def snippet_for_push_events1
497497
index: "products",
498498
user_token: "user-123456",
499499
authenticated_user_token: "user-123456",
500-
timestamp: 1746230400000,
500+
timestamp: 1746489600000,
501501
object_ids: ["9780545139700", "9780439784542"]
502502
)
503503
]

‎docs/snippets/scala/src/main/scala/Insights.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@ class SnippetInsightsClient {
623623
index = "products",
624624
userToken = "user-123456",
625625
authenticatedUserToken = Some("user-123456"),
626-
timestamp = Some(1746230400000L),
626+
timestamp = Some(1746489600000L),
627627
objectIDs = Seq("9780545139700", "9780439784542"),
628628
queryID = "43b15df305339e827f0ac0bdc5ebcaa7"
629629
),
@@ -633,7 +633,7 @@ class SnippetInsightsClient {
633633
index = "products",
634634
userToken = "user-123456",
635635
authenticatedUserToken = Some("user-123456"),
636-
timestamp = Some(1746230400000L),
636+
timestamp = Some(1746489600000L),
637637
objectIDs = Seq("9780545139700", "9780439784542")
638638
)
639639
)

‎docs/snippets/swift/Sources/Insights.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ final class InsightsClientSnippet {
401401
queryID: "43b15df305339e827f0ac0bdc5ebcaa7",
402402
userToken: "user-123456",
403403
authenticatedUserToken: "user-123456",
404-
timestamp: Int64(1_746_230_400_000)
404+
timestamp: Int64(1_746_489_600_000)
405405
)),
406406
EventsItems.viewedObjectIDs(ViewedObjectIDs(
407407
eventName: "Product Detail Page Viewed",
@@ -410,7 +410,7 @@ final class InsightsClientSnippet {
410410
objectIDs: ["9780545139700", "9780439784542"],
411411
userToken: "user-123456",
412412
authenticatedUserToken: "user-123456",
413-
timestamp: Int64(1_746_230_400_000)
413+
timestamp: Int64(1_746_489_600_000)
414414
)),
415415
]))
416416
// >LOG

‎specs/bundled/composition-full.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4134,8 +4134,11 @@ components:
41344134
description: Number of items.
41354135
example: 200
41364136
required:
4137+
- hitsPerPage
41374138
- items
4139+
- nbHits
41384140
- nbPages
4141+
- page
41394142
responses:
41404143
BadRequest:
41414144
description: Bad request or request arguments.

‎tests/output/csharp/src/generated/e2e/Insights.test.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public async Task PushEventsTest1()
6363
Index = "products",
6464
UserToken = "user-123456",
6565
AuthenticatedUserToken = "user-123456",
66-
Timestamp = 1746230400000L,
66+
Timestamp = 1746489600000L,
6767
ObjectIDs = new List<string> { "9780545139700", "9780439784542" },
6868
QueryID = "43b15df305339e827f0ac0bdc5ebcaa7",
6969
}
@@ -76,7 +76,7 @@ public async Task PushEventsTest1()
7676
Index = "products",
7777
UserToken = "user-123456",
7878
AuthenticatedUserToken = "user-123456",
79-
Timestamp = 1746230400000L,
79+
Timestamp = 1746489600000L,
8080
ObjectIDs = new List<string> { "9780545139700", "9780439784542" },
8181
}
8282
),

‎tests/output/csharp/src/generated/requests/Insights.test.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -580,7 +580,7 @@ await client.PushEventsAsync(
580580
Index = "products",
581581
UserToken = "user-123456",
582582
AuthenticatedUserToken = "user-123456",
583-
Timestamp = 1746230400000L,
583+
Timestamp = 1746489600000L,
584584
ObjectIDs = new List<string> { "9780545139700", "9780439784542" },
585585
QueryID = "43b15df305339e827f0ac0bdc5ebcaa7",
586586
}
@@ -593,7 +593,7 @@ await client.PushEventsAsync(
593593
Index = "products",
594594
UserToken = "user-123456",
595595
AuthenticatedUserToken = "user-123456",
596-
Timestamp = 1746230400000L,
596+
Timestamp = 1746489600000L,
597597
ObjectIDs = new List<string> { "9780545139700", "9780439784542" },
598598
}
599599
),
@@ -605,7 +605,7 @@ await client.PushEventsAsync(
605605
Assert.Equal("/1/events", req.Path);
606606
Assert.Equal("POST", req.Method.ToString());
607607
JsonAssert.EqualOverrideDefault(
608-
"{\"events\":[{\"eventType\":\"conversion\",\"eventName\":\"Product Purchased\",\"index\":\"products\",\"userToken\":\"user-123456\",\"authenticatedUserToken\":\"user-123456\",\"timestamp\":1746230400000,\"objectIDs\":[\"9780545139700\",\"9780439784542\"],\"queryID\":\"43b15df305339e827f0ac0bdc5ebcaa7\"},{\"eventType\":\"view\",\"eventName\":\"Product Detail Page Viewed\",\"index\":\"products\",\"userToken\":\"user-123456\",\"authenticatedUserToken\":\"user-123456\",\"timestamp\":1746230400000,\"objectIDs\":[\"9780545139700\",\"9780439784542\"]}]}",
608+
"{\"events\":[{\"eventType\":\"conversion\",\"eventName\":\"Product Purchased\",\"index\":\"products\",\"userToken\":\"user-123456\",\"authenticatedUserToken\":\"user-123456\",\"timestamp\":1746489600000,\"objectIDs\":[\"9780545139700\",\"9780439784542\"],\"queryID\":\"43b15df305339e827f0ac0bdc5ebcaa7\"},{\"eventType\":\"view\",\"eventName\":\"Product Detail Page Viewed\",\"index\":\"products\",\"userToken\":\"user-123456\",\"authenticatedUserToken\":\"user-123456\",\"timestamp\":1746489600000,\"objectIDs\":[\"9780545139700\",\"9780439784542\"]}]}",
609609
req.Body,
610610
new JsonDiffConfig(false)
611611
);

‎tests/output/dart/test/requests/insights_test.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -625,7 +625,7 @@ void main() {
625625
index: "products",
626626
userToken: "user-123456",
627627
authenticatedUserToken: "user-123456",
628-
timestamp: 1746230400000,
628+
timestamp: 1746489600000,
629629
objectIDs: [
630630
"9780545139700",
631631
"9780439784542",
@@ -638,7 +638,7 @@ void main() {
638638
index: "products",
639639
userToken: "user-123456",
640640
authenticatedUserToken: "user-123456",
641-
timestamp: 1746230400000,
641+
timestamp: 1746489600000,
642642
objectIDs: [
643643
"9780545139700",
644644
"9780439784542",
@@ -651,7 +651,7 @@ void main() {
651651
expectPath(request.path, '/1/events');
652652
expect(request.method, 'post');
653653
expectBody(request.body,
654-
"""{"events":[{"eventType":"conversion","eventName":"Product Purchased","index":"products","userToken":"user-123456","authenticatedUserToken":"user-123456","timestamp":1746230400000,"objectIDs":["9780545139700","9780439784542"],"queryID":"43b15df305339e827f0ac0bdc5ebcaa7"},{"eventType":"view","eventName":"Product Detail Page Viewed","index":"products","userToken":"user-123456","authenticatedUserToken":"user-123456","timestamp":1746230400000,"objectIDs":["9780545139700","9780439784542"]}]}""");
654+
"""{"events":[{"eventType":"conversion","eventName":"Product Purchased","index":"products","userToken":"user-123456","authenticatedUserToken":"user-123456","timestamp":1746489600000,"objectIDs":["9780545139700","9780439784542"],"queryID":"43b15df305339e827f0ac0bdc5ebcaa7"},{"eventType":"view","eventName":"Product Detail Page Viewed","index":"products","userToken":"user-123456","authenticatedUserToken":"user-123456","timestamp":1746489600000,"objectIDs":["9780545139700","9780439784542"]}]}""");
655655
},
656656
),
657657
);

‎tests/output/go/tests/e2e/insights_test.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/output/go/tests/requests/insights_test.go

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tests/output/java/src/test/java/com/algolia/e2e/Insights.test.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ void pushEventsTest1() {
5050
.setIndex("products")
5151
.setUserToken("user-123456")
5252
.setAuthenticatedUserToken("user-123456")
53-
.setTimestamp(1746230400000L)
53+
.setTimestamp(1746489600000L)
5454
.setObjectIDs(Arrays.asList("9780545139700", "9780439784542"))
5555
.setQueryID("43b15df305339e827f0ac0bdc5ebcaa7"),
5656
new ViewedObjectIDs()
@@ -59,7 +59,7 @@ void pushEventsTest1() {
5959
.setIndex("products")
6060
.setUserToken("user-123456")
6161
.setAuthenticatedUserToken("user-123456")
62-
.setTimestamp(1746230400000L)
62+
.setTimestamp(1746489600000L)
6363
.setObjectIDs(Arrays.asList("9780545139700", "9780439784542"))
6464
)
6565
)

0 commit comments

Comments
 (0)