Skip to content

Commit baae95a

Browse files
committed
docs: add migration notes for 0.87.0
1 parent 0e7dbc3 commit baae95a

File tree

11 files changed

+26
-168
lines changed

11 files changed

+26
-168
lines changed

.changeset/seven-walls-return.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@
33
---
44

55
feat: remove legacy clients and plugins
6+
7+
### Removed legacy clients
8+
9+
This release removes support for legacy clients and plugins. Please migrate to the new clients if you haven't done so yet. If you're unable to do so due to a missing feature, let us know on [GitHub](https://github.com/hey-api/openapi-ts/issues).

docs/.vitepress/config/en.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,6 @@ export default defineConfig({
119119
link: '/openapi-ts/clients/ky',
120120
text: 'Ky <span data-soon>soon</span>',
121121
},
122-
{
123-
link: '/openapi-ts/clients/legacy',
124-
text: 'Legacy',
125-
},
126122
],
127123
link: '/openapi-ts/clients',
128124
text: 'Clients',

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: home
33

44
hero:
55
name: One OpenAPI spec.<br/>Infinite outputs.
6-
tagline: Codegen for JavaScript/TypeScript projects. Trusted over 3,000,000 times each month to generate reliable API clients and SDKs.
6+
tagline: Code generator for TypeScript projects. Trusted by companies like Google, Amazon, and PayPal to generate API clients, SDKs, validators, and more.
77
actions:
88
- link: /openapi-ts/get-started
99
text: Get Started

docs/openapi-ts/clients.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ Hey API natively supports the following clients.
3434
- [Effect](/openapi-ts/clients/effect) <span data-soon>Soon</span>
3535
- [Got](/openapi-ts/clients/got) <span data-soon>Soon</span>
3636
- [Ky](/openapi-ts/clients/ky) <span data-soon>Soon</span>
37-
- [Legacy](/openapi-ts/clients/legacy)
3837

3938
Don't see your client? [Build your own](/openapi-ts/clients/custom) or let us know your interest by [opening an issue](https://github.com/hey-api/openapi-ts/issues).
4039

docs/openapi-ts/clients/legacy.md

Lines changed: 0 additions & 136 deletions
This file was deleted.

docs/openapi-ts/get-started.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ import { embedProject } from '../embed'
99

1010
# Get Started
1111

12-
[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an OpenAPI to TypeScript codegen trusted over 3,000,000 times each month to generate reliable API clients and SDKs. The code is [MIT-licensed](/openapi-ts/license) and free to use. Discover available features below or view our [roadmap](https://github.com/orgs/hey-api/discussions/1495) to learn what's coming next.
12+
[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an [open source](/openapi-ts/license) OpenAPI to TypeScript code generator trusted by companies like Google, Amazon, and PayPal to generate API clients, SDKs, validators, and more. We also build complementary tools and [services](https://app.heyapi.dev/) that help teams design, manage, and distribute APIs more effectively.
13+
14+
> “OpenAPI codegen that just works.”
15+
> — Guillermo Rauch
1316
1417
### Demo
1518

docs/openapi-ts/migrating.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ description: Migrating to @hey-api/openapi-ts.
77

88
While we try to avoid breaking changes, sometimes it's unavoidable in order to offer you the latest features. This page lists changes that require updates to your code. If you run into a problem with migration, please [open an issue](https://github.com/hey-api/openapi-ts/issues).
99

10+
## v0.87.0
11+
12+
### Removed legacy clients
13+
14+
This release removes support for legacy clients and plugins. Please migrate to the new clients if you haven't done so yet. If you're unable to do so due to a missing feature, let us know on [GitHub](https://github.com/hey-api/openapi-ts/issues).
15+
1016
## v0.86.0
1117

1218
### Removed Node 18 support

packages/codegen-core/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,13 @@
1515
<a href="https://github.com/hey-api/openapi-ts/issues">Issues</a>
1616
<span>&nbsp;&nbsp;</span>
1717
<a href="https://heyapi.dev/openapi-ts/community/contributing">Contribute</a>
18-
<span>&nbsp;&nbsp;</span>
19-
<a href="https://heyapi.dev/openapi-ts/community/spotlight#core-team">Join Core Team</a>
2018
</p>
2119

2220
<br/>
2321

2422
## Dashboard
2523

26-
Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with Hey API Platform.
27-
28-
[Sign In](https://app.heyapi.dev) to Hey API Platform.
24+
Access your projects and OpenAPI specifications in the [Hey API Platform](https://app.heyapi.dev/).
2925

3026
## Contributing
3127

packages/nuxt/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@
2020

2121
## Dashboard
2222

23-
Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with Hey API Platform.
24-
25-
[Sign In](https://app.heyapi.dev) to Hey API Platform.
23+
Access your projects and OpenAPI specifications in the [Hey API Platform](https://app.heyapi.dev/).
2624

2725
## Contributing
2826

packages/openapi-ts/README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
<div align="center">
22
<img alt="Two people looking at the blueprint" height="214" src="https://heyapi.dev/images/blueprint-640w.png" width="320">
3-
<h1 align="center"><b>OpenAPI TypeScript</b></h1>
4-
<p align="center">🚀 The OpenAPI to TypeScript codegen. Generate clients, SDKs, validators, and more.</p>
3+
<h1><b>OpenAPI TypeScript</b></h1>
4+
<p><em>“OpenAPI codegen that just works.”</em><br/><sub>— Guillermo Rauch</sub></p>
55
</div>
66

7-
<br/>
8-
97
<p align="center">
10-
<a href="https://opensource.org/license/mit" rel="nofollow"><img src="https://img.shields.io/github/license/hey-api/openapi-ts" alt="MIT License"></a>
118
<a href="https://npmjs.com/package/@hey-api/openapi-ts" rel="nofollow"><img src="https://img.shields.io/npm/dm/%40hey-api%2Fopenapi-ts?label=npm" alt="npm downloads"></a>
12-
<a href="https://github.com/hey-api/openapi-ts" rel="nofollow"><img src="https://img.shields.io/github/stars/hey-api/openapi-ts?style=flat&logo=github&label=GitHub&color=54C82D" alt="GitHub stars" /></a>
139
<a href="https://github.com/hey-api/openapi-ts/actions?query=branch%3Amain"><img src="https://github.com/hey-api/openapi-ts/actions/workflows/ci.yml/badge.svg?event=push&branch=main" alt="CI status" /></a>
10+
<a href="https://github.com/hey-api/openapi-ts" rel="nofollow"><img src="https://img.shields.io/github/stars/hey-api/openapi-ts?style=flat&logo=github&label=GitHub&color=54C82D" alt="GitHub stars" /></a>
11+
<a href="https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md" rel="nofollow"><img src="https://img.shields.io/github/license/hey-api/openapi-ts" alt="MIT License"></a>
1412
</p>
1513

1614
<p align="center">
@@ -20,14 +18,12 @@
2018
<span>&nbsp;&nbsp;</span>
2119
<a href="https://github.com/hey-api/openapi-ts/issues">Issues</a>
2220
<span>&nbsp;&nbsp;</span>
23-
<a href="https://github.com/orgs/hey-api/discussions/1495">Roadmap</a>
24-
<span>&nbsp;&nbsp;</span>
2521
<a href="https://heyapi.dev/openapi-ts/community/contributing">Contribute</a>
26-
<span>&nbsp;&nbsp;</span>
27-
<a href="https://heyapi.dev/openapi-ts/community/spotlight#core-team">Join Core Team</a>
2822
</p>
2923

30-
<br/>
24+
## About
25+
26+
[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an [open source](https://github.com/hey-api/openapi-ts/blob/main/LICENSE.md) OpenAPI to TypeScript code generator trusted by companies like Google, Amazon, and PayPal to generate API clients, SDKs, validators, and more. We also build complementary tools and [services](https://app.heyapi.dev/) that help teams design, manage, and distribute APIs more effectively.
3127

3228
## Features
3329

@@ -41,9 +37,7 @@
4137

4238
## Dashboard
4339

44-
Hey API is an ecosystem of products helping you build better APIs. Superpower your codegen and APIs with Hey API Platform.
45-
46-
[Sign In](https://app.heyapi.dev) to Hey API Platform.
40+
Access your projects and OpenAPI specifications in the [Hey API Platform](https://app.heyapi.dev/).
4741

4842
## Contributing
4943

0 commit comments

Comments
 (0)