-
-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: update website domain, add license documentation
- Loading branch information
Showing
20 changed files
with
96 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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> | ||
|
@@ -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--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.