@grafana/openapi-to-k6 0.1.2 → 0.2.1

package/examples/form_url_encoded_data_schema/formURLEncodedAPI.ts

@@ -1,114 +0,0 @@
-/**
- * Automatically generated by @grafana/openapi-to-k6: 0.1.2
- * Do not edit manually.
- * Form URL Encoded API
- * 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, ResponseBody } from 'k6/http'
-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 CreateFormURLEncodedAPIOptions = {
-  baseUrl: string
-  commonRequestParameters?: Params
-}
-
-/**
- * This is the base client to use for interacting with the API.
- */
-export const createFormURLEncodedAPI = (
-  clientOptions: CreateFormURLEncodedAPIOptions
-) => {
-  const cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
-  /**
-   * This endpoint accepts form URL-encoded data.
-   * @summary Submit form data
-   */
-  const postSubmitForm = (
-    postSubmitFormBody: PostSubmitFormBody,
-    requestParameters?: Params
-  ): PostSubmitFormResponse => {
-    const url = new URL(cleanBaseUrl + `/submit-form`)
-    const mergedRequestParameters = _mergeRequestParameters(
-      requestParameters || {},
-      clientOptions.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 (error) {
-      data = response.body
-    }
-    return {
-      response,
-      data,
-    }
-  }
-
-  return { postSubmitForm }
-}
-
-export type PostSubmitFormResponse = {
-  response: Response
-  data: PostSubmitForm200 | ResponseBody
-}
-
-/**
- * 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
- */
-const _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/formURLEncodedAPIWithQueryParameters.ts

@@ -1,130 +0,0 @@
-/**
- * Automatically generated by @grafana/openapi-to-k6: 0.1.2
- * 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, ResponseBody } from 'k6/http'
-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
-}
-
-export type CreateFormURLEncodedAPIWithQueryParametersOptions = {
-  baseUrl: string
-  commonRequestParameters?: Params
-}
-
-/**
- * This is the base client to use for interacting with the API.
- */
-export const createFormURLEncodedAPIWithQueryParameters = (
-  clientOptions: CreateFormURLEncodedAPIWithQueryParametersOptions
-) => {
-  const cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
-  /**
-   * This endpoint accepts form URL-encoded data and query parameters.
-   * @summary Submit form data with query parameters
-   */
-  const postSubmitForm = (
-    postSubmitFormBody: PostSubmitFormBody,
-    params: PostSubmitFormParams,
-    requestParameters?: Params
-  ): PostSubmitFormResponse => {
-    const url = new URL(
-      cleanBaseUrl +
-        `/submit-form` +
-        `?${new URLSearchParams(params).toString()}`
-    )
-    const mergedRequestParameters = _mergeRequestParameters(
-      requestParameters || {},
-      clientOptions.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 (error) {
-      data = response.body
-    }
-    return {
-      response,
-      data,
-    }
-  }
-
-  return { postSubmitForm }
-}
-
-export type PostSubmitFormResponse = {
-  response: Response
-  data: PostSubmitForm200 | ResponseBody
-}
-
-/**
- * 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
- */
-const _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/simpleAPI.ts

@@ -1,94 +0,0 @@
-/**
- * Automatically generated by @grafana/openapi-to-k6: 0.1.2
- * 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, ResponseBody } from 'k6/http'
-export type GetItemById200 = {
-  description?: string
-  id?: string
-  name?: string
-}
-
-export type CreateSimpleAPIOptions = {
-  baseUrl: string
-  commonRequestParameters?: Params
-}
-
-/**
- * This is the base client to use for interacting with the API.
- */
-export const createSimpleAPI = (clientOptions: CreateSimpleAPIOptions) => {
-  const cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
-  /**
-   * Returns a single item based on the provided ID
-   * @summary Get an item by its ID
-   */
-  const getItemById = (
-    id: string,
-    requestParameters?: Params
-  ): GetItemByIdResponse => {
-    const url = new URL(cleanBaseUrl + `/items/${id}`)
-    const mergedRequestParameters = _mergeRequestParameters(
-      requestParameters || {},
-      clientOptions.commonRequestParameters
-    )
-    const response = http.request(
-      'GET',
-      url.toString(),
-      undefined,
-      mergedRequestParameters
-    )
-    let data
-
-    try {
-      data = response.json()
-    } catch (error) {
-      data = response.body
-    }
-    return {
-      response,
-      data,
-    }
-  }
-
-  return { getItemById }
-}
-
-export type GetItemByIdResponse = {
-  response: Response
-  data: GetItemById200 | ResponseBody
-}
-
-/**
- * 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
- */
-const _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/headers_schema/headerDemoAPI.ts

@@ -1,196 +0,0 @@
-/**
- * Automatically generated by @grafana/openapi-to-k6: 0.1.2
- * Do not edit manually.
- * Header Demo API
- * An API demonstrating the use of headers in different ways
- * 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, ResponseBody } from 'k6/http'
-export type GetExampleResponseHeaders200 = {
-  status?: string
-}
-
-export type PostExamplePostBody = {
-  data?: string
-}
-
-export type PostExamplePostHeaders = {
-  /**
-   * Bearer token for authorization
-   */
-  Authorization: string
-}
-
-export type GetExampleGet200 = {
-  message?: string
-}
-
-export type GetExampleGetHeaders = {
-  /**
-   * A custom header for this request
-   */
-  'X-Custom-Header'?: string
-}
-
-export type CreateHeaderDemoAPIOptions = {
-  baseUrl: string
-  commonRequestParameters?: Params
-}
-
-/**
- * This is the base client to use for interacting with the API.
- */
-export const createHeaderDemoAPI = (
-  clientOptions: CreateHeaderDemoAPIOptions
-) => {
-  const cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
-  /**
-   * This GET request demonstrates the use of custom request headers
-   * @summary GET request with headers
-   */
-  const getExampleGet = (
-    headers?: GetExampleGetHeaders,
-    requestParameters?: Params
-  ): GetExampleGetResponse => {
-    const url = new URL(cleanBaseUrl + `/example-get`)
-    const mergedRequestParameters = _mergeRequestParameters(
-      requestParameters || {},
-      clientOptions.commonRequestParameters
-    )
-    const response = http.request('GET', url.toString(), undefined, {
-      ...mergedRequestParameters,
-      headers: {
-        ...headers,
-        ...mergedRequestParameters?.headers,
-      },
-    })
-    let data
-
-    try {
-      data = response.json()
-    } catch (error) {
-      data = response.body
-    }
-    return {
-      response,
-      data,
-    }
-  }
-
-  /**
-   * This POST request uses a security header for authentication
-   * @summary POST request with security headers
-   */
-  const postExamplePost = (
-    postExamplePostBody: PostExamplePostBody,
-    headers: PostExamplePostHeaders,
-    requestParameters?: Params
-  ): PostExamplePostResponse => {
-    const url = new URL(cleanBaseUrl + `/example-post`)
-    const mergedRequestParameters = _mergeRequestParameters(
-      requestParameters || {},
-      clientOptions.commonRequestParameters
-    )
-    const response = http.request(
-      'POST',
-      url.toString(),
-      JSON.stringify(postExamplePostBody),
-      {
-        ...mergedRequestParameters,
-        headers: {
-          'Content-Type': 'application/json',
-          ...headers,
-          ...mergedRequestParameters?.headers,
-        },
-      }
-    )
-    let data
-
-    try {
-      data = response.json()
-    } catch (error) {
-      data = response.body
-    }
-    return {
-      response,
-      data,
-    }
-  }
-
-  /**
-   * This GET request returns custom response headers
-   * @summary GET request with response headers only
-   */
-  const getExampleResponseHeaders = (
-    requestParameters?: Params
-  ): GetExampleResponseHeadersResponse => {
-    const url = new URL(cleanBaseUrl + `/example-response-headers`)
-    const mergedRequestParameters = _mergeRequestParameters(
-      requestParameters || {},
-      clientOptions.commonRequestParameters
-    )
-    const response = http.request(
-      'GET',
-      url.toString(),
-      undefined,
-      mergedRequestParameters
-    )
-    let data
-
-    try {
-      data = response.json()
-    } catch (error) {
-      data = response.body
-    }
-    return {
-      response,
-      data,
-    }
-  }
-
-  return { getExampleGet, postExamplePost, getExampleResponseHeaders }
-}
-
-export type GetExampleGetResponse = {
-  response: Response
-  data: GetExampleGet200 | ResponseBody
-}
-export type PostExamplePostResponse = {
-  response: Response
-  data: void | ResponseBody
-}
-export type GetExampleResponseHeadersResponse = {
-  response: Response
-  data: GetExampleResponseHeaders200 | ResponseBody
-}
-
-/**
- * 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
- */
-const _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/no_title_schema/K6Client.ts

@@ -1,86 +0,0 @@
-/**
- * Automatically generated by @grafana/openapi-to-k6: 0.1.2
- * Do not edit manually.
- * 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, ResponseBody } from 'k6/http'
-export type GetExample200 = {
-  message?: string
-}
-
-export type CreateK6ClientOptions = {
-  baseUrl: string
-  commonRequestParameters?: Params
-}
-
-/**
- * This is the base client to use for interacting with the API.
- */
-export const createK6Client = (clientOptions: CreateK6ClientOptions) => {
-  const cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
-  /**
-   * @summary Retrieve example data
-   */
-  const getExample = (requestParameters?: Params): GetExampleResponse => {
-    const url = new URL(cleanBaseUrl + `/example`)
-    const mergedRequestParameters = _mergeRequestParameters(
-      requestParameters || {},
-      clientOptions.commonRequestParameters
-    )
-    const response = http.request(
-      'GET',
-      url.toString(),
-      undefined,
-      mergedRequestParameters
-    )
-    let data
-
-    try {
-      data = response.json()
-    } catch (error) {
-      data = response.body
-    }
-    return {
-      response,
-      data,
-    }
-  }
-
-  return { getExample }
-}
-
-export type GetExampleResponse = {
-  response: Response
-  data: GetExample200 | ResponseBody
-}
-
-/**
- * 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
- */
-const _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 || {}),
-    },
-  }
-}