这是indexloc提供的服务，不要输入任何密码
Skip to content

Add ReadMe API Registry input support #2485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 20, 2025
Merged

Add ReadMe API Registry input support #2485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
48636ae
feat: add ReadMe API Registry utility functions
bombillazo Aug 20, 2025
1a35b77
feat: integrate ReadMe input format in configuration
bombillazo Aug 20, 2025
dbd0a6a
docs: update documentation for ReadMe API Registry support
bombillazo Aug 20, 2025
77c54c7
chore: fix typos in comments
bombillazo Aug 20, 2025
e074a36
Create soft-wolves-develop.md
mrlubos Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/soft-wolves-develop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@hey-api/openapi-ts": patch
---

feat(parser): input supports ReadMe API Registry with `readme:` prefix
36 changes: 36 additions & 0 deletions docs/openapi-ts/configuration/input.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,42 @@ export default {
If you use an HTTPS URL with a self-signed certificate in development, you will need to set [`NODE_TLS_REJECT_UNAUTHORIZED=0`](https://github.com/hey-api/openapi-ts/issues/276#issuecomment-2043143501) in your environment.
:::

### ReadMe API Registry

You can use ReadMe API Registry UUIDs to fetch OpenAPI specifications directly from ReadMe's platform. This is useful when API providers use ReadMe as their source of truth for API documentation.

::: code-group

```js [simple format]
export default {
input: 'readme:abc123def456', // [!code ++]
};
```

```js [full format]
export default {
input: 'readme:@organization/project#abc123def456', // [!code ++]
};
```

```js [object format]
export default {
input: {
path: 'readme:abc123def456', // [!code ++]
// ...other options
},
};
```

:::

The ReadMe input formats are:

- `readme:uuid` - Simple format using only the UUID
- `readme:@organization/project#uuid` - Full format including organization and project names

Both formats will fetch the OpenAPI specification from `https://dash.readme.com/api/v1/api-registry/{uuid}`.

### Hey API Platform options

You might want to use the [Hey API Platform](/openapi-ts/integrations) to store your specifications. If you do so, the `input` object provides options to help with constructing the correct URL.
Expand Down
232 changes: 116 additions & 116 deletions examples/openapi-ts-openai/src/client/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,48 +194,48 @@ export type AssistantStreamEvent =
} & ErrorEvent);

export const AssistantSupportedModels = {
GPT_3_5_TURBO: 'gpt-3.5-turbo',
GPT_3_5_TURBO_0125: 'gpt-3.5-turbo-0125',
GPT_3_5_TURBO_0613: 'gpt-3.5-turbo-0613',
GPT_3_5_TURBO_1106: 'gpt-3.5-turbo-1106',
GPT_3_5_TURBO_16K: 'gpt-3.5-turbo-16k',
GPT_3_5_TURBO_16K_0613: 'gpt-3.5-turbo-16k-0613',
GPT_4: 'gpt-4',
GPT_4O: 'gpt-4o',
GPT_4O_2024_05_13: 'gpt-4o-2024-05-13',
GPT_4O_2024_08_06: 'gpt-4o-2024-08-06',
GPT_4O_2024_11_20: 'gpt-4o-2024-11-20',
GPT_4_1: 'gpt-4.1',
GPT_4O_MINI: 'gpt-4o-mini',
GPT_4_1_2025_04_14: 'gpt-4.1-2025-04-14',
GPT_4O_MINI_2024_07_18: 'gpt-4o-mini-2024-07-18',
GPT_4_1_MINI: 'gpt-4.1-mini',
GPT_4_0125_PREVIEW: 'gpt-4-0125-preview',
GPT_4_1_MINI_2025_04_14: 'gpt-4.1-mini-2025-04-14',
GPT_4: 'gpt-4',
GPT_4_1_NANO: 'gpt-4.1-nano',
GPT_4_0314: 'gpt-4-0314',
GPT_5: 'gpt-5',
GPT_4_0613: 'gpt-4-0613',
GPT_5_2025_08_07: 'gpt-5-2025-08-07',
GPT_3_5_TURBO: 'gpt-3.5-turbo',
GPT_5_MINI: 'gpt-5-mini',
GPT_3_5_TURBO_0613: 'gpt-3.5-turbo-0613',
GPT_5_MINI_2025_08_07: 'gpt-5-mini-2025-08-07',
GPT_3_5_TURBO_0125: 'gpt-3.5-turbo-0125',
GPT_5_NANO: 'gpt-5-nano',
GPT_3_5_TURBO_1106: 'gpt-3.5-turbo-1106',
GPT_3_5_TURBO_16K: 'gpt-3.5-turbo-16k',
GPT_5_NANO_2025_08_07: 'gpt-5-nano-2025-08-07',
GPT_3_5_TURBO_16K_0613: 'gpt-3.5-turbo-16k-0613',
GPT_4_1_NANO_2025_04_14: 'gpt-4.1-nano-2025-04-14',
GPT_4_1: 'gpt-4.1',
GPT_4_1106_PREVIEW: 'gpt-4-1106-preview',
O1: 'o1',
GPT_4_1_2025_04_14: 'gpt-4.1-2025-04-14',
GPT_4_1_MINI: 'gpt-4.1-mini',
GPT_4_1_MINI_2025_04_14: 'gpt-4.1-mini-2025-04-14',
GPT_4_1_NANO: 'gpt-4.1-nano',
GPT_4_1_NANO_2025_04_14: 'gpt-4.1-nano-2025-04-14',
GPT_4_32K: 'gpt-4-32k',
O3_MINI: 'o3-mini',
GPT_4_32K_0314: 'gpt-4-32k-0314',
O3_MINI_2025_01_31: 'o3-mini-2025-01-31',
GPT_4_32K_0613: 'gpt-4-32k-0613',
O1_2024_12_17: 'o1-2024-12-17',
GPT_4_5_PREVIEW: 'gpt-4.5-preview',
GPT_4_5_PREVIEW_2025_02_27: 'gpt-4.5-preview-2025-02-27',
GPT_4_TURBO: 'gpt-4-turbo',
GPT_4_TURBO_2024_04_09: 'gpt-4-turbo-2024-04-09',
GPT_4_TURBO_PREVIEW: 'gpt-4-turbo-preview',
GPT_4_VISION_PREVIEW: 'gpt-4-vision-preview',
GPT_5: 'gpt-5',
GPT_5_2025_08_07: 'gpt-5-2025-08-07',
GPT_5_MINI: 'gpt-5-mini',
GPT_5_MINI_2025_08_07: 'gpt-5-mini-2025-08-07',
GPT_5_NANO: 'gpt-5-nano',
GPT_5_NANO_2025_08_07: 'gpt-5-nano-2025-08-07',
O1: 'o1',
O1_2024_12_17: 'o1-2024-12-17',
O3_MINI: 'o3-mini',
O3_MINI_2025_01_31: 'o3-mini-2025-01-31',
} as const;

export type AssistantSupportedModels =
Expand Down Expand Up @@ -702,38 +702,58 @@ export type AuditLog = {
/**
* The details for events with this `type`.
*/
'user.added'?: {
/**
* The user ID.
*/
id?: string;
'rate_limit.updated'?: {
/**
* The payload used to add the user to the project.
* The payload used to update the rate limits.
*/
data?: {
changes_requested?: {
/**
* The role of the user. Is either `owner` or `member`.
* The maximum batch input tokens per day. Only relevant for certain models.
*/
role?: string;
batch_1_day_max_input_tokens?: number;
/**
* The maximum audio megabytes per minute. Only relevant for certain models.
*/
max_audio_megabytes_per_1_minute?: number;
/**
* The maximum images per minute. Only relevant for certain models.
*/
max_images_per_1_minute?: number;
/**
* The maximum requests per day. Only relevant for certain models.
*/
max_requests_per_1_day?: number;
/**
* The maximum requests per minute.
*/
max_requests_per_1_minute?: number;
/**
* The maximum tokens per minute.
*/
max_tokens_per_1_minute?: number;
};
/**
* The rate limit ID
*/
id?: string;
};
/**
* The details for events with this `type`.
*/
'user.updated'?: {
/**
* The project ID.
*/
id?: string;
'service_account.created'?: {
/**
* The payload used to update the user.
* The payload used to create the service account.
*/
changes_requested?: {
data?: {
/**
* The role of the user. Is either `owner` or `member`.
* The role of the service account. Is either `owner` or `member`.
*/
role?: string;
};
/**
* The service account ID.
*/
id?: string;
};
/**
* The details for events with this `type`.
Expand Down Expand Up @@ -762,69 +782,49 @@ export type AuditLog = {
*/
id?: string;
};
type: AuditLogEventType;
/**
* The details for events with this `type`.
*/
'rate_limit.updated'?: {
'user.added'?: {
/**
* The payload used to update the rate limits.
* The payload used to add the user to the project.
*/
changes_requested?: {
/**
* The maximum requests per minute.
*/
max_requests_per_1_minute?: number;
/**
* The maximum tokens per minute.
*/
max_tokens_per_1_minute?: number;
/**
* The maximum images per minute. Only relevant for certain models.
*/
max_images_per_1_minute?: number;
/**
* The maximum audio megabytes per minute. Only relevant for certain models.
*/
max_audio_megabytes_per_1_minute?: number;
/**
* The maximum requests per day. Only relevant for certain models.
*/
max_requests_per_1_day?: number;
data?: {
/**
* The maximum batch input tokens per day. Only relevant for certain models.
* The role of the user. Is either `owner` or `member`.
*/
batch_1_day_max_input_tokens?: number;
role?: string;
};
/**
* The rate limit ID
* The user ID.
*/
id?: string;
};
type: AuditLogEventType;
/**
* The details for events with this `type`.
*/
'service_account.created'?: {
/**
* The payload used to create the service account.
*/
data?: {
/**
* The role of the service account. Is either `owner` or `member`.
*/
role?: string;
};
'user.deleted'?: {
/**
* The service account ID.
* The user ID.
*/
id?: string;
};
/**
* The details for events with this `type`.
*/
'user.deleted'?: {
'user.updated'?: {
/**
* The user ID.
* The payload used to update the user.
*/
changes_requested?: {
/**
* The role of the user. Is either `owner` or `member`.
*/
role?: string;
};
/**
* The project ID.
*/
id?: string;
};
Expand Down Expand Up @@ -18135,69 +18135,69 @@ export type MessageContentDelta =
} & MessageDeltaContentImageUrlObject);

export const ChatModel = {
GPT_4_1: 'gpt-4.1',
GPT_4_1_2025_04_14: 'gpt-4.1-2025-04-14',
GPT_4_1_MINI: 'gpt-4.1-mini',
GPT_4_1_MINI_2025_04_14: 'gpt-4.1-mini-2025-04-14',
GPT_4_1_NANO: 'gpt-4.1-nano',
CHATGPT_4O_LATEST: 'chatgpt-4o-latest',
CODEX_MINI_LATEST: 'codex-mini-latest',
GPT_3_5_TURBO: 'gpt-3.5-turbo',
GPT_3_5_TURBO_0125: 'gpt-3.5-turbo-0125',
GPT_3_5_TURBO_0301: 'gpt-3.5-turbo-0301',
GPT_3_5_TURBO_0613: 'gpt-3.5-turbo-0613',
GPT_3_5_TURBO_1106: 'gpt-3.5-turbo-1106',
GPT_3_5_TURBO_16K: 'gpt-3.5-turbo-16k',
GPT_3_5_TURBO_16K_0613: 'gpt-3.5-turbo-16k-0613',
GPT_4: 'gpt-4',
GPT_4O: 'gpt-4o',
GPT_4_1_NANO_2025_04_14: 'gpt-4.1-nano-2025-04-14',
GPT_4O_2024_08_06: 'gpt-4o-2024-08-06',
GPT_5: 'gpt-5',
GPT_4O_2024_05_13: 'gpt-4o-2024-05-13',
GPT_5_2025_08_07: 'gpt-5-2025-08-07',
GPT_4O_2024_08_06: 'gpt-4o-2024-08-06',
GPT_4O_2024_11_20: 'gpt-4o-2024-11-20',
GPT_5_CHAT_LATEST: 'gpt-5-chat-latest',
GPT_4O_AUDIO_PREVIEW: 'gpt-4o-audio-preview',
GPT_5_MINI: 'gpt-5-mini',
GPT_4O_AUDIO_PREVIEW_2024_10_01: 'gpt-4o-audio-preview-2024-10-01',
GPT_5_MINI_2025_08_07: 'gpt-5-mini-2025-08-07',
GPT_4O_AUDIO_PREVIEW_2024_12_17: 'gpt-4o-audio-preview-2024-12-17',
GPT_5_NANO: 'gpt-5-nano',
GPT_4O_AUDIO_PREVIEW_2025_06_03: 'gpt-4o-audio-preview-2025-06-03',
GPT_5_NANO_2025_08_07: 'gpt-5-nano-2025-08-07',
CHATGPT_4O_LATEST: 'chatgpt-4o-latest',
O1: 'o1',
CODEX_MINI_LATEST: 'codex-mini-latest',
O1_2024_12_17: 'o1-2024-12-17',
GPT_4O_MINI: 'gpt-4o-mini',
O1_MINI: 'o1-mini',
GPT_4O_MINI_2024_07_18: 'gpt-4o-mini-2024-07-18',
O3: 'o3',
GPT_4: 'gpt-4',
O3_2025_04_16: 'o3-2025-04-16',
GPT_4O_MINI_AUDIO_PREVIEW: 'gpt-4o-mini-audio-preview',
O4_MINI: 'o4-mini',
GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17: 'gpt-4o-mini-audio-preview-2024-12-17',
O4_MINI_2025_04_16: 'o4-mini-2025-04-16',
GPT_3_5_TURBO: 'gpt-3.5-turbo',
O3_MINI: 'o3-mini',
GPT_3_5_TURBO_0301: 'gpt-3.5-turbo-0301',
O3_MINI_2025_01_31: 'o3-mini-2025-01-31',
GPT_3_5_TURBO_0613: 'gpt-3.5-turbo-0613',
O1_PREVIEW: 'o1-preview',
GPT_3_5_TURBO_0125: 'gpt-3.5-turbo-0125',
O1_PREVIEW_2024_09_12: 'o1-preview-2024-09-12',
GPT_3_5_TURBO_1106: 'gpt-3.5-turbo-1106',
O1_MINI_2024_09_12: 'o1-mini-2024-09-12',
GPT_3_5_TURBO_16K: 'gpt-3.5-turbo-16k',
GPT_4O_MINI_SEARCH_PREVIEW: 'gpt-4o-mini-search-preview',
GPT_3_5_TURBO_16K_0613: 'gpt-3.5-turbo-16k-0613',
GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11:
'gpt-4o-mini-search-preview-2025-03-11',
GPT_4O_SEARCH_PREVIEW: 'gpt-4o-search-preview',
GPT_4O_SEARCH_PREVIEW_2025_03_11: 'gpt-4o-search-preview-2025-03-11',
GPT_4_0125_PREVIEW: 'gpt-4-0125-preview',
GPT_4_0314: 'gpt-4-0314',
GPT_4_0613: 'gpt-4-0613',
GPT_4_1: 'gpt-4.1',
GPT_4_1106_PREVIEW: 'gpt-4-1106-preview',
GPT_4_1_2025_04_14: 'gpt-4.1-2025-04-14',
GPT_4_1_MINI: 'gpt-4.1-mini',
GPT_4_1_MINI_2025_04_14: 'gpt-4.1-mini-2025-04-14',
GPT_4_1_NANO: 'gpt-4.1-nano',
GPT_4_1_NANO_2025_04_14: 'gpt-4.1-nano-2025-04-14',
GPT_4_32K: 'gpt-4-32k',
GPT_4_32K_0314: 'gpt-4-32k-0314',
GPT_4_32K_0613: 'gpt-4-32k-0613',
GPT_4_TURBO: 'gpt-4-turbo',
GPT_4_TURBO_2024_04_09: 'gpt-4-turbo-2024-04-09',
GPT_4_TURBO_PREVIEW: 'gpt-4-turbo-preview',
GPT_4_VISION_PREVIEW: 'gpt-4-vision-preview',
GPT_5: 'gpt-5',
GPT_5_2025_08_07: 'gpt-5-2025-08-07',
GPT_5_CHAT_LATEST: 'gpt-5-chat-latest',
GPT_5_MINI: 'gpt-5-mini',
GPT_5_MINI_2025_08_07: 'gpt-5-mini-2025-08-07',
GPT_5_NANO: 'gpt-5-nano',
GPT_5_NANO_2025_08_07: 'gpt-5-nano-2025-08-07',
O1: 'o1',
O1_2024_12_17: 'o1-2024-12-17',
O1_MINI: 'o1-mini',
O1_MINI_2024_09_12: 'o1-mini-2024-09-12',
O1_PREVIEW: 'o1-preview',
O1_PREVIEW_2024_09_12: 'o1-preview-2024-09-12',
O3: 'o3',
O3_2025_04_16: 'o3-2025-04-16',
O3_MINI: 'o3-mini',
O3_MINI_2025_01_31: 'o3-mini-2025-01-31',
O4_MINI: 'o4-mini',
O4_MINI_2025_04_16: 'o4-mini-2025-04-16',
} as const;

export type ChatModel = (typeof ChatModel)[keyof typeof ChatModel];
Expand Down
Loading
Loading