Skip to content

Updated example docs (because of rename from @blgc/openapi-router to openapi-ts-router) #2080

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

Merged
merged 8 commits into from
Jan 3, 2025

Conversation

bennobuilder
Copy link
Contributor

Changes

  • Renamed package from @blgc/openapi-router to openapi-ts-router to better reflect its purpose and functionality
  • Updated examples documentation to use the new package name
  • Improved examples to be more concise and clearer

How to Review

  1. Check if the new package name openapi-ts-router is acceptable given its similarity to openapi-typescript
  2. Review the updated examples in docs/examples.md for clarity and accuracy
  3. Verify that all links and references to the package have been updated correctly

Discussion Point

I chose the name openapi-ts-router as it clearly indicates what the package does (TypeScript routing for OpenAPI). However, I want to check if this name is too close to your openapi-typescript brand. If you feel it's too similar, I'm happy to consider alternatives. The name openapi-router was already taken, which led to this choice.

Checklist

  • docs/ updated

@bennobuilder bennobuilder requested a review from a team as a code owner January 3, 2025 08:52
Copy link

netlify bot commented Jan 3, 2025

👷 Deploy request for openapi-ts pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 43735dd

Copy link

changeset-bot bot commented Jan 3, 2025

⚠️ No Changeset found

Latest commit: 43735dd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

@drwpow drwpow left a comment

Choose a reason for hiding this comment

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

Changes make sense. Thank you!

@drwpow drwpow merged commit dcd7a86 into openapi-ts:main Jan 3, 2025
8 checks passed
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.

2 participants