ref: update provider docs

jianyuan · May 26, 2024 · 25638c6 · 25638c6
1 parent 97dcb09
commit 25638c6
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -3,18 +3,21 @@
 page_title: "openai Provider"
 subcategory: ""
 description: |-
-  
+  The OpenAI provider allows you to configure resources and data sources for your OpenAI organization. It uses internal APIs, so breaking changes are expected.
+  Unfortunately, OpenAI's API keys do not allow some functionalities. Therefore, we need to obtain an OpenAI session key from the Authorization header of any requests to https://api.openai.com/dashboard/*. Log in to https://platform.openai.com, use Inspect Element to look for any requests to https://api.openai.com/dashboard/*, and grab the Authorization header value.
 ---
 
 # openai Provider
 
+The OpenAI provider allows you to configure resources and data sources for your OpenAI organization. It uses internal APIs, so breaking changes are expected.
 
+Unfortunately, OpenAI's API keys do not allow some functionalities. Therefore, we need to obtain an OpenAI session key from the `Authorization` header of any requests to `https://api.openai.com/dashboard/*`. Log in to https://platform.openai.com, use Inspect Element to look for any requests to `https://api.openai.com/dashboard/*`, and grab the `Authorization` header value.
 
 ## Example Usage
 
 ```terraform
 provider "openai" {
-  # example configuration here
+  session_key = "sess-0000000000000000000000000000000000000000"
 }
 ```
 
@@ -24,4 +27,4 @@ provider "openai" {
 ### Optional
 
 - `base_url` (String) Base URL for the OpenAI API. Defaults to `https://api.openai.com`.
-- `session_key` (String, Sensitive) Session key for the OpenAI API.
+- `session_key` (String, Sensitive) The OpenAI session key can be obtained by accessing the dashboard in your browser. This can also be set via the `OPENAI_SESSION_KEY` environment variable. Note that the session key must start with `sess-`.
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,3 +1,3 @@
 provider "openai" {
-  # example configuration here
+  session_key = "sess-0000000000000000000000000000000000000000"
 }
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -40,13 +40,15 @@ func (p *OpenAIProvider) Metadata(ctx context.Context, req provider.MetadataRequ
 
 func (p *OpenAIProvider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) {
 	resp.Schema = schema.Schema{
+		MarkdownDescription: "The OpenAI provider allows you to configure resources and data sources for your OpenAI organization. It uses internal APIs, so breaking changes are expected.\n\n" +
+			"Unfortunately, OpenAI's API keys do not allow some functionalities. Therefore, we need to obtain an OpenAI session key from the `Authorization` header of any requests to `https://api.openai.com/dashboard/*`. Log in to https://platform.openai.com, use Inspect Element to look for any requests to `https://api.openai.com/dashboard/*`, and grab the `Authorization` header value.",
 		Attributes: map[string]schema.Attribute{
 			"base_url": schema.StringAttribute{
 				MarkdownDescription: "Base URL for the OpenAI API. Defaults to `https://api.openai.com`.",
 				Optional:            true,
 			},
 			"session_key": schema.StringAttribute{
-				MarkdownDescription: "Session key for the OpenAI API.",
+				MarkdownDescription: "The OpenAI session key can be obtained by accessing the dashboard in your browser. This can also be set via the `OPENAI_SESSION_KEY` environment variable. Note that the session key must start with `sess-`.",
 				Optional:            true,
 				Sensitive:           true,
 			},