@grafana/openapi-to-k6 0.1.2 → 0.2.0

package/examples/form_url_encoded_data_with_query_params_schema/split/formURLEncodedAPIWithQueryParameters.ts

@@ -0,0 +1,104 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Form URL Encoded API with Query Parameters
+ * OpenAPI spec version: 1.0.0
+ */
+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'
+import type {
+  PostSubmitForm200,
+  PostSubmitFormBody,
+  PostSubmitFormParams,
+} from './formURLEncodedAPIWithQueryParameters.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class FormURLEncodedAPIWithQueryParametersClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * This endpoint accepts form URL-encoded data and query parameters.
+   * @summary Submit form data with query parameters
+   */
+  postSubmitForm(
+    postSubmitFormBody: PostSubmitFormBody,
+    params: PostSubmitFormParams,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: PostSubmitForm200
+  } {
+    const url = new URL(
+      this.cleanBaseUrl +
+        `/submit-form` +
+        `?${new URLSearchParams(params).toString()}`
+    )
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'POST',
+      url.toString(),
+      JSON.stringify(postSubmitFormBody),
+      {
+        ...mergedRequestParameters,
+        headers: {
+          'Content-Type': 'application/x-www-form-urlencoded',
+          ...mergedRequestParameters?.headers,
+        },
+      }
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

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

@@ -0,0 +1,14 @@
+import { FormURLEncodedAPIwithQueryParametersClient } from './formURLEncodedAPIWithQueryParameters.ts'
+
+const baseUrl = '<BASE_URL>'
+const client = new FormURLEncodedAPIwithQueryParametersClient({ baseUrl })
+
+export default function () {
+  /**
+   * Submit form data with query parameters
+   */
+  const postSubmitFormResponseData = client.postSubmitForm(
+    postSubmitFormBody,
+    params
+  )
+}

package/examples/form_url_encoded_data_with_query_params_schema/tags/default.ts

@@ -0,0 +1,104 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Form URL Encoded API with Query Parameters
+ * OpenAPI spec version: 1.0.0
+ */
+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'
+import type {
+  PostSubmitForm200,
+  PostSubmitFormBody,
+  PostSubmitFormParams,
+} from './formURLEncodedAPIWithQueryParameters.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class DefaultClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * This endpoint accepts form URL-encoded data and query parameters.
+   * @summary Submit form data with query parameters
+   */
+  postSubmitForm(
+    postSubmitFormBody: PostSubmitFormBody,
+    params: PostSubmitFormParams,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: PostSubmitForm200
+  } {
+    const url = new URL(
+      this.cleanBaseUrl +
+        `/submit-form` +
+        `?${new URLSearchParams(params).toString()}`
+    )
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'POST',
+      url.toString(),
+      JSON.stringify(postSubmitFormBody),
+      {
+        ...mergedRequestParameters,
+        headers: {
+          'Content-Type': 'application/x-www-form-urlencoded',
+          ...mergedRequestParameters?.headers,
+        },
+      }
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

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

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

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

@@ -0,0 +1,14 @@
+import { FormURLEncodedAPIwithQueryParametersClient } from './formURLEncodedAPIWithQueryParameters.ts'
+
+const baseUrl = '<BASE_URL>'
+const client = new FormURLEncodedAPIwithQueryParametersClient({ baseUrl })
+
+export default function () {
+  /**
+   * Submit form data with query parameters
+   */
+  const postSubmitFormResponseData = client.postSubmitForm(
+    postSubmitFormBody,
+    params
+  )
+}

package/examples/get_request_with_path_parameters_schema/{k6-script.sample.ts → single/k6-script.sample.ts}

@@ -1,7 +1,7 @@
-import { createSimpleAPI } from './simpleAPI.ts'
+import { SimpleAPIClient } from './simpleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = createSimpleAPI({ baseUrl })
+const client = new SimpleAPIClient({ baseUrl })
 
 export default function () {
   /**

package/examples/get_request_with_path_parameters_schema/single/simpleAPI.ts

@@ -0,0 +1,94 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Simple API
+ * An API with a single GET request that takes a path parameter
+ * OpenAPI spec version: 1.0.0
+ */
+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
+}
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class SimpleAPIClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * Returns a single item based on the provided ID
+   * @summary Get an item by its ID
+   */
+  getItemById(
+    id: string,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetItemById200
+  } {
+    const url = new URL(this.cleanBaseUrl + `/items/${id}`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'GET',
+      url.toString(),
+      undefined,
+      mergedRequestParameters
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Simple API
+ * An API with a single GET request that takes a path parameter
+ * OpenAPI spec version: 1.0.0
+ */
+export type GetItemById200 = {
+  description?: string
+  id?: string
+  name?: string
+}

package/examples/get_request_with_path_parameters_schema/split/simpleAPI.ts

@@ -0,0 +1,90 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Simple API
+ * An API with a single GET request that takes a path parameter
+ * OpenAPI spec version: 1.0.0
+ */
+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'
+import type { GetItemById200 } from './simpleAPI.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class SimpleAPIClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * Returns a single item based on the provided ID
+   * @summary Get an item by its ID
+   */
+  getItemById(
+    id: string,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetItemById200
+  } {
+    const url = new URL(this.cleanBaseUrl + `/items/${id}`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'GET',
+      url.toString(),
+      undefined,
+      mergedRequestParameters
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

package/examples/get_request_with_path_parameters_schema/tags/default.ts

@@ -0,0 +1,90 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Simple API
+ * An API with a single GET request that takes a path parameter
+ * OpenAPI spec version: 1.0.0
+ */
+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'
+import type { GetItemById200 } from './simpleAPI.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class DefaultClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * Returns a single item based on the provided ID
+   * @summary Get an item by its ID
+   */
+  getItemById(
+    id: string,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetItemById200
+  } {
+    const url = new URL(this.cleanBaseUrl + `/items/${id}`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'GET',
+      url.toString(),
+      undefined,
+      mergedRequestParameters
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Simple API
+ * An API with a single GET request that takes a path parameter
+ * OpenAPI spec version: 1.0.0
+ */
+export type GetItemById200 = {
+  description?: string
+  id?: string
+  name?: string
+}