From 587791dfede0167fbed229281467e4c4875936f5 Mon Sep 17 00:00:00 2001 From: Lubos Date: Mon, 14 Oct 2024 02:44:20 +0800 Subject: [PATCH] fix: update website domain, add license documentation --- .changeset/witty-ligers-jump.md | 13 ++++++++ README.md | 14 ++++----- docs/.vitepress/config/en.ts | 3 +- docs/.vitepress/config/shared.ts | 6 ++-- docs/about.md | 26 +++++++--------- docs/license.md | 30 +++++++++++++++++++ docs/openapi-ts/get-started.md | 2 +- examples/openapi-ts-axios/src/App.tsx | 8 ++--- examples/openapi-ts-fetch/src/App.tsx | 8 ++--- .../src/App.tsx | 8 ++--- .../src/views/TanstackExample.vue | 4 +-- package.json | 2 +- packages/client-axios/README.md | 10 +++---- packages/client-axios/package.json | 2 +- packages/client-core/package.json | 2 +- packages/client-fetch/README.md | 10 +++---- packages/client-fetch/package.json | 2 +- packages/openapi-ts/README.md | 14 ++++----- packages/openapi-ts/package.json | 4 +-- packages/openapi-ts/src/index.ts | 2 +- 20 files changed, 96 insertions(+), 74 deletions(-) create mode 100644 .changeset/witty-ligers-jump.md create mode 100644 docs/license.md diff --git a/.changeset/witty-ligers-jump.md b/.changeset/witty-ligers-jump.md new file mode 100644 index 000000000..542d897ef --- /dev/null +++ b/.changeset/witty-ligers-jump.md @@ -0,0 +1,13 @@ +--- +'@example/openapi-ts-tanstack-react-query': patch +'@example/openapi-ts-tanstack-vue-query': patch +'@example/openapi-ts-axios': patch +'@example/openapi-ts-fetch': patch +'@hey-api/client-axios': patch +'@hey-api/client-fetch': patch +'@hey-api/client-core': patch +'@hey-api/openapi-ts': patch +'@hey-api/docs': patch +--- + +fix: update website domain, add license documentation diff --git a/README.md b/README.md index 471c9033b..baf20b1ba 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@
- Logo + Logo

OpenAPI TypeScript

-

✨ Turn your OpenAPI specification into a beautiful TypeScript client.

+

🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.

-Generate TypeScript interfaces, REST clients, and JSON Schemas from OpenAPI specifications. - [Live demo](https://stackblitz.com/edit/hey-api-example?file=openapi-ts.config.ts,src%2Fclient%2Fschemas.gen.ts,src%2Fclient%2Fservices.gen.ts,src%2Fclient%2Ftypes.gen.ts) ## Features @@ -18,7 +16,7 @@ Generate TypeScript interfaces, REST clients, and JSON Schemas from OpenAPI spec ## Documentation -Please visit our [website](https://heyapi.vercel.app/) for documentation, guides, migrating, and more. +Please visit our [website](https://heyapi.dev/) for documentation, guides, migrating, and more. ## Sponsoring @@ -26,12 +24,12 @@ Love Hey API? Please consider becoming a [sponsor](https://github.com/sponsors/m ## GitHub Integration (coming soon) -Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.vercel.app/openapi-ts/integrations.html). +Automatically update your code when the APIs it depends on change. [Find out more](https://heyapi.dev/openapi-ts/integrations.html). ## Migrating from OpenAPI Typescript Codegen? -Please read our [migration guide](https://heyapi.vercel.app/openapi-ts/migrating.html#openapi-typescript-codegen). +Please read our [migration guide](https://heyapi.dev/openapi-ts/migrating.html#openapi-typescript-codegen). ## Contributing -Want to get involved? Please refer to the [contributing guide](https://heyapi.vercel.app/contributing.html). +Want to get involved? Please refer to the [contributing guide](https://heyapi.dev/contributing.html). diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts index 4d0869ab0..9675a4e91 100644 --- a/docs/.vitepress/config/en.ts +++ b/docs/.vitepress/config/en.ts @@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress'; export default defineConfig({ description: - 'Turn your OpenAPI specification into a beautiful TypeScript client', + '🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.', lang: 'en-US', themeConfig: { sidebar: [ @@ -56,6 +56,7 @@ export default defineConfig({ { items: [ { link: '/about', text: 'Philosophy' }, + { link: '/license', text: 'License' }, { link: '/contributing', text: 'Contributing' }, ], text: '@hey-api', diff --git a/docs/.vitepress/config/shared.ts b/docs/.vitepress/config/shared.ts index 202e522d9..78c980b1c 100644 --- a/docs/.vitepress/config/shared.ts +++ b/docs/.vitepress/config/shared.ts @@ -9,13 +9,13 @@ export default defineConfig({ 'meta', { content: - 'Turn your OpenAPI specification into a beautiful TypeScript client', + '🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.', property: 'og:title', }, ], ['meta', { content: 'OpenAPI TypeScript', property: 'og:site_name' }], ['meta', { content: '/logo.png', property: 'og:image' }], - ['meta', { content: 'https://heyapi.vercel.app', property: 'og:url' }], + ['meta', { content: 'https://heyapi.dev', property: 'og:url' }], [ 'script', {}, @@ -28,7 +28,7 @@ export default defineConfig({ ].filter(Boolean) as HeadConfig[], lastUpdated: false, sitemap: { - hostname: 'https://heyapi.vercel.app', + hostname: 'https://heyapi.dev', }, themeConfig: { externalLinkIcon: true, diff --git a/docs/about.md b/docs/about.md index a13219d50..a39290e68 100644 --- a/docs/about.md +++ b/docs/about.md @@ -6,24 +6,22 @@ description: Hello from Hey API. @@ -40,16 +38,12 @@ Typically, developers of such applications want to: Doing any of these steps manually quickly becomes a huge time sink as your project grows and APIs evolve. Ideally, you want to spend most time on your application. Hey API allows you to do just that. -We're constantly learning about the ways in which you use our tools. If you have any feedback, please [email us](mailto:lmenus@lmen.us), [open an issue](https://github.com/hey-api/openapi-ts/issues), or [join a discussion](https://github.com/hey-api/openapi-ts/discussions). - -## Team - - +We're constantly learning about the ways in which you use our tools. If you have any feedback, please [email us](mailto:lmenus@lmen.us), [open an issue](https://github.com/hey-api/openapi-ts/issues), or [join a discussion](https://github.com/orgs/hey-api/discussions). -Our core members are [Jordan](https://github.com/jordanshatford) and [Lubos](https://lmen.us/), but we also accept external contributions. Please see our [contributing](./contributing) guide for more information. +## Hall of Fame -## Acknowledgements +These are the people with significant contributions to Hey API. A special thank you goes to [Ferdi Koomen](https://madebyferdi.com/) for allowing us to use the original source code from OpenAPI TypeScript Codegen. None of this would've been possible without you! -None of this would be possible without [Ferdi Koomen](https://madebyferdi.com/) and the contributors to OpenAPI TypeScript Codegen throughout the years. We want to say a huge thank you to all of you, and promise to continue the legacy of the original project. + diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 000000000..711f3cd9e --- /dev/null +++ b/docs/license.md @@ -0,0 +1,30 @@ +--- +title: License +description: License FAQ. +--- + +# License + +While our client packages use the standard MIT license, [openapi-ts](https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md) uses the FSL license pioneered by Sentry. This page explains the motivation behind the change and attempts to answer the most commonly asked questions. If your question isn't answered here, please join the [discussion](https://github.com/orgs/hey-api/discussions/1141). + +## FAQ + +### Why does openapi-ts use the FSL license? + +The main motivation behind using the FSL license for openapi-ts is to protect it from being sold by other companies. We have invested hundreds of hours into development, support, and maintenance to create a high quality product publicly available to everyone. It would not be fair for another company to come and monetize this work without giving back. The MIT license does not offer any protection if this ever happens. + +### What's a permitted usage? + +You are free to generate code with openapi-ts and use the generated code in commercial and non-commercial projects, as long as you do not charge your customers for the code generation. Prior to the license change from MIT on Sep 4th 2024, every use case fell under the permitted usage. + +### What's NOT a permitted usage? + +If you're using openapi-ts to sell competing services related to API tooling such as SDK generation, documentation generation, or API breaking change detection, these are excluded from permitted usage. Feel free to contact us if you're unsure about your use case! + +### Which license does the generated code use? + +The code generated by openapi-ts must follow the permitted usage outlined above. For example, it's fine to consume or publish the generated clients, but you cannot charge your customers for doing so. + +## Feedback + +We understand that your life would be easier if every package used the MIT license. At the same time, it's important to protect our work, so we can keep maintaining it without fear of being exploited by predatory companies. If you have any feedback about licensing, we would love to hear your thoughts in the [discussion](https://github.com/orgs/hey-api/discussions/1141). diff --git a/docs/openapi-ts/get-started.md b/docs/openapi-ts/get-started.md index d57409b8a..4638b6f6d 100644 --- a/docs/openapi-ts/get-started.md +++ b/docs/openapi-ts/get-started.md @@ -9,7 +9,7 @@ import { embedProject } from '../embed' # Get Started -Generate TypeScript interfaces, REST clients, and JSON Schemas from OpenAPI specifications. +🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.