Merge pull request #2489 from hey-api/fix/api-registry-shorthand

feat(input): input supports Hey API Registry shorthand

Author: mrlubos

.changeset/soft-penguins-fetch.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+feat(input): input supports Hey API Registry shorthand

docs/openapi-ts/clients/angular.md

@@ -49,15 +49,15 @@ In your [configuration](/openapi-ts/get-started), add `@hey-api/client-angular`
 
 ```js [config]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['@hey-api/client-angular'], // [!code ++]
 };
 ```
 
 ```sh [cli]
 npx @hey-api/openapi-ts \
-  -i https://get.heyapi.dev/hey-api/backend \
+  -i hey-api/backend \
   -o src/client \
   -c @hey-api/client-angular # [!code ++]
 ```
@@ -105,7 +105,7 @@ Since `client.gen.ts` is a generated file, we can't directly modify it. Instead,
 
 ```js
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: [
     {
@@ -178,7 +178,7 @@ export class FooService {
 
 ```js [config]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: [
     '@hey-api/client-angular',

docs/openapi-ts/clients/angular/v19.md

@@ -49,15 +49,15 @@ In your [configuration](/openapi-ts/get-started), add `@hey-api/client-angular`
 
 ```js [config]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['@hey-api/client-angular'], // [!code ++]
 };
 ```
 
 ```sh [cli]
 npx @hey-api/openapi-ts \
-  -i https://get.heyapi.dev/hey-api/backend \
+  -i hey-api/backend \
   -o src/client \
   -c @hey-api/client-angular # [!code ++]
 ```
@@ -105,7 +105,7 @@ Since `client.gen.ts` is a generated file, we can't directly modify it. Instead,
 
 ```js
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: [
     {
@@ -178,7 +178,7 @@ export class FooService {
 
 ```js [config]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: [
     '@hey-api/client-angular',

docs/openapi-ts/clients/axios.md

@@ -46,15 +46,15 @@ In your [configuration](/openapi-ts/get-started), add `@hey-api/client-axios` to
 
 ```js [config]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['@hey-api/client-axios'], // [!code ++]
 };
 ```
 
 ```sh [cli]
 npx @hey-api/openapi-ts \
-  -i https://get.heyapi.dev/hey-api/backend \
+  -i hey-api/backend \
   -o src/client \
   -c @hey-api/client-axios # [!code ++]
 ```
@@ -87,7 +87,7 @@ Since `client.gen.ts` is a generated file, we can't directly modify it. Instead,
 
 ```js
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: [
     {

docs/openapi-ts/clients/fetch.md

@@ -39,15 +39,15 @@ In your [configuration](/openapi-ts/get-started), add `@hey-api/client-fetch` to
 
 ```js [config]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['@hey-api/client-fetch'], // [!code ++]
 };
 ```
 
 ```sh [cli]
 npx @hey-api/openapi-ts \
-  -i https://get.heyapi.dev/hey-api/backend \
+  -i hey-api/backend \
   -o src/client \
   -c @hey-api/client-fetch # [!code ++]
 ```
@@ -86,7 +86,7 @@ Since `client.gen.ts` is a generated file, we can't directly modify it. Instead,
 
 ```js
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: [
     {

docs/openapi-ts/clients/legacy.md

@@ -19,39 +19,39 @@ Before client packages, clients were generated using `@hey-api/openapi-ts`. In f
 
 ```js [fetch]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['legacy/fetch'], // [!code ++]
 };
 ```
 
 ```js [axios]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['legacy/axios'], // [!code ++]
 };
 ```
 
 ```js [angular]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['legacy/angular'], // [!code ++]
 };
 ```
 
 ```js [node]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['legacy/node'], // [!code ++]
 };
 ```
 
 ```js [xhr]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['legacy/xhr'], // [!code ++]
 };

docs/openapi-ts/clients/next-js.md

@@ -29,15 +29,15 @@ In your [configuration](/openapi-ts/get-started), add `@hey-api/client-next` to
 
 ```js [config]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['@hey-api/client-next'], // [!code ++]
 };
 ```
 
 ```sh [cli]
 npx @hey-api/openapi-ts \
-  -i https://get.heyapi.dev/hey-api/backend \
+  -i hey-api/backend \
   -o src/client \
   -c @hey-api/client-next # [!code ++]
 ```
@@ -56,7 +56,7 @@ Since `client.gen.ts` is a generated file, we can't directly modify it. Instead,
 
 ```js
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: [
     {

docs/openapi-ts/clients/nuxt.md

@@ -64,15 +64,15 @@ In your [configuration](/openapi-ts/get-started), add `@hey-api/client-nuxt` to
 
 ```js [config]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: ['@hey-api/client-nuxt'], // [!code ++]
 };
 ```
 
 ```sh [cli]
 npx @hey-api/openapi-ts \
-  -i https://get.heyapi.dev/hey-api/backend \
+  -i hey-api/backend \
   -o src/client \
   -c @hey-api/client-nuxt # [!code ++]
 ```
@@ -111,7 +111,7 @@ Since `client.gen.ts` is a generated file, we can't directly modify it. Instead,
 
 ```js
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
   plugins: [
     {

docs/openapi-ts/configuration.md

@@ -13,23 +13,23 @@ description: Configure @hey-api/openapi-ts.
 import { defineConfig } from '@hey-api/openapi-ts';
 
 export default defineConfig({
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
 });
 ```
 
 ```js [openapi-ts.config.cjs]
 /** @type {import('@hey-api/openapi-ts').UserConfig} */
 module.exports = {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
 };
 ```
 
 ```js [openapi-ts.config.mjs]
 /** @type {import('@hey-api/openapi-ts').UserConfig} */
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client',
 };
 ```
@@ -65,7 +65,9 @@ export default defineConfig([
 
 ## Input
 
-You must set the input so we can load your OpenAPI specification. It can be a path or URL, object containing a path or URL, or an object representing an OpenAPI specification. Hey API supports all valid OpenAPI versions and file formats.
+You must provide an input so we can load your OpenAPI specification.
+
+The input can be a string path, URL, API registry shorthand, an object containing any of these, or an object representing an OpenAPI specification. Hey API supports all valid OpenAPI versions and file formats.
 
 You can learn more on the [Input](/openapi-ts/configuration/input) page.
 
@@ -79,15 +81,21 @@ export default {
 
 ```js [url]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend', // [!code ++]
+  input: 'https://get.heyapi.dev/hey-api/backend', // sign up at app.heyapi.dev // [!code ++]
+};
+```
+
+```js [registry]
+export default {
+  input: 'hey-api/backend', // sign up at app.heyapi.dev // [!code ++]
 };
 ```
 
 <!-- prettier-ignore-start -->
 ```js [object]
 export default {
   input: { // [!code ++]
-    path: 'https://get.heyapi.dev/hey-api/backend', // [!code ++]
+    path: 'hey-api/backend', // sign up at app.heyapi.dev // [!code ++]
     // ...other options // [!code ++]
   }, // [!code ++]
 };
@@ -120,15 +128,15 @@ You can learn more on the [Output](/openapi-ts/configuration/output) page.
 
 ```js [path]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: 'src/client', // [!code ++]
 };
 ```
 
 <!-- prettier-ignore-start -->
 ```js [object]
 export default {
-  input: 'https://get.heyapi.dev/hey-api/backend',
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: { // [!code ++]
     path: 'src/client', // [!code ++]
     // ...other options // [!code ++]