chore: show deprecation notice on re-export (#368)

openai · Oct 11, 2023 · b176703 · b176703
1 parent 6484039
commit b176703
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -297,7 +297,7 @@ await openai.models.list({
 
 ## Semantic Versioning
 
-This package generally attempts to follow [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
 
 1. Changes that only affect static types, without breaking runtime behavior.
 2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.

diff --git a/src/resources/chat/chat.ts b/src/resources/chat/chat.ts
@@ -14,6 +14,9 @@ export namespace Chat {
   export import ChatCompletionMessage = CompletionsAPI.ChatCompletionMessage;
   export import ChatCompletionMessageParam = CompletionsAPI.ChatCompletionMessageParam;
   export import ChatCompletionRole = CompletionsAPI.ChatCompletionRole;
+  /**
+   * @deprecated ChatCompletionMessageParam should be used instead
+   */
   export import CreateChatCompletionRequestMessage = CompletionsAPI.CreateChatCompletionRequestMessage;
   export import ChatCompletionCreateParams = CompletionsAPI.ChatCompletionCreateParams;
   export import CompletionCreateParams = CompletionsAPI.CompletionCreateParams;

diff --git a/src/resources/chat/completions.ts b/src/resources/chat/completions.ts
@@ -509,6 +509,9 @@ export namespace Completions {
   export import ChatCompletionMessage = ChatCompletionsAPI.ChatCompletionMessage;
   export import ChatCompletionMessageParam = ChatCompletionsAPI.ChatCompletionMessageParam;
   export import ChatCompletionRole = ChatCompletionsAPI.ChatCompletionRole;
+  /**
+   * @deprecated ChatCompletionMessageParam should be used instead
+   */
   export import CreateChatCompletionRequestMessage = ChatCompletionsAPI.CreateChatCompletionRequestMessage;
   export import ChatCompletionCreateParams = ChatCompletionsAPI.ChatCompletionCreateParams;
   export import CompletionCreateParams = ChatCompletionsAPI.CompletionCreateParams;