Skip to content
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.

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

feat(specs): update Insights API spec #2376

Merged
merged 23 commits into from Jan 15, 2024
Merged

feat(specs): update Insights API spec #2376

merged 23 commits into from Jan 15, 2024

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Dec 13, 2023

🧭 What and Why

Update the API spec for the Insights API we wanted to make an update to 'Purchase' events.

We want to remove the event-level queryID parameter in the documentation for 'Purchase' events, and rather have object-level queryIDs. (Otherwise, it's too confusing).

🎟 JIRA Ticket: n/a

Changes included:

  • Add the 'value' parameter to the 'AddToCart' and 'Purchase' events.
  • Remove the event level queryID parameter from the 'Purchase' events.
  • Some other minor edits (mostly sorting and formatting, making things more consistent).

🧪 Test

n/a

Add the value property to some events,
sort attributes required/optional,
add examples for these new events.
Copy link

netlify bot commented Dec 13, 2023

Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit bcb35ad
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/65a536c2ec9ef3000835e099
😎 Deploy Preview https://deploy-preview-2376--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Dec 13, 2023

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

@kai687 kai687 changed the title Fix/events feat: update Insights API spec Dec 13, 2023
@kai687 kai687 changed the title feat: update Insights API spec feat(specs): update Insights API spec Dec 13, 2023
@kai687 kai687 marked this pull request as ready for review December 13, 2023 18:08
@kai687 kai687 requested a review from a team as a code owner December 13, 2023 18:08
@kai687
Copy link
Contributor Author

kai687 commented Dec 13, 2023

Ah, I guess, I should write some tests.

@shortcuts
Copy link
Member

hey @kai687, thanks for the PR, taking a look!

@kai687
Copy link
Contributor Author

kai687 commented Dec 14, 2023

I decided to remove the deleteUsertoken from this PR. I'll submit it in another PR to keep things simpler.

The deleteUsertoken endpoint doesn't return a response body, but a 204 No Content status and a few headers. Documentation is no problem, but the code generation expects a response at the moment. So, the client code generation fails, because the function for this method should return void or Unit, but it just prints out nothing at the moment.

@shortcuts
Copy link
Member

the last issue remaining is that the echo interceptor for java requires the method to return the request, but since there's no payload we can't do that, will try to find a fix for that (cc @millotp)

@morganleroi
Copy link
Contributor

working on a C# fix.

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

finally green ! gg everyone

@millotp millotp merged commit 7c5ba32 into main Jan 15, 2024
28 checks passed
@millotp millotp deleted the fix/events branch January 15, 2024 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants