Merge pull request #15 from G5andeepD/post-review-corrections

Post review corrections

README.md

@@ -47,11 +47,11 @@ import ballerinax/openai.images;
 Create a `images:ConnectionConfig` with the obtained API Key and initialize the connector.
 
 ```ballerina
-configurable string apiKey = ?;
+configurable string token= ?;
 
 final images:Client openAIImages = check new ({
     auth: {
-        token: apiKey
+        token
     }
 });
 ```

ballerina/Module.md

@@ -39,11 +39,11 @@ import ballerinax/openai.images;
 Create a `images:ConnectionConfig` with the obtained API Key and initialize the connector.
 
 ```ballerina
-configurable string apiKey = ?;
+configurable string token = ?;
 
 final images:Client openAIImages = check new ({
     auth: {
-        token: apiKey
+        token
     }
 });
 ```

ballerina/Package.md

@@ -39,11 +39,11 @@ import ballerinax/openai.images;
 Create a `images:ConnectionConfig` with the obtained API Key and initialize the connector.
 
 ```ballerina
-configurable string apiKey = ?;
+configurable string token = ?;
 
 final images:Client openAIImages = check new ({
     auth: {
-        token: apiKey
+        token
     }
 });
 ```

ballerina/tests/README.md

@@ -61,7 +61,7 @@ Create a `Config.toml` file in the `tests` directory and add your authentication
 
 ```toml
 isLiveServer = true
-apiKey = "<your-openAI-api-key>"
+token = "<your-openAI-api-key>"
 ```
 
 ### Using Environment Variables

ballerina/tests/tests.bal

@@ -18,12 +18,12 @@ import ballerina/os;
 import ballerina/test;
 
 configurable boolean isLiveServer = os:getEnv("IS_LIVE_SERVER") == "true";
-configurable string apiKey = isLiveServer ? os:getEnv("OPENAI_API_KEY") : "test";
+configurable string token = isLiveServer ? os:getEnv("OPENAI_API_KEY") : "test";
 configurable string serviceUrl = isLiveServer ? "https://api.openai.com/v1" : "http://localhost:9090";
 
 ConnectionConfig config = {
     auth: {
-        token: apiKey
+        token
     }
 };
 

docs/spec/sanitations.md

@@ -17,7 +17,7 @@ This document records the sanitation done on top of the official OpenAPI specifi
    - **Updated**:
       - Removed the `default` parameter 
 
-   - **Reason**: This change is done as a workaround for ballerina openapi tool not allowing to generate the client.
+   - **Reason**: This change is done as a temporary workaround until the Ballerina OpenAPI tool supports OpenAPI Specification version v3.1.x(Currently supported upto version 3.0.0)
 
 2. **Removed the `nullable: true` property of the field `n` from the below schemas**
 

examples/README.md

@@ -14,7 +14,7 @@ To get started, you'll need to have an OpenAI account and obtain an API key. Ref
 Create a `Config.toml` file in the example's root directory and provide your OpenAI account-related configurations as follows:
 
 ```toml
-apiKey = "<Your OpenAI API Key>"
+token = "<Your OpenAI API Key>"
 ```
 
 ## Running an example

examples/personalized-visual-content-generator/.github/README.md

@@ -11,7 +11,7 @@ To get started, you'll need to have an OpenAI account and obtain an API key. Ref
 Create a `Config.toml` file in the example's root directory and provide your OpenAI account-related configurations as follows:
 
 ```toml
-apiKey = "<Your OpenAI API Key>"
+token = "<Your OpenAI API Key>"
 ```
 
 ## Run the example

examples/personalized-visual-content-generator/Personalized visual content generator.md

@@ -11,7 +11,7 @@ To get started, you'll need to have an OpenAI account and obtain an API key. Ref
 Create a `Config.toml` file in the example's root directory and provide your OpenAI account-related configurations as follows:
 
 ```toml
-apiKey = "<Your OpenAI API Key>"
+token = "<Your OpenAI API Key>"
 ```
 
 ## Run the example

examples/personalized-visual-content-generator/main.bal

@@ -18,16 +18,15 @@ import ballerina/io;
 import ballerina/mime;
 import ballerinax/openai.images;
 
-configurable string apiKey = ?;
-
-// Initialize the OpenAI Images client with your API key
-final images:Client openaiClient = check new ({
-    auth: {
-        token: apiKey
-    }
-});
+configurable string token = ?;
 
 public function main() returns error? {
+    // Initialize the OpenAI Images client with your API key
+    final images:Client openaiClient = check new ({
+        auth: {
+            token
+        }
+    });
 
     io:println("Generating an image using the OpenAI API...");
     // Generate a base image using the `images/generation` API

examples/rapid-product-visualizer/.github/README.md

@@ -11,7 +11,7 @@ To get started, you'll need to have an OpenAI account and obtain an API key. Ref
 Create a `Config.toml` file in the example's root directory and provide your OpenAI account-related configurations as follows:
 
 ```toml
-apiKey = "<Your OpenAI API Key>"
+token = "<Your OpenAI API Key>"
 ```
 
 ## Run the example

examples/rapid-product-visualizer/Rapid product visualizer.md

@@ -11,7 +11,7 @@ To get started, you'll need to have an OpenAI account and obtain an API key. Ref
 Create a `Config.toml` file in the example's root directory and provide your OpenAI account-related configurations as follows:
 
 ```toml
-apiKey = "<Your OpenAI API Key>"
+token = "<Your OpenAI API Key>"
 ```
 
 ## Run the example

examples/rapid-product-visualizer/main.bal

@@ -18,17 +18,17 @@ import ballerina/io;
 import ballerina/mime;
 import ballerinax/openai.images;
 
-configurable string apiKey = ?;
-
-// Initialize the OpenAI Images client with your API key
-final images:Client openaiClient = check new ({
-    auth: {
-        token: apiKey
-    }
-});
+configurable string token = ?;
 
 public function main() returns error? {
 
+    // Initialize the OpenAI Images client with your API key
+    final images:Client openaiClient = check new ({
+        auth: {
+            token
+        }
+    });
+
     io:println("Generating a product image using the OpenAI API...");
     // Generate a base product image using the `images/generation` API
     string generationPrompt = "a sleek and modern smartphone with a curved screen and minimalist design";