@grafana/openapi-to-k6 0.2.6 → 0.3.0

package/examples/no_title_schema/tags/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.0
  * Do not edit manually.
  * K6Client
  * Service version: 1.0.0

package/examples/post_request_with_query_params/schema.json

@@ -17,7 +17,8 @@
             "in": "query",
             "required": true,
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "12345"
             },
             "description": "A string query parameter for user ID"
           },
@@ -26,7 +27,8 @@
             "in": "query",
             "required": false,
             "schema": {
-              "type": "boolean"
+              "type": "boolean",
+              "example": true
             },
             "description": "A boolean query parameter"
           }
@@ -40,7 +42,8 @@
                 "properties": {
                   "data": {
                     "type": "string",
-                    "description": "A string field representing data"
+                    "description": "A string field representing data",
+                    "example": "data"
                   }
                 },
                 "required": [
@@ -60,19 +63,23 @@
                   "properties": {
                     "userId": {
                       "type": "string",
-                      "description": "The user ID from the query parameter"
+                      "description": "The user ID from the query parameter",
+                      "example": "12345"
                     },
                     "isActive": {
                       "type": "boolean",
-                      "description": "The active status from the query parameter"
+                      "description": "The active status from the query parameter",
+                      "example": true
                     },
                     "data": {
                       "type": "string",
-                      "description": "The data from the body"
+                      "description": "The data from the body",
+                      "example": "data"
                     },
                     "status": {
                       "type": "string",
-                      "description": "Response status"
+                      "description": "Response status",
+                      "example": "success"
                     }
                   }
                 }

package/examples/post_request_with_query_params/single/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with a POST request having an object as the body and query parameters

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

@@ -1,13 +1,22 @@
 import { ExampleAPIClient } from './exampleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const exampleAPIClient = new ExampleAPIClient({ baseUrl })
 
 export default function () {
+  let createExampleDataBody, params
+
   /**
    * Create example data
    */
-  const createExampleDataResponseData = client.createExampleData(
+  createExampleDataBody = {
+    data: 'data',
+  }
+  params = {
+    userId: '12345',
+  }
+
+  const createExampleDataResponseData = exampleAPIClient.createExampleData(
     createExampleDataBody,
     params
   )

package/examples/post_request_with_query_params/split/exampleAPI.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.0
  * Do not edit manually.
  * Example API
  * API with a POST request having an object as the body and query parameters

package/examples/post_request_with_query_params/split/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with a POST request having an object as the body and query parameters

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

@@ -1,13 +1,22 @@
 import { ExampleAPIClient } from './exampleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const exampleAPIClient = new ExampleAPIClient({ baseUrl })
 
 export default function () {
+  let createExampleDataBody, params
+
   /**
    * Create example data
    */
-  const createExampleDataResponseData = client.createExampleData(
+  createExampleDataBody = {
+    data: 'data',
+  }
+  params = {
+    userId: '12345',
+  }
+
+  const createExampleDataResponseData = exampleAPIClient.createExampleData(
     createExampleDataBody,
     params
   )

package/examples/post_request_with_query_params/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.0
  * Do not edit manually.
  * Example API
  * API with a POST request having an object as the body and query parameters

package/examples/post_request_with_query_params/tags/exampleAPI.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.0
  * Do not edit manually.
  * Example API
  * API with a POST request having an object as the body and query parameters

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

@@ -1,13 +1,22 @@
-import { ExampleAPIClient } from './exampleAPI.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
+  let createExampleDataBody, params
+
   /**
    * Create example data
    */
-  const createExampleDataResponseData = client.createExampleData(
+  createExampleDataBody = {
+    data: 'data',
+  }
+  params = {
+    userId: '12345',
+  }
+
+  const createExampleDataResponseData = defaultClient.createExampleData(
     createExampleDataBody,
     params
   )

package/examples/query_params_schema/schema.json

@@ -17,7 +17,8 @@
             "in": "query",
             "required": true,
             "schema": {
-              "type": "string"
+              "type": "string",
+              "example": "John Doe"
             },
             "description": "A string parameter"
           },
@@ -27,7 +28,8 @@
             "required": false,
             "schema": {
               "type": "integer",
-              "format": "int32"
+              "format": "int32",
+              "example": 25
             },
             "description": "An integer parameter"
           },
@@ -36,7 +38,8 @@
             "in": "query",
             "required": false,
             "schema": {
-              "type": "boolean"
+              "type": "boolean",
+              "example": true
             },
             "description": "A boolean parameter"
           },
@@ -49,7 +52,8 @@
             "schema": {
               "type": "array",
               "items": {
-                "type": "string"
+                "type": "string",
+                "example": "tag1"
               }
             },
             "description": "An array of strings parameter"
@@ -60,7 +64,8 @@
             "required": false,
             "schema": {
               "type": "string",
-              "format": "date"
+              "format": "date",
+              "example": "2024-01-01"
             },
             "description": "A date parameter in YYYY-MM-DD format"
           }
@@ -74,24 +79,29 @@
                   "type": "object",
                   "properties": {
                     "name": {
-                      "type": "string"
+                      "type": "string",
+                      "example": "John Doe"
                     },
                     "age": {
                       "type": "integer",
-                      "format": "int32"
+                      "format": "int32",
+                      "example": 25
                     },
                     "isActive": {
-                      "type": "boolean"
+                      "type": "boolean",
+                      "example": true
                     },
                     "tags": {
                       "type": "array",
                       "items": {
-                        "type": "string"
+                        "type": "string",
+                        "example": "tag1"
                       }
                     },
                     "date": {
                       "type": "string",
-                      "format": "date"
+                      "format": "date",
+                      "example": "2024-01-01"
                     }
                   }
                 }

package/examples/query_params_schema/single/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters

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

@@ -1,11 +1,17 @@
 import { ExampleAPIClient } from './exampleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const exampleAPIClient = new ExampleAPIClient({ baseUrl })
 
 export default function () {
+  let params
+
   /**
    * Get example data
    */
-  const getExampleDataResponseData = client.getExampleData(params)
+  params = {
+    name: 'John Doe',
+  }
+
+  const getExampleDataResponseData = exampleAPIClient.getExampleData(params)
 }

package/examples/query_params_schema/split/exampleAPI.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.0
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters

package/examples/query_params_schema/split/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters

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

@@ -1,11 +1,17 @@
 import { ExampleAPIClient } from './exampleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const exampleAPIClient = new ExampleAPIClient({ baseUrl })
 
 export default function () {
+  let params
+
   /**
    * Get example data
    */
-  const getExampleDataResponseData = client.getExampleData(params)
+  params = {
+    name: 'John Doe',
+  }
+
+  const getExampleDataResponseData = exampleAPIClient.getExampleData(params)
 }

package/examples/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.0
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters

package/examples/query_params_schema/tags/exampleAPI.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.0
  * Do not edit manually.
  * Example API
  * API with all formats of query parameters

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

@@ -1,11 +1,17 @@
-import { ExampleAPIClient } from './exampleAPI.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
+  let params
+
   /**
    * Get example data
    */
-  const getExampleDataResponseData = client.getExampleData(params)
+  params = {
+    name: 'John Doe',
+  }
+
+  const getExampleDataResponseData = defaultClient.getExampleData(params)
 }

package/examples/simple_post_request_schema/schema.json

@@ -20,39 +20,46 @@
                 "properties": {
                   "name": {
                     "type": "string",
-                    "description": "A string parameter"
+                    "description": "A string parameter",
+                    "example": "John Doe"
                   },
                   "age": {
                     "type": "integer",
                     "format": "int32",
-                    "description": "An integer parameter"
+                    "description": "An integer parameter",
+                    "example": 25
                   },
                   "isActive": {
                     "type": "boolean",
-                    "description": "A boolean parameter"
+                    "description": "A boolean parameter",
+                    "example": true
                   },
                   "tags": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     },
-                    "description": "An array of strings"
+                    "description": "An array of strings",
+                    "example": ["tag1", "tag2"]
                   },
                   "date": {
                     "type": "string",
                     "format": "date",
-                    "description": "A date parameter in YYYY-MM-DD format"
+                    "description": "A date parameter in YYYY-MM-DD format",
+                    "example": "2024-01-01"
                   },
                   "meta": {
                     "type": "object",
                     "properties": {
                       "createdBy": {
                         "type": "string",
-                        "description": "A string parameter for the creator's name"
+                        "description": "A string parameter for the creator's name",
+                        "example": "John Doe"
                       },
                       "updatedBy": {
                         "type": "string",
-                        "description": "A string parameter for the updater's name"
+                        "description": "A string parameter for the updater's name",
+                        "example": "Jane Doe"
                       }
                     },
                     "description": "An object parameter containing metadata"
@@ -77,36 +84,44 @@
                   "properties": {
                     "id": {
                       "type": "string",
-                      "description": "The unique ID of the created resource"
+                      "description": "The unique ID of the created resource",
+                      "example": "12345"
                     },
                     "name": {
-                      "type": "string"
+                      "type": "string",
+                      "example": "John Doe"
                     },
                     "age": {
                       "type": "integer",
-                      "format": "int32"
+                      "format": "int32",
+                      "example": 25
                     },
                     "isActive": {
-                      "type": "boolean"
+                      "type": "boolean",
+                      "example": true
                     },
                     "tags": {
                       "type": "array",
                       "items": {
-                        "type": "string"
+                        "type": "string",
+                        "example": ["tag1", "tag2"]
                       }
                     },
                     "date": {
                       "type": "string",
-                      "format": "date"
+                      "format": "date",
+                      "example": "2024-01-01"
                     },
                     "meta": {
                       "type": "object",
                       "properties": {
                         "createdBy": {
-                          "type": "string"
+                          "type": "string",
+                          "example": "John Doe"
                         },
                         "updatedBy": {
-                          "type": "string"
+                          "type": "string",
+                          "example": "Jane Doe"
                         }
                       }
                     }

package/examples/simple_post_request_schema/single/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

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

@@ -1,13 +1,27 @@
 import { ExampleAPIClient } from './exampleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const exampleAPIClient = new ExampleAPIClient({ baseUrl })
 
 export default function () {
+  let createExampleDataBody
+
   /**
    * Create example data
    */
-  const createExampleDataResponseData = client.createExampleData(
+  createExampleDataBody = {
+    name: 'John Doe',
+    age: '25',
+    isActive: 'true',
+    tags: 'tag1,tag2',
+    date: '2024-01-01',
+    meta: {
+      createdBy: 'John Doe',
+      updatedBy: 'Jane Doe',
+    },
+  }
+
+  const createExampleDataResponseData = exampleAPIClient.createExampleData(
     createExampleDataBody
   )
 }

package/examples/simple_post_request_schema/split/exampleAPI.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.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

package/examples/simple_post_request_schema/split/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

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

@@ -1,13 +1,27 @@
 import { ExampleAPIClient } from './exampleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const exampleAPIClient = new ExampleAPIClient({ baseUrl })
 
 export default function () {
+  let createExampleDataBody
+
   /**
    * Create example data
    */
-  const createExampleDataResponseData = client.createExampleData(
+  createExampleDataBody = {
+    name: 'John Doe',
+    age: '25',
+    isActive: 'true',
+    tags: 'tag1,tag2',
+    date: '2024-01-01',
+    meta: {
+      createdBy: 'John Doe',
+      updatedBy: 'Jane Doe',
+    },
+  }
+
+  const createExampleDataResponseData = exampleAPIClient.createExampleData(
     createExampleDataBody
   )
 }

package/examples/simple_post_request_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.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

package/examples/simple_post_request_schema/tags/exampleAPI.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.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

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

@@ -1,13 +1,27 @@
-import { ExampleAPIClient } from './exampleAPI.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
+  let createExampleDataBody
+
   /**
    * Create example data
    */
-  const createExampleDataResponseData = client.createExampleData(
+  createExampleDataBody = {
+    name: 'John Doe',
+    age: '25',
+    isActive: 'true',
+    tags: 'tag1,tag2',
+    date: '2024-01-01',
+    meta: {
+      createdBy: 'John Doe',
+      updatedBy: 'Jane Doe',
+    },
+  }
+
+  const createExampleDataResponseData = defaultClient.createExampleData(
     createExampleDataBody
   )
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/openapi-to-k6",
-  "version": "0.2.6",
+  "version": "0.3.0",
   "description": "A CLI tool to generate helper modules for K6 from OpenAPI schema",
   "main": "dist/cli.js",
   "bin": {
@@ -9,6 +9,7 @@
   "scripts": {
     "build": "tsc",
     "dev": "DISABLE_ANALYTICS=true ts-node src/cli.ts",
+    "dev:inspect": "DISABLE_ANALYTICS=true node --inspect-brk --require ts-node/register src/cli.ts",
     "test": "vitest run --coverage",
     "lint": "eslint --ext .ts,.tsx .",
     "lint:fix": "eslint --ext .ts,.tsx . --fix",
@@ -20,6 +21,7 @@
   "repository": "http://github.com/grafana/openapi-to-k6",
   "license": "AGPL-3.0",
   "dependencies": {
+    "@faker-js/faker": "^9.2.0",
     "@types/k6": "^0.54.0",
     "axios": "^1.7.7",
     "chalk": "^4.1.2",