fix(specs): don't extend $ref objects

[kai687]

🧭 What and Why

PR #3619 added eventName examples for different event objects in the Insights API, instead of using "Product clicked" for all events.

But, extending/overriding the example property isn't supported by the OpenAPI spec, and is ignored when rendering the docs. (tested locally with the redocly CLI).

This PR removes the examples. We provide full examples for each event in the right column, so an extra example property of the event name isn't really necessary anyway.

If I understand the specs correctly:

• in OpenAPI 3.0.3, "This object cannot be extended with additional properties and any properties added SHALL be ignored."
• in OpenAPI 3.1.0, we can override summary and description properties of the referenced object, but still not example.

OpenAPI 3.1.0
OpenAPI 3.0.3

🎟 JIRA Ticket:

Changes included:

• Remove eventName examples

[algolia-bot]

✔️ Code generated!

Name	Link
🪓 Triggered by	8b02220897761e9037abed1bebede600318935cf
🍃 Generated commit	47f76b79a3fa2174d0d1a92d7804c838ed50b104
🌲 Generated branch	generated/fix/no-extend-ref

📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language	Req/s
swift	741

[github-actions]

🚀 Deployed on https://66d80919064dad4e8fd73440--api-clients-automation.netlify.app

[shortcuts]

Should we remove the product clicked example of the eventName ref then? This should avoid confusion

[kai687]

@shortcuts PR 3619 removed the example from the eventName prop, so it's not part of the spec anymore.

[shortcuts]

@shortcuts PR 3619 removed the example from the eventName prop, so it's not part of the spec anymore.

Ah indeed bah nice, cc @JonathanMontane just fyi

[JonathanMontane]

Even better then!