Skip to content

Commit

Permalink
fix: update website domain, add license documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mrlubos committed Oct 13, 2024
1 parent 50cf1d8 commit 587791d
Show file tree
Hide file tree
Showing 20 changed files with 96 additions and 74 deletions.
13 changes: 13 additions & 0 deletions .changeset/witty-ligers-jump.md
Original file line number Diff line number Diff line change
@@ -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
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
<div align="center">
<img width="150" height="150" src="https://heyapi.vercel.app/logo.png" alt="Logo">
<img width="150" height="150" src="https://heyapi.dev/logo.png" alt="Logo">
<h1 align="center"><b>OpenAPI TypeScript</b></h1>
<p align="center">✨ Turn your OpenAPI specification into a beautiful TypeScript client.</p>
<p align="center">🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.</p>
</div>

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
Expand All @@ -18,20 +16,20 @@ 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

Love Hey API? Please consider becoming a [sponsor](https://github.com/sponsors/mrlubos).

## 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).
3 changes: 2 additions & 1 deletion docs/.vitepress/config/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: [
Expand Down Expand Up @@ -56,6 +56,7 @@ export default defineConfig({
{
items: [
{ link: '/about', text: 'Philosophy' },
{ link: '/license', text: 'License' },
{ link: '/contributing', text: 'Contributing' },
],
text: '@hey-api',
Expand Down
6 changes: 3 additions & 3 deletions docs/.vitepress/config/shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
{},
Expand All @@ -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,
Expand Down
26 changes: 10 additions & 16 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,22 @@ description: Hello from Hey API.
<script setup>
import { VPTeamMembers } from 'vitepress/theme'

const members = [
const hallOfFame = [
{
avatar: 'https://github.com/mrlubos.png',
name: 'Lubos',
title: 'Author',
avatar: 'https://github.com/ferdikoomen.png',
name: 'Ferdi Koomen',
links: [
{ icon: 'github', link: 'https://github.com/mrlubos' },
{ icon: 'twitter', link: 'https://twitter.com/mrlubos' }
{ icon: 'github', link: 'https://github.com/ferdikoomen' },
],
sponsor: 'https://github.com/sponsors/mrlubos',
title: 'Author of OpenAPI TypeScript Codegen',
},
{
avatar: 'https://github.com/jordanshatford.png',
name: 'Jordan',
title: 'Maintainer',
links: [
{ icon: 'github', link: 'https://github.com/jordanshatford' },
],
title: 'Maintainer',
},
]
</script>
Expand All @@ -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:[email protected]), [open an issue](https://github.com/hey-api/openapi-ts/issues), or [join a discussion](https://github.com/hey-api/openapi-ts/discussions).

## Team

<VPTeamMembers size="small" :members="members" />
We're constantly learning about the ways in which you use our tools. If you have any feedback, please [email us](mailto:[email protected]), [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.
<VPTeamMembers size="small" :members="hallOfFame" />

<!--@include: ./sponsorship.md-->
30 changes: 30 additions & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion docs/openapi-ts/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<button class="buttonLink" @click="(event) => embedProject('hey-api-example')(event)">
Live demo
Expand Down
8 changes: 2 additions & 6 deletions examples/openapi-ts-axios/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -137,13 +137,9 @@ function App() {
<Container size="1">
<Section size="1" />
<Flex align="center">
<a
className="shrink-0"
href="https://heyapi.vercel.app/"
target="_blank"
>
<a className="shrink-0" href="https://heyapi.dev/" target="_blank">
<img
src="https://heyapi.vercel.app/logo.png"
src="https://heyapi.dev/logo.png"
className="h-16 w-16 transition duration-300 will-change-auto"
alt="Hey API logo"
/>
Expand Down
8 changes: 2 additions & 6 deletions examples/openapi-ts-fetch/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -142,13 +142,9 @@ function App() {
<Container size="1">
<Section size="1" />
<Flex align="center">
<a
className="shrink-0"
href="https://heyapi.vercel.app/"
target="_blank"
>
<a className="shrink-0" href="https://heyapi.dev/" target="_blank">
<img
src="https://heyapi.vercel.app/logo.png"
src="https://heyapi.dev/logo.png"
className="h-16 w-16 transition duration-300 will-change-auto"
alt="Hey API logo"
/>
Expand Down
8 changes: 2 additions & 6 deletions examples/openapi-ts-tanstack-react-query/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -162,13 +162,9 @@ function App() {
<Container size="1">
<Section size="1" />
<Flex align="center">
<a
className="shrink-0"
href="https://heyapi.vercel.app/"
target="_blank"
>
<a className="shrink-0" href="https://heyapi.dev/" target="_blank">
<img
src="https://heyapi.vercel.app/logo.png"
src="https://heyapi.dev/logo.png"
className="h-16 w-16 transition duration-300 will-change-auto"
alt="Hey API logo"
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,11 +153,11 @@ watch(error, (error) => {
<div class="bg-[#18191b] py-12">
<div class="mx-auto flex max-w-md flex-col gap-12">
<div class="flex items-center">
<a class="shrink-0" href="https://heyapi.vercel.app/" target="_blank">
<a class="shrink-0" href="https://heyapi.dev/" target="_blank">
<img
alt="Hey API logo"
class="size-16 transition duration-300 will-change-auto"
src="https://heyapi.vercel.app/logo.png"
src="https://heyapi.dev/logo.png"
/>
</a>

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.1.0",
"description": "Public @hey-api monorepo",
"private": true,
"homepage": "https://heyapi.vercel.app",
"homepage": "https://heyapi.dev",
"repository": {
"type": "git",
"url": "git+https://github.com/hey-api/openapi-ts.git"
Expand Down
10 changes: 5 additions & 5 deletions packages/client-axios/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<img width="150" height="150" src="https://heyapi.vercel.app/logo.png" alt="Logo">
<img width="150" height="150" src="https://heyapi.dev/logo.png" alt="Logo">
<h1 align="center"><b>Axios Client</b></h1>
<p align="center">🚀 Type-safe Axios client for your Hey API types.</p>
</div>
Expand All @@ -19,20 +19,20 @@ Plug and play Axios wrapper for `@hey-api/openapi-ts` generator.

## 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

Love Hey API? Please consider becoming a [sponsor](https://github.com/sponsors/mrlubos).

## 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).
2 changes: 1 addition & 1 deletion packages/client-axios/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@hey-api/client-axios",
"version": "0.2.8",
"description": "Type-safe Axios client for your @hey-api/openapi-ts types",
"homepage": "https://heyapi.vercel.app/",
"homepage": "https://heyapi.dev/",
"repository": {
"type": "git",
"url": "git+https://github.com/hey-api/openapi-ts.git"
Expand Down
2 changes: 1 addition & 1 deletion packages/client-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"private": true,
"type": "module",
"description": "Core utilities for type-safe @hey-api/openapi-ts clients",
"homepage": "https://heyapi.vercel.app/",
"homepage": "https://heyapi.dev/",
"repository": {
"type": "git",
"url": "git+https://github.com/hey-api/openapi-ts.git"
Expand Down
10 changes: 5 additions & 5 deletions packages/client-fetch/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<img width="150" height="150" src="https://heyapi.vercel.app/logo.png" alt="Logo">
<img width="150" height="150" src="https://heyapi.dev/logo.png" alt="Logo">
<h1 align="center"><b>Fetch API Client</b></h1>
<p align="center">🚀 Type-safe Fetch API client for your Hey API types.</p>
</div>
Expand All @@ -19,20 +19,20 @@ Plug and play Fetch API wrapper for `@hey-api/openapi-ts` generator.

## 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

Love Hey API? Please consider becoming a [sponsor](https://github.com/sponsors/mrlubos).

## 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).
2 changes: 1 addition & 1 deletion packages/client-fetch/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "@hey-api/client-fetch",
"version": "0.4.1",
"description": "Type-safe Fetch API client for your @hey-api/openapi-ts types",
"homepage": "https://heyapi.vercel.app/",
"homepage": "https://heyapi.dev/",
"repository": {
"type": "git",
"url": "git+https://github.com/hey-api/openapi-ts.git"
Expand Down
14 changes: 6 additions & 8 deletions packages/openapi-ts/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
<div align="center">
<img width="150" height="150" src="https://heyapi.vercel.app/logo.png" alt="Logo">
<img width="150" height="150" src="https://heyapi.dev/logo.png" alt="Logo">
<h1 align="center"><b>OpenAPI TypeScript</b></h1>
<p align="center">✨ Turn your OpenAPI specification into a beautiful TypeScript client.</p>
<p align="center">🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.</p>
</div>

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
Expand All @@ -18,20 +16,20 @@ 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

Love Hey API? Please consider becoming a [sponsor](https://github.com/sponsors/mrlubos).

## 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).
4 changes: 2 additions & 2 deletions packages/openapi-ts/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@hey-api/openapi-ts",
"version": "0.53.10",
"description": "Turn your OpenAPI specification into a beautiful TypeScript client",
"homepage": "https://heyapi.vercel.app/",
"description": "🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.",
"homepage": "https://heyapi.dev/",
"repository": {
"type": "git",
"url": "git+https://github.com/hey-api/openapi-ts.git"
Expand Down
Loading

0 comments on commit 587791d

Please sign in to comment.