Skip to content

Update examples, update validator recommendation #1113

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 1 commit into from
May 15, 2023
Merged

Update examples, update validator recommendation #1113

merged 1 commit into from
May 15, 2023

Conversation

drwpow
Copy link
Contributor

@drwpow drwpow commented May 15, 2023

Changes

Updates examples.

Removes swagger-cli as a subtle suggestion in favor of the much better Redocly CLI.

Also makes a few other minor docs improvements.

@changeset-bot
Copy link

changeset-bot bot commented May 15, 2023

⚠️ No Changeset found

Latest commit: caf4a1d

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

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented May 15, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: caf4a1d
Status: ✅  Deploy successful!
Preview URL: https://331d7daf.openapi-ts.pages.dev
Branch Preview URL: https://update-docs.openapi-ts.pages.dev

View logs

@@ -23,6 +23,7 @@ description: Additional info about this project
## Project goals

1. Support converting any valid OpenAPI schema to TypeScript types, no matter how complicated.
1. Generate **runtime-free types** for maximum performance.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

🤔 Wondering if there’s a better way to say this. Only lately realized that there is an entire school of thought that believes codegen is a natural pair to OpenAPI and I strongly disagree. After all, why impose heavy runtime SDKs on things that don’t need it? TypeScript has the superpower of static inference that can deliver all the resiliency of static typing but without any runtime impact. In a sense, codegen feels antithetical to how TypeScript works itself.

Anyway, there are probably better terms to express this sentiment, but just putting this placeholder idea here for now.

@drwpow drwpow merged commit 0324ac3 into main May 15, 2023
@drwpow drwpow deleted the update-docs branch May 15, 2023 02:50
vdawg-git pushed a commit to vdawg-git/openapi-typescript that referenced this pull request Jun 14, 2023
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.

1 participant