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!

@simone-stacks simone-stacks removed the request for review from hstove-stacks January 5, 2026 13:08
@codecov
Copy link

codecov bot commented Jan 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.33%. Comparing base (ef4a697) to head (2eab23c).
⚠️ Report is 11 commits behind head on develop.

❌ Your project status has failed because the head coverage (74.33%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #6768      +/-   ##
===========================================
+ Coverage    68.86%   74.33%   +5.47%     
===========================================
  Files          586      586              
  Lines       361650   361650              
===========================================
+ Hits        249053   268845   +19792     
+ Misses      112597    92805   -19792     

see 292 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ef4a697...2eab23c. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@simone-stacks simone-stacks added this pull request to the merge queue Jan 5, 2026
Merged via the queue into stacks-network:develop with commit 267c7ef Jan 5, 2026
308 of 313 checks passed
@simone-stacks simone-stacks deleted the chore/openapi-examples-v3 branch January 5, 2026 15:23
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