@grafana/openapi-to-k6 0.2.5 → 0.3.0

package/examples/basic_schema/split/k6-script.sample.ts

@@ -1,11 +1,12 @@
 import { SimpleAPIClient } from './simpleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new SimpleAPIClient({ baseUrl })
+const simpleAPIClient = new SimpleAPIClient({ baseUrl })
 
 export default function () {
   /**
    * Retrieve example data
    */
-  const getExampleResponseData = client.getExample()
+
+  const getExampleResponseData = simpleAPIClient.getExample()
 }

package/examples/basic_schema/split/simpleAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Simple API
  * Service version: 1.0.0

package/examples/basic_schema/split/simpleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Simple API
  * Service version: 1.0.0

package/examples/basic_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Simple API
  * Service version: 1.0.0

package/examples/basic_schema/tags/k6-script.sample.ts

@@ -1,11 +1,12 @@
-import { SimpleAPIClient } from './simpleAPI.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new SimpleAPIClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
   /**
    * Retrieve example data
    */
-  const getExampleResponseData = client.getExample()
+
+  const getExampleResponseData = defaultClient.getExample()
 }

package/examples/basic_schema/tags/simpleAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Simple API
  * Service version: 1.0.0

package/examples/form_data_schema/schema.json

@@ -19,15 +19,18 @@
                   "file": {
                     "type": "string",
                     "format": "binary",
-                    "description": "File to upload"
+                    "description": "File to upload",
+                    "example": "example.pdf"
                   },
                   "description": {
                     "type": "string",
-                    "description": "Description of the file"
+                    "description": "Description of the file",
+                    "example": "Monthly report document"
                   },
                   "userId": {
                     "type": "string",
-                    "description": "User ID associated with the upload"
+                    "description": "User ID associated with the upload",
+                    "example": "user123"
                   }
                 },
                 "required": [

package/examples/form_data_schema/single/formDataAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form Data API
  * Service version: 1.0.0

package/examples/form_data_schema/single/k6-script.sample.ts

@@ -1,11 +1,19 @@
 import { FormDataAPIClient } from './formDataAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new FormDataAPIClient({ baseUrl })
+const formDataAPIClient = new FormDataAPIClient({ baseUrl })
 
 export default function () {
+  let postUploadBody
+
   /**
    * Upload files and data
    */
-  const postUploadResponseData = client.postUpload(postUploadBody)
+  postUploadBody = {
+    file: 'example.pdf',
+    description: 'Monthly report document',
+    userId: 'user123',
+  }
+
+  const postUploadResponseData = formDataAPIClient.postUpload(postUploadBody)
 }

package/examples/form_data_schema/split/formDataAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form Data API
  * Service version: 1.0.0

package/examples/form_data_schema/split/formDataAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form Data API
  * Service version: 1.0.0

package/examples/form_data_schema/split/k6-script.sample.ts

@@ -1,11 +1,19 @@
 import { FormDataAPIClient } from './formDataAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new FormDataAPIClient({ baseUrl })
+const formDataAPIClient = new FormDataAPIClient({ baseUrl })
 
 export default function () {
+  let postUploadBody
+
   /**
    * Upload files and data
    */
-  const postUploadResponseData = client.postUpload(postUploadBody)
+  postUploadBody = {
+    file: 'example.pdf',
+    description: 'Monthly report document',
+    userId: 'user123',
+  }
+
+  const postUploadResponseData = formDataAPIClient.postUpload(postUploadBody)
 }

package/examples/form_data_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form Data API
  * Service version: 1.0.0

package/examples/form_data_schema/tags/formDataAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form Data API
  * Service version: 1.0.0

package/examples/form_data_schema/tags/k6-script.sample.ts

@@ -1,11 +1,19 @@
-import { FormDataAPIClient } from './formDataAPI.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new FormDataAPIClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
+  let postUploadBody
+
   /**
    * Upload files and data
    */
-  const postUploadResponseData = client.postUpload(postUploadBody)
+  postUploadBody = {
+    file: 'example.pdf',
+    description: 'Monthly report document',
+    userId: 'user123',
+  }
+
+  const postUploadResponseData = defaultClient.postUpload(postUploadBody)
 }

package/examples/form_url_encoded_data_schema/schema.json

@@ -18,16 +18,19 @@
                 "properties": {
                   "name": {
                     "type": "string",
-                    "description": "Name of the user"
+                    "description": "Name of the user",
+                    "example": "John Doe"
                   },
                   "age": {
                     "type": "integer",
-                    "description": "Age of the user"
+                    "description": "Age of the user",
+                    "example": 25
                   },
                   "email": {
                     "type": "string",
                     "format": "email",
-                    "description": "Email address of the user"
+                    "description": "Email address of the user",
+                    "example": "john.doe@example.com"
                   }
                 },
                 "required": [

package/examples/form_url_encoded_data_schema/single/formURLEncodedAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API
  * Service version: 1.0.0

package/examples/form_url_encoded_data_schema/single/k6-script.sample.ts

@@ -1,11 +1,20 @@
 import { FormURLEncodedAPIClient } from './formURLEncodedAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new FormURLEncodedAPIClient({ baseUrl })
+const formURLEncodedAPIClient = new FormURLEncodedAPIClient({ baseUrl })
 
 export default function () {
+  let postSubmitFormBody
+
   /**
    * Submit form data
    */
-  const postSubmitFormResponseData = client.postSubmitForm(postSubmitFormBody)
+  postSubmitFormBody = {
+    name: 'John Doe',
+    age: '25',
+    email: 'john.doe@example.com',
+  }
+
+  const postSubmitFormResponseData =
+    formURLEncodedAPIClient.postSubmitForm(postSubmitFormBody)
 }

package/examples/form_url_encoded_data_schema/split/formURLEncodedAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API
  * Service version: 1.0.0

package/examples/form_url_encoded_data_schema/split/formURLEncodedAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API
  * Service version: 1.0.0

package/examples/form_url_encoded_data_schema/split/k6-script.sample.ts

@@ -1,11 +1,20 @@
 import { FormURLEncodedAPIClient } from './formURLEncodedAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new FormURLEncodedAPIClient({ baseUrl })
+const formURLEncodedAPIClient = new FormURLEncodedAPIClient({ baseUrl })
 
 export default function () {
+  let postSubmitFormBody
+
   /**
    * Submit form data
    */
-  const postSubmitFormResponseData = client.postSubmitForm(postSubmitFormBody)
+  postSubmitFormBody = {
+    name: 'John Doe',
+    age: '25',
+    email: 'john.doe@example.com',
+  }
+
+  const postSubmitFormResponseData =
+    formURLEncodedAPIClient.postSubmitForm(postSubmitFormBody)
 }

package/examples/form_url_encoded_data_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API
  * Service version: 1.0.0

package/examples/form_url_encoded_data_schema/tags/formURLEncodedAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API
  * Service version: 1.0.0

package/examples/form_url_encoded_data_schema/tags/k6-script.sample.ts

@@ -1,11 +1,20 @@
-import { FormURLEncodedAPIClient } from './formURLEncodedAPI.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new FormURLEncodedAPIClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
+  let postSubmitFormBody
+
   /**
    * Submit form data
    */
-  const postSubmitFormResponseData = client.postSubmitForm(postSubmitFormBody)
+  postSubmitFormBody = {
+    name: 'John Doe',
+    age: '25',
+    email: 'john.doe@example.com',
+  }
+
+  const postSubmitFormResponseData =
+    defaultClient.postSubmitForm(postSubmitFormBody)
 }

package/examples/form_url_encoded_data_with_query_params_schema/schema.json

@@ -16,7 +16,8 @@
             "required": true,
             "description": "Authentication token",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "Bearer abcdef12345"
             }
           },
           {
@@ -39,16 +40,19 @@
                 "properties": {
                   "name": {
                     "type": "string",
-                    "description": "Name of the user"
+                    "description": "Name of the user",
+                    "example": "John Doe"
                   },
                   "age": {
                     "type": "integer",
-                    "description": "Age of the user"
+                    "description": "Age of the user",
+                    "example": 25
                   },
                   "email": {
                     "type": "string",
                     "format": "email",
-                    "description": "Email address of the user"
+                    "description": "Email address of the user",
+                    "example": "john.doe@example.com"
                   }
                 },
                 "required": [

package/examples/form_url_encoded_data_with_query_params_schema/single/formURLEncodedAPIWithQueryParameters.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API with Query Parameters
  * Service version: 1.0.0

package/examples/form_url_encoded_data_with_query_params_schema/single/k6-script.sample.ts

@@ -1,14 +1,27 @@
-import { FormURLEncodedAPIwithQueryParametersClient } from './formURLEncodedAPIWithQueryParameters.ts'
+import { FormURLEncodedAPIWithQueryParametersClient } from './formURLEncodedAPIWithQueryParameters.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new FormURLEncodedAPIwithQueryParametersClient({ baseUrl })
+const formURLEncodedAPIWithQueryParametersClient =
+  new FormURLEncodedAPIWithQueryParametersClient({ baseUrl })
 
 export default function () {
+  let postSubmitFormBody, params
+
   /**
    * Submit form data with query parameters
    */
-  const postSubmitFormResponseData = client.postSubmitForm(
-    postSubmitFormBody,
-    params
-  )
+  postSubmitFormBody = {
+    name: 'John Doe',
+    age: '25',
+    email: 'john.doe@example.com',
+  }
+  params = {
+    token: 'Bearer abcdef12345',
+  }
+
+  const postSubmitFormResponseData =
+    formURLEncodedAPIWithQueryParametersClient.postSubmitForm(
+      postSubmitFormBody,
+      params
+    )
 }

package/examples/form_url_encoded_data_with_query_params_schema/split/formURLEncodedAPIWithQueryParameters.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API with Query Parameters
  * Service version: 1.0.0

package/examples/form_url_encoded_data_with_query_params_schema/split/formURLEncodedAPIWithQueryParameters.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API with Query Parameters
  * Service version: 1.0.0

package/examples/form_url_encoded_data_with_query_params_schema/split/k6-script.sample.ts

@@ -1,14 +1,27 @@
-import { FormURLEncodedAPIwithQueryParametersClient } from './formURLEncodedAPIWithQueryParameters.ts'
+import { FormURLEncodedAPIWithQueryParametersClient } from './formURLEncodedAPIWithQueryParameters.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new FormURLEncodedAPIwithQueryParametersClient({ baseUrl })
+const formURLEncodedAPIWithQueryParametersClient =
+  new FormURLEncodedAPIWithQueryParametersClient({ baseUrl })
 
 export default function () {
+  let postSubmitFormBody, params
+
   /**
    * Submit form data with query parameters
    */
-  const postSubmitFormResponseData = client.postSubmitForm(
-    postSubmitFormBody,
-    params
-  )
+  postSubmitFormBody = {
+    name: 'John Doe',
+    age: '25',
+    email: 'john.doe@example.com',
+  }
+  params = {
+    token: 'Bearer abcdef12345',
+  }
+
+  const postSubmitFormResponseData =
+    formURLEncodedAPIWithQueryParametersClient.postSubmitForm(
+      postSubmitFormBody,
+      params
+    )
 }

package/examples/form_url_encoded_data_with_query_params_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API with Query Parameters
  * Service version: 1.0.0

package/examples/form_url_encoded_data_with_query_params_schema/tags/formURLEncodedAPIWithQueryParameters.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Form URL Encoded API with Query Parameters
  * Service version: 1.0.0

package/examples/form_url_encoded_data_with_query_params_schema/tags/k6-script.sample.ts

@@ -1,13 +1,24 @@
-import { FormURLEncodedAPIwithQueryParametersClient } from './formURLEncodedAPIWithQueryParameters.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new FormURLEncodedAPIwithQueryParametersClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
+  let postSubmitFormBody, params
+
   /**
    * Submit form data with query parameters
    */
-  const postSubmitFormResponseData = client.postSubmitForm(
+  postSubmitFormBody = {
+    name: 'John Doe',
+    age: '25',
+    email: 'john.doe@example.com',
+  }
+  params = {
+    token: 'Bearer abcdef12345',
+  }
+
+  const postSubmitFormResponseData = defaultClient.postSubmitForm(
     postSubmitFormBody,
     params
   )

package/examples/get_request_with_path_parameters_schema/schema.json

@@ -18,7 +18,8 @@
             "required": true,
             "description": "ID of the item to retrieve",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "12345"
             }
           }
         ],

package/examples/get_request_with_path_parameters_schema/single/k6-script.sample.ts

@@ -1,11 +1,15 @@
 import { SimpleAPIClient } from './simpleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new SimpleAPIClient({ baseUrl })
+const simpleAPIClient = new SimpleAPIClient({ baseUrl })
 
 export default function () {
+  let id
+
   /**
    * Get an item by its ID
    */
-  const getItemByIdResponseData = client.getItemById(id)
+  id = '12345'
+
+  const getItemByIdResponseData = simpleAPIClient.getItemById(id)
 }

package/examples/get_request_with_path_parameters_schema/single/simpleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter

package/examples/get_request_with_path_parameters_schema/split/k6-script.sample.ts

@@ -1,11 +1,15 @@
 import { SimpleAPIClient } from './simpleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new SimpleAPIClient({ baseUrl })
+const simpleAPIClient = new SimpleAPIClient({ baseUrl })
 
 export default function () {
+  let id
+
   /**
    * Get an item by its ID
    */
-  const getItemByIdResponseData = client.getItemById(id)
+  id = '12345'
+
+  const getItemByIdResponseData = simpleAPIClient.getItemById(id)
 }

package/examples/get_request_with_path_parameters_schema/split/simpleAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter

package/examples/get_request_with_path_parameters_schema/split/simpleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter

package/examples/get_request_with_path_parameters_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter

package/examples/get_request_with_path_parameters_schema/tags/k6-script.sample.ts

@@ -1,11 +1,15 @@
-import { SimpleAPIClient } from './simpleAPI.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new SimpleAPIClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
+  let id
+
   /**
    * Get an item by its ID
    */
-  const getItemByIdResponseData = client.getItemById(id)
+  id = '12345'
+
+  const getItemByIdResponseData = defaultClient.getItemById(id)
 }

package/examples/get_request_with_path_parameters_schema/tags/simpleAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter

package/examples/headers_schema/schema.json

@@ -74,7 +74,8 @@
                 "type": "object",
                 "properties": {
                   "data": {
-                    "type": "string"
+                    "type": "string",
+                    "example": "redevelop"
                   }
                 }
               }

package/examples/headers_schema/single/headerDemoAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Header Demo API
  * An API demonstrating the use of headers in different ways