@grafana/openapi-to-k6 0.2.6 → 0.3.1

package/examples/form_data_schema/single/formDataAPI.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 Data API
  * Service version: 1.0.0
@@ -9,20 +9,20 @@ 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 PostUpload400 = {
-  error?: string
   success?: boolean
+  error?: string
 }
 
 export type PostUpload200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
 export type PostUploadBody = {
-  /** Description of the file */
-  description?: string
   /** File to upload */
   file: Blob
+  /** Description of the file */
+  description?: string
   /** User ID associated with the upload */
   userId: string
 }
@@ -39,6 +39,8 @@ export class FormDataAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -67,8 +69,8 @@ export class FormDataAPIClient {
     const response = http.request('POST', url.toString(), formData.body(), {
       ...mergedRequestParameters,
       headers: {
-        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
         ...mergedRequestParameters?.headers,
+        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
       },
     })
     let data

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,24 +1,24 @@
 /**
- * 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 Data API
  * Service version: 1.0.0
  */
 export type PostUpload400 = {
-  error?: string
   success?: boolean
+  error?: string
 }
 
 export type PostUpload200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
 export type PostUploadBody = {
-  /** Description of the file */
-  description?: string
   /** File to upload */
   file: Blob
+  /** Description of the file */
+  description?: string
   /** User ID associated with the upload */
   userId: string
 }

package/examples/form_data_schema/split/formDataAPI.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 Data API
  * Service version: 1.0.0
@@ -22,6 +22,8 @@ export class FormDataAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -50,8 +52,8 @@ export class FormDataAPIClient {
     const response = http.request('POST', url.toString(), formData.body(), {
       ...mergedRequestParameters,
       headers: {
-        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
         ...mergedRequestParameters?.headers,
+        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
       },
     })
     let data

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.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Form Data API
  * Service version: 1.0.0
@@ -22,6 +22,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -50,8 +52,8 @@ export class DefaultClient {
     const response = http.request('POST', url.toString(), formData.body(), {
       ...mergedRequestParameters,
       headers: {
-        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
         ...mergedRequestParameters?.headers,
+        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
       },
     })
     let data

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

@@ -1,24 +1,24 @@
 /**
- * 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 Data API
  * Service version: 1.0.0
  */
 export type PostUpload400 = {
-  error?: string
   success?: boolean
+  error?: string
 }
 
 export type PostUpload200 = {
-  message?: string
   success?: boolean
+  message?: string
 }
 
 export type PostUploadBody = {
-  /** Description of the file */
-  description?: string
   /** File to upload */
   file: Blob
+  /** Description of the file */
+  description?: string
   /** User ID associated with the upload */
   userId: string
 }

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

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,24 +1,24 @@
 /**
- * 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
  * 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
 }

package/examples/form_url_encoded_data_schema/split/formURLEncodedAPI.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
  * Service version: 1.0.0
@@ -24,6 +24,8 @@ export class FormURLEncodedAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -49,8 +51,8 @@ export class FormURLEncodedAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/x-www-form-urlencoded',
         },
       }
     )

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.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Form URL Encoded API
  * Service version: 1.0.0
@@ -24,6 +24,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -49,8 +51,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_schema/tags/formURLEncodedAPI.schemas.ts

@@ -1,24 +1,24 @@
 /**
- * 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
  * 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
 }

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.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
@@ -8,22 +8,22 @@ import { URL, URLSearchParams } 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 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 = {
@@ -49,6 +49,8 @@ export class FormURLEncodedAPIWithQueryParametersClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -79,8 +81,8 @@ export class FormURLEncodedAPIWithQueryParametersClient {
       {
         ...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/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,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/split/formURLEncodedAPIWithQueryParameters.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 FormURLEncodedAPIWithQueryParametersClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -55,8 +57,8 @@ export class FormURLEncodedAPIWithQueryParametersClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/x-www-form-urlencoded',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/x-www-form-urlencoded',
         },
       }
     )