@grafana/openapi-to-k6 0.2.6 → 0.3.1

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.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Form URL Encoded API with Query Parameters
  * Service version: 1.0.0
@@ -25,6 +25,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -55,8 +57,8 @@ export class DefaultClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/x-www-form-urlencoded',
         },
       }
     )

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

@@ -1,26 +1,26 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Form URL Encoded API with Query Parameters
  * Service version: 1.0.0
  */
 export type PostSubmitForm400 = {
-  error?: string
   success?: boolean
+  error?: string
 }
 
 export type PostSubmitForm200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
 export type PostSubmitFormBody = {
+  /** Name of the user */
+  name: string
   /** Age of the user */
   age?: number
   /** Email address of the user */
   email: string
-  /** Name of the user */
-  name: string
 }
 
 export type PostSubmitFormParams = {

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.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter
@@ -9,9 +9,9 @@ import { URL } from 'https://jslib.k6.io/url/1.0.0/index.js'
 import http from 'k6/http'
 import type { Params, Response } from 'k6/http'
 export type GetItemById200 = {
-  description?: string
   id?: string
   name?: string
+  description?: string
 }
 
 /**
@@ -26,6 +26,8 @@ export class SimpleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

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,12 +1,12 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter
  * Service version: 1.0.0
  */
 export type GetItemById200 = {
-  description?: string
   id?: string
   name?: string
+  description?: string
 }

package/examples/get_request_with_path_parameters_schema/split/simpleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter
@@ -22,6 +22,8 @@ export class SimpleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

package/examples/get_request_with_path_parameters_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter
@@ -22,6 +22,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

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,12 +1,12 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Simple API
  * An API with a single GET request that takes a path parameter
  * Service version: 1.0.0
  */
 export type GetItemById200 = {
-  description?: string
   id?: string
   name?: string
+  description?: string
 }

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.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Header Demo API
  * An API demonstrating the use of headers in different ways
@@ -46,6 +46,8 @@ export class HeaderDemoAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -67,6 +69,7 @@ export class HeaderDemoAPIClient {
     const response = http.request('GET', url.toString(), undefined, {
       ...mergedRequestParameters,
       headers: {
+        ...mergedRequestParameters?.headers,
         // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
         ...Object.fromEntries(
           Object.entries(headers || {}).map(([key, value]) => [
@@ -74,7 +77,6 @@ export class HeaderDemoAPIClient {
             String(value),
           ])
         ),
-        ...mergedRequestParameters?.headers,
       },
     })
     let data
@@ -114,6 +116,7 @@ export class HeaderDemoAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
+          ...mergedRequestParameters?.headers,
           'Content-Type': 'application/json',
           // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
           ...Object.fromEntries(
@@ -122,7 +125,6 @@ export class HeaderDemoAPIClient {
               String(value),
             ])
           ),
-          ...mergedRequestParameters?.headers,
         },
       }
     )

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

@@ -1,18 +1,28 @@
 import { HeaderDemoAPIClient } from './headerDemoAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new HeaderDemoAPIClient({ baseUrl })
+const headerDemoAPIClient = new HeaderDemoAPIClient({ baseUrl })
 
 export default function () {
+  let postExamplePostBody, headers
+
   /**
    * GET request with headers
    */
-  const getExampleGetResponseData = client.getExampleGet()
+
+  const getExampleGetResponseData = headerDemoAPIClient.getExampleGet()
 
   /**
    * POST request with security headers
    */
-  const postExamplePostResponseData = client.postExamplePost(
+  postExamplePostBody = {
+    data: 'redevelop',
+  }
+  headers = {
+    Authorization: 'Bearer <token>',
+  }
+
+  const postExamplePostResponseData = headerDemoAPIClient.postExamplePost(
     postExamplePostBody,
     headers
   )
@@ -20,6 +30,7 @@ export default function () {
   /**
    * GET request with response headers only
    */
+
   const getExampleResponseHeadersResponseData =
-    client.getExampleResponseHeaders()
+    headerDemoAPIClient.getExampleResponseHeaders()
 }

package/examples/headers_schema/split/headerDemoAPI.schemas.ts

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

package/examples/headers_schema/split/headerDemoAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Header Demo API
  * An API demonstrating the use of headers in different ways
@@ -28,6 +28,8 @@ export class HeaderDemoAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -49,6 +51,7 @@ export class HeaderDemoAPIClient {
     const response = http.request('GET', url.toString(), undefined, {
       ...mergedRequestParameters,
       headers: {
+        ...mergedRequestParameters?.headers,
         // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
         ...Object.fromEntries(
           Object.entries(headers || {}).map(([key, value]) => [
@@ -56,7 +59,6 @@ export class HeaderDemoAPIClient {
             String(value),
           ])
         ),
-        ...mergedRequestParameters?.headers,
       },
     })
     let data
@@ -96,6 +98,7 @@ export class HeaderDemoAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
+          ...mergedRequestParameters?.headers,
           'Content-Type': 'application/json',
           // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
           ...Object.fromEntries(
@@ -104,7 +107,6 @@ export class HeaderDemoAPIClient {
               String(value),
             ])
           ),
-          ...mergedRequestParameters?.headers,
         },
       }
     )

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

@@ -1,18 +1,28 @@
 import { HeaderDemoAPIClient } from './headerDemoAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new HeaderDemoAPIClient({ baseUrl })
+const headerDemoAPIClient = new HeaderDemoAPIClient({ baseUrl })
 
 export default function () {
+  let postExamplePostBody, headers
+
   /**
    * GET request with headers
    */
-  const getExampleGetResponseData = client.getExampleGet()
+
+  const getExampleGetResponseData = headerDemoAPIClient.getExampleGet()
 
   /**
    * POST request with security headers
    */
-  const postExamplePostResponseData = client.postExamplePost(
+  postExamplePostBody = {
+    data: 'redevelop',
+  }
+  headers = {
+    Authorization: 'Bearer <token>',
+  }
+
+  const postExamplePostResponseData = headerDemoAPIClient.postExamplePost(
     postExamplePostBody,
     headers
   )
@@ -20,6 +30,7 @@ export default function () {
   /**
    * GET request with response headers only
    */
+
   const getExampleResponseHeadersResponseData =
-    client.getExampleResponseHeaders()
+    headerDemoAPIClient.getExampleResponseHeaders()
 }

package/examples/headers_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Header Demo API
  * An API demonstrating the use of headers in different ways
@@ -28,6 +28,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -49,6 +51,7 @@ export class DefaultClient {
     const response = http.request('GET', url.toString(), undefined, {
       ...mergedRequestParameters,
       headers: {
+        ...mergedRequestParameters?.headers,
         // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
         ...Object.fromEntries(
           Object.entries(headers || {}).map(([key, value]) => [
@@ -56,7 +59,6 @@ export class DefaultClient {
             String(value),
           ])
         ),
-        ...mergedRequestParameters?.headers,
       },
     })
     let data
@@ -95,6 +97,7 @@ export class DefaultClient {
       {
         ...mergedRequestParameters,
         headers: {
+          ...mergedRequestParameters?.headers,
           'Content-Type': 'application/json',
           // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string
           ...Object.fromEntries(
@@ -103,7 +106,6 @@ export class DefaultClient {
               String(value),
             ])
           ),
-          ...mergedRequestParameters?.headers,
         },
       }
     )

package/examples/headers_schema/tags/headerDemoAPI.schemas.ts

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

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

@@ -1,18 +1,28 @@
-import { HeaderDemoAPIClient } from './headerDemoAPI.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new HeaderDemoAPIClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
+  let postExamplePostBody, headers
+
   /**
    * GET request with headers
    */
-  const getExampleGetResponseData = client.getExampleGet()
+
+  const getExampleGetResponseData = defaultClient.getExampleGet()
 
   /**
    * POST request with security headers
    */
-  const postExamplePostResponseData = client.postExamplePost(
+  postExamplePostBody = {
+    data: 'redevelop',
+  }
+  headers = {
+    Authorization: 'Bearer <token>',
+  }
+
+  const postExamplePostResponseData = defaultClient.postExamplePost(
     postExamplePostBody,
     headers
   )
@@ -20,6 +30,7 @@ export default function () {
   /**
    * GET request with response headers only
    */
+
   const getExampleResponseHeadersResponseData =
-    client.getExampleResponseHeaders()
+    defaultClient.getExampleResponseHeaders()
 }

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

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

package/examples/no_title_schema/single/k6Client.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * K6Client
  * Service version: 1.0.0
@@ -23,6 +23,8 @@ export class K6ClientClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

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

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

package/examples/no_title_schema/split/k6Client.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * K6Client
  * Service version: 1.0.0

package/examples/no_title_schema/split/k6Client.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * K6Client
  * Service version: 1.0.0
@@ -21,6 +21,8 @@ export class K6ClientClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**

package/examples/no_title_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * K6Client
  * Service version: 1.0.0
@@ -21,6 +21,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**