Skip to content

Conversation

@simone-stacks
Copy link
Contributor

@simone-stacks simone-stacks commented Dec 18, 2025

Description

Examples were not rendering correctly in some API documentation viewers (e.g., VSCode OpenAPI preview). The previous example: $ref: pattern is v2-style and not properly supported in OpenAPI v3.x.

This PR:

  • Restructured all 31 OpenAPI example files to use proper Example Object format
  • Converted externalValue references to $ref pattern with Example Objects
  • Ensures OpenAPI v3.1 specification compliance

Applicable issues

Checklist

  • Test coverage for new or modified code paths
  • Changelog is updated
  • Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)
  • New clarity functions have corresponding PR in clarity-benchmarking repo

Copy link
Contributor

@federico-stacks federico-stacks left a comment

Choose a reason for hiding this comment

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

LGMT!

Made some tests and I can confirm that the rendering issue reported in the referenced ticket seems to be solved.

@simone-stacks simone-stacks marked this pull request as ready for review December 18, 2025 16:31
Copy link
Contributor

@francesco-stacks francesco-stacks left a comment

Choose a reason for hiding this comment

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

lgtm!

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.

3 participants