Repository navigation
feat: API specs update for version 2.3.x - #123
Conversation
🔵 Tier A · Mergeable after minor fixes
Updates the 2.3.x OpenAPI specifications and generated SDK examples. Adds Analytics, Apps, OAuth2, and avatar-photo examples, extends session and list operations with new optional parameters, and refreshes numeric literals and sample payloads across SDKs.
Note Part of the diff was too large to review, so Hansi did not approve.
Fix with agent prompt### Issue 1
examples/2.3.x/client-android/java/analytics/create-event.md:25-27
**Omit API-key-only overrides from client analytics examples**
The specification says `userId`, `ip`, and `userAgent` overrides require API-key authentication with `analytics.write`, but this client only sets a project ID, so the sample request cannot succeed with these nonempty overrides. Please omit them from client examples (and session-authenticated server examples), rather than requiring a secret API key in a client app.
### Issue 2
examples/2.3.x/client-flutter/examples/analytics/create-event.md:10
**Remove the assignment to an undeclared Dart variable**
This snippet assigns to `result` without declaring it, so it fails to compile when placed in an async function. The server-Dart analytics example has the same issue; declare the result or simply await the call in both examples.
```suggestion
await analytics.createEvent(
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.📂 Walkthrough · 5
🔇 Filtered out · 1Findings Hansi considered but did not post.
Reviewed |
| "<USER_ID>", // userId (optional) | ||
| "<IP>", // ip (optional) | ||
| "<USER_AGENT>", // userAgent (optional) |
There was a problem hiding this comment.
Omit API-key-only overrides from client analytics examples
The specification says userId, ip, and userAgent overrides require API-key authentication with analytics.write, but this client only sets a project ID, so the sample request cannot succeed with these nonempty overrides. Please omit them from client examples (and session-authenticated server examples), rather than requiring a secret API key in a client app.
Prompt To Fix With AI
This is a comment left during a code review.
Path: examples/2.3.x/client-android/java/analytics/create-event.md
Line: 25-27
Comment:
**Omit API-key-only overrides from client analytics examples**
The specification says `userId`, `ip`, and `userAgent` overrides require API-key authentication with `analytics.write`, but this client only sets a project ID, so the sample request cannot succeed with these nonempty overrides. Please omit them from client examples (and session-authenticated server examples), rather than requiring a secret API key in a client app.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.🟡 Minor · documentation · Reply if this doesn't apply.
|
|
||
| Analytics analytics = Analytics(client); | ||
|
|
||
| result = await analytics.createEvent( |
There was a problem hiding this comment.
Remove the assignment to an undeclared Dart variable
This snippet assigns to result without declaring it, so it fails to compile when placed in an async function. The server-Dart analytics example has the same issue; declare the result or simply await the call in both examples.
| result = await analytics.createEvent( | |
| await analytics.createEvent( |
Prompt To Fix With AI
This is a comment left during a code review.
Path: examples/2.3.x/client-flutter/examples/analytics/create-event.md
Line: 10
Comment:
**Remove the assignment to an undeclared Dart variable**
This snippet assigns to `result` without declaring it, so it fails to compile when placed in an async function. The server-Dart analytics example has the same issue; declare the result or simply await the call in both examples.
```suggestion
await analytics.createEvent(
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.🟡 Minor · documentation · Reply if this doesn't apply.
This PR contains API specification updates and SDK examples for version 2.3.x.