这是indexloc提供的服务，不要输入任何密码
Skip to content

Add ReadMe API Registry input support #2485

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Aug 20, 2025
Merged

Add ReadMe API Registry input support #2485

merged 5 commits into from
Aug 20, 2025

Conversation

@bombillazo
Copy link
Contributor

@bombillazo bombillazo commented Aug 20, 2025 •
edited by mrlubos
Loading

Closes #2449

Summary

  • Add support for ReadMe API Registry input formats (readme:@org/project#uuid and readme:uuid)
  • Automatically transform ReadMe inputs to API Registry URLs for seamless integration
  • Include comprehensive validation and error handling for ReadMe input formats

Changes

  • Core utilities: New readme.ts module with parsing, validation, and URL transformation functions
  • Configuration integration: Updated input configuration to detect and transform ReadMe formats
  • Type definitions: Enhanced type system to support ReadMe input patterns
  • Documentation: Updated input configuration docs with ReadMe format examples
  • Tests: Comprehensive test coverage for all ReadMe utility functions

@bolt-new-by-stackblitz
Copy link

bolt-new-by-stackblitz bot commented Aug 20, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@changeset-bot
Copy link

changeset-bot bot commented Aug 20, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: e074a36

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@hey-api/openapi-ts Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link

vercel bot commented Aug 20, 2025

@bombillazo is attempting to deploy a commit to the Hey API Team on Vercel.

A member of the Team first needs to authorize it.

@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Aug 20, 2025
@bombillazo bombillazo mentioned this pull request Aug 20, 2025
Closed
@dosubot dosubot bot added the feature 🚀 New feature or request label Aug 20, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Aug 20, 2025 •
edited
Loading

Open in StackBlitz

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/nuxt@2485

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/openapi-ts@2485

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/vite-plugin@2485

commit: e074a36

@codecov
Copy link

codecov bot commented Aug 20, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 97.56098% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 23.03%. Comparing base (7f3308a) to head (e074a36).
⚠️ Report is 7 commits behind head on main.

Files with missing lines Patch % Lines
packages/openapi-ts/src/utils/readme.ts 96.87% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2485      +/-   ##
==========================================
+ Coverage   22.78%   23.03%   +0.24%     
==========================================
  Files         338      339       +1     
  Lines       33733    33773      +40     
  Branches     1353     1384      +31     
==========================================
+ Hits         7686     7778      +92     
+ Misses      26037    25985      -52     
  Partials       10       10
Flag Coverage Δ
unittests 23.03% <97.56%> (+0.24%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 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.

@mrlubos mrlubos merged commit 4bc4dd1 into hey-api:main Aug 20, 2025
12 of 13 checks passed
This was referenced Aug 20, 2025
Merged
Open
@bombillazo bombillazo deleted the feat/readme-api-registry-support branch August 20, 2025 11:44
This was referenced Aug 20, 2025
Open
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

feature 🚀 New feature or request size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Support ReadMe API Registry UUID

2 participants

@bombillazo @mrlubos