@grafana/openapi-to-k6 0.1.2 → 0.2.1

package/examples/post_request_with_query_params/split/exampleAPI.schemas.ts

@@ -0,0 +1,33 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with a POST request having an object as the body and query parameters
+ * OpenAPI spec version: 1.0.0
+ */
+export type CreateExampleData201 = {
+  /** The data from the body */
+  data?: string
+  /** The active status from the query parameter */
+  isActive?: boolean
+  /** Response status */
+  status?: string
+  /** The user ID from the query parameter */
+  userId?: string
+}
+
+export type CreateExampleDataBody = {
+  /** A string field representing data */
+  data: string
+}
+
+export type CreateExampleDataParams = {
+  /**
+   * A string query parameter for user ID
+   */
+  userId: string
+  /**
+   * A boolean query parameter
+   */
+  isActive?: boolean
+}

package/examples/post_request_with_query_params/split/exampleAPI.ts

@@ -0,0 +1,105 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with a POST request having an object as the body and 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 {
+  CreateExampleData201,
+  CreateExampleDataBody,
+  CreateExampleDataParams,
+} from './exampleAPI.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class ExampleAPIClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * This endpoint demonstrates a POST request with query parameters and a single field object in the body
+   * @summary Create example data
+   */
+  createExampleData(
+    createExampleDataBody: CreateExampleDataBody,
+    params: CreateExampleDataParams,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: CreateExampleData201
+  } {
+    const url = new URL(
+      this.cleanBaseUrl +
+        `/example` +
+        `?${new URLSearchParams(params).toString()}`
+    )
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'POST',
+      url.toString(),
+      JSON.stringify(createExampleDataBody),
+      {
+        ...mergedRequestParameters,
+        headers: {
+          'Content-Type': 'application/json',
+          ...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/post_request_with_query_params/split/k6-script.sample.ts

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

package/examples/post_request_with_query_params/tags/default.ts

@@ -0,0 +1,105 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with a POST request having an object as the body and 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 {
+  CreateExampleData201,
+  CreateExampleDataBody,
+  CreateExampleDataParams,
+} from './exampleAPI.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 demonstrates a POST request with query parameters and a single field object in the body
+   * @summary Create example data
+   */
+  createExampleData(
+    createExampleDataBody: CreateExampleDataBody,
+    params: CreateExampleDataParams,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: CreateExampleData201
+  } {
+    const url = new URL(
+      this.cleanBaseUrl +
+        `/example` +
+        `?${new URLSearchParams(params).toString()}`
+    )
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'POST',
+      url.toString(),
+      JSON.stringify(createExampleDataBody),
+      {
+        ...mergedRequestParameters,
+        headers: {
+          'Content-Type': 'application/json',
+          ...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/post_request_with_query_params/tags/exampleAPI.schemas.ts

@@ -0,0 +1,33 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with a POST request having an object as the body and query parameters
+ * OpenAPI spec version: 1.0.0
+ */
+export type CreateExampleData201 = {
+  /** The data from the body */
+  data?: string
+  /** The active status from the query parameter */
+  isActive?: boolean
+  /** Response status */
+  status?: string
+  /** The user ID from the query parameter */
+  userId?: string
+}
+
+export type CreateExampleDataBody = {
+  /** A string field representing data */
+  data: string
+}
+
+export type CreateExampleDataParams = {
+  /**
+   * A string query parameter for user ID
+   */
+  userId: string
+  /**
+   * A boolean query parameter
+   */
+  isActive?: boolean
+}

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

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

package/examples/query_params_schema/single/exampleAPI.ts

@@ -0,0 +1,120 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with all formats of 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'
+export type GetExampleData200 = {
+  age?: number
+  date?: string
+  isActive?: boolean
+  name?: string
+  tags?: string[]
+}
+
+export type GetExampleDataParams = {
+  /**
+   * A string parameter
+   */
+  name: string
+  /**
+   * An integer parameter
+   */
+  age?: number
+  /**
+   * A boolean parameter
+   */
+  isActive?: boolean
+  /**
+   * An array of strings parameter
+   */
+  tags?: string[]
+  /**
+   * A date parameter in YYYY-MM-DD format
+   */
+  date?: string
+}
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class ExampleAPIClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * This endpoint demonstrates the use of various query parameters
+   * @summary Get example data
+   */
+  getExampleData(
+    params: GetExampleDataParams,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetExampleData200
+  } {
+    const url = new URL(
+      this.cleanBaseUrl +
+        `/example` +
+        `?${new URLSearchParams(params).toString()}`
+    )
+    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/query_params_schema/{k6-script.sample.ts → single/k6-script.sample.ts}

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

package/examples/query_params_schema/split/exampleAPI.schemas.ts

@@ -0,0 +1,37 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with all formats of query parameters
+ * OpenAPI spec version: 1.0.0
+ */
+export type GetExampleData200 = {
+  age?: number
+  date?: string
+  isActive?: boolean
+  name?: string
+  tags?: string[]
+}
+
+export type GetExampleDataParams = {
+  /**
+   * A string parameter
+   */
+  name: string
+  /**
+   * An integer parameter
+   */
+  age?: number
+  /**
+   * A boolean parameter
+   */
+  isActive?: boolean
+  /**
+   * An array of strings parameter
+   */
+  tags?: string[]
+  /**
+   * A date parameter in YYYY-MM-DD format
+   */
+  date?: string
+}

package/examples/query_params_schema/split/exampleAPI.ts

@@ -0,0 +1,94 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with all formats of 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 {
+  GetExampleData200,
+  GetExampleDataParams,
+} from './exampleAPI.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class ExampleAPIClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * This endpoint demonstrates the use of various query parameters
+   * @summary Get example data
+   */
+  getExampleData(
+    params: GetExampleDataParams,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetExampleData200
+  } {
+    const url = new URL(
+      this.cleanBaseUrl +
+        `/example` +
+        `?${new URLSearchParams(params).toString()}`
+    )
+    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/query_params_schema/split/k6-script.sample.ts

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

package/examples/query_params_schema/tags/default.ts

@@ -0,0 +1,94 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with all formats of 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 {
+  GetExampleData200,
+  GetExampleDataParams,
+} from './exampleAPI.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 demonstrates the use of various query parameters
+   * @summary Get example data
+   */
+  getExampleData(
+    params: GetExampleDataParams,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: GetExampleData200
+  } {
+    const url = new URL(
+      this.cleanBaseUrl +
+        `/example` +
+        `?${new URLSearchParams(params).toString()}`
+    )
+    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 || {}),
+      },
+    }
+  }
+}