diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache index c45fb56c3232..c514cc57c52e 100644 --- a/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/apiInner.mustache @@ -31,7 +31,6 @@ import type { {{classname}} } from '{{apiRelativeToRoot}}{{tsModelPackage}}{{imp /** * {{classname}} - axios parameter creator{{#description}} * {{&description}}{{/description}} - * @export */ export const {{classname}}AxiosParamCreator = function (configuration?: Configuration) { return { @@ -246,7 +245,6 @@ export const {{classname}}AxiosParamCreator = function (configuration?: Configur /** * {{classname}} - functional programming interface{{#description}} * {{{.}}}{{/description}} - * @export */ export const {{classname}}Fp = function(configuration?: Configuration) { const localVarAxiosParamCreator = {{classname}}AxiosParamCreator(configuration) @@ -277,7 +275,6 @@ export const {{classname}}Fp = function(configuration?: Configuration) { /** * {{classname}} - factory interface{{#description}} * {{&description}}{{/description}} - * @export */ export const {{classname}}Factory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = {{classname}}Fp(configuration) @@ -320,8 +317,6 @@ export const {{classname}}Factory = function (configuration?: Configuration, bas /** * {{classname}} - interface{{#description}} * {{&description}}{{/description}} - * @export - * @interface {{classname}} */ export interface {{classname}}Interface { {{#operation}} @@ -343,7 +338,6 @@ export interface {{classname}}Interface { * @param {*} [options] Override http request option.{{#isDeprecated}} * @deprecated{{/isDeprecated}} * @throws {RequiredError} - * @memberof {{classname}}Interface */ {{#useSingleRequestParameter}} {{nickname}}({{#allParams.0}}requestParameters{{^hasRequiredParams}}?{{/hasRequiredParams}}: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}options?: RawAxiosRequestConfig): AxiosPromise<{{{returnType}}}{{^returnType}}void{{/returnType}}>; @@ -361,16 +355,14 @@ export interface {{classname}}Interface { {{#allParams.0}} /** * Request parameters for {{nickname}} operation in {{classname}}. - * @export - * @interface {{classname}}{{operationIdCamelCase}}Request */ export interface {{classname}}{{operationIdCamelCase}}Request { {{#allParams}} + {{#description}} /** * {{description}} - * @type {{=<% %>=}}{<%&dataType%>}<%={{ }}=%> - * @memberof {{classname}}{{operationIdCamelCase}} */ + {{/description}} readonly {{paramName}}{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{#isNullable}} | null{{/isNullable}}{{/isEnum}} {{^-last}} @@ -384,9 +376,6 @@ export interface {{classname}}{{operationIdCamelCase}}Request { /** * {{classname}} - object-oriented interface{{#description}} * {{{.}}}{{/description}} - * @export - * @class {{classname}} - * @extends {BaseAPI} */ {{#withInterfaces}} export class {{classname}} extends BaseAPI implements {{classname}}Interface { @@ -413,7 +402,6 @@ export class {{classname}} extends BaseAPI { * @param {*} [options] Override http request option.{{#isDeprecated}} * @deprecated{{/isDeprecated}} * @throws {RequiredError} - * @memberof {{classname}} */ {{#useSingleRequestParameter}} public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request{{^hasRequiredParams}} = {}{{/hasRequiredParams}}, {{/allParams.0}}options?: RawAxiosRequestConfig) { @@ -437,10 +425,6 @@ export class {{classname}} extends BaseAPI { {{#allParams}} {{#isEnum}} {{#stringEnums}} -/** - * @export - * @enum {string} - */ export enum {{operationIdCamelCase}}{{enumName}} { {{#allowableValues}} {{#enumVars}} @@ -450,9 +434,6 @@ export enum {{operationIdCamelCase}}{{enumName}} { } {{/stringEnums}} {{^stringEnums}} -/** - * @export - */ export const {{operationIdCamelCase}}{{enumName}} = { {{#allowableValues}} {{#enumVars}} diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/baseApi.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/baseApi.mustache index 59badfdf487a..2bfb779f8194 100644 --- a/modules/openapi-generator/src/main/resources/typescript-axios/baseApi.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/baseApi.mustache @@ -11,10 +11,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "{{{basePath}}}".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -22,21 +18,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -48,12 +34,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -68,10 +48,6 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { {{#apiInfo}} {{#apis}} diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/common.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/common.mustache index 7b19eed554a9..d778f29e6d3b 100755 --- a/modules/openapi-generator/src/main/resources/typescript-axios/common.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/common.mustache @@ -11,16 +11,11 @@ import { RequiredError } from "./base{{importFileExtension}}"; import { URL, URLSearchParams } from 'url'; {{/withNodeImports}} -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -28,10 +23,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -41,20 +32,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -64,10 +47,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -99,20 +78,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -123,18 +94,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/configuration.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/configuration.mustache index f5db62f5ae2e..6dd78e7a1778 100644 --- a/modules/openapi-generator/src/main/resources/typescript-axios/configuration.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/configuration.mustache @@ -18,49 +18,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/modelAllOf.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/modelAllOf.mustache index c163419686d4..aee84ee6bd59 100644 --- a/modules/openapi-generator/src/main/resources/typescript-axios/modelAllOf.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/modelAllOf.mustache @@ -1,6 +1,5 @@ /** * @type {{classname}}{{#description}} * {{{.}}}{{/description}} - * @export */ export type {{classname}} = {{#allOf}}{{{.}}}{{^-last}} & {{/-last}}{{/allOf}}; diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/modelEnum.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/modelEnum.mustache index 5a3ecec5ac77..8473f122bbec 100644 --- a/modules/openapi-generator/src/main/resources/typescript-axios/modelEnum.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/modelEnum.mustache @@ -1,8 +1,8 @@ +{{#description}} /** * {{{description}}} - * @export - * @enum {{=<% %>=}}{<%&dataType%>}<%={{ }}=%> */ +{{/description}} {{#isBoolean}} export type {{classname}} = {{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}} | {{/-last}}{{/enumVars}}{{/allowableValues}} {{/isBoolean}} diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/modelGeneric.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/modelGeneric.mustache index 878383ded67d..5c515f04dcdc 100644 --- a/modules/openapi-generator/src/main/resources/typescript-axios/modelGeneric.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/modelGeneric.mustache @@ -1,22 +1,32 @@ +{{#description}} /** * {{{description}}} - * @export - * @interface {{classname}} */ +{{/description}} export interface {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{ {{#additionalPropertiesType}} [key: string]: {{{additionalPropertiesType}}}{{#additionalPropertiesIsAnyType}}{{#hasVars}} | any{{/hasVars}}{{/additionalPropertiesIsAnyType}}; {{/additionalPropertiesType}} {{#vars}} + {{#description}} /** - * {{{description}}} - * @type {{=<% %>=}}{<%&datatype%>}<%={{ }}=%> - * @memberof {{classname}} + * {{{description}}} {{#deprecated}} - * @deprecated + * @deprecated {{/deprecated}} - */ + */ + {{/description}} + {{^description}} + {{#deprecated}} + /** + * + {{#deprecated}} + * @deprecated + {{/deprecated}} + */ + {{/deprecated}} + {{/description}} '{{baseName}}'{{^required}}?{{/required}}: {{#isEnum}}{{{datatypeWithEnum}}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}} | null{{/isNullable}}; {{/vars}} }{{#hasEnums}} @@ -24,10 +34,6 @@ export interface {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{ {{#vars}} {{#isEnum}} {{#stringEnums}} -/** - * @export - * @enum {string} - */ export enum {{enumName}} { {{#allowableValues}} {{#enumVars}} diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/modelOneOf.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/modelOneOf.mustache index bfc9fb0bd89a..3fefd465c88f 100644 --- a/modules/openapi-generator/src/main/resources/typescript-axios/modelOneOf.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/modelOneOf.mustache @@ -1,7 +1,6 @@ /** * @type {{classname}}{{#description}} * {{{.}}}{{/description}} - * @export */ export type {{classname}} = {{#discriminator}}{{! diff --git a/samples/client/echo_api/typescript-axios/build/api.ts b/samples/client/echo_api/typescript-axios/build/api.ts index 83b343462964..9a7c68a5dffd 100644 --- a/samples/client/echo_api/typescript-axios/build/api.ts +++ b/samples/client/echo_api/typescript-axios/build/api.ts @@ -23,124 +23,41 @@ import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; -/** - * - * @export - * @interface Bird - */ export interface Bird { - /** - * - * @type {string} - * @memberof Bird - */ 'size'?: string; - /** - * - * @type {string} - * @memberof Bird - */ 'color'?: string; } -/** - * - * @export - * @interface Category - */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } -/** - * - * @export - * @interface DataQuery - */ export interface DataQuery extends Query { /** - * test suffix - * @type {string} - * @memberof DataQuery - */ + * test suffix + */ 'suffix'?: string; /** - * Some text containing white spaces - * @type {string} - * @memberof DataQuery - */ + * Some text containing white spaces + */ 'text'?: string; /** - * A date - * @type {string} - * @memberof DataQuery - */ + * A date + */ 'date'?: string; } /** * to test the default value of properties - * @export - * @interface DefaultValue */ export interface DefaultValue { - /** - * - * @type {Array} - * @memberof DefaultValue - */ 'array_string_enum_ref_default'?: Array; - /** - * - * @type {Array} - * @memberof DefaultValue - */ 'array_string_enum_default'?: Array; - /** - * - * @type {Array} - * @memberof DefaultValue - */ 'array_string_default'?: Array; - /** - * - * @type {Array} - * @memberof DefaultValue - */ 'array_integer_default'?: Array; - /** - * - * @type {Array} - * @memberof DefaultValue - */ 'array_string'?: Array; - /** - * - * @type {Array} - * @memberof DefaultValue - */ 'array_string_nullable'?: Array | null; - /** - * - * @type {Array} - * @memberof DefaultValue - */ 'array_string_extension_nullable'?: Array | null; - /** - * - * @type {string} - * @memberof DefaultValue - */ 'string_nullable'?: string | null; } @@ -152,72 +69,20 @@ export const DefaultValueArrayStringEnumDefaultEnum = { export type DefaultValueArrayStringEnumDefaultEnum = typeof DefaultValueArrayStringEnumDefaultEnum[keyof typeof DefaultValueArrayStringEnumDefaultEnum]; -/** - * - * @export - * @interface NumberPropertiesOnly - */ export interface NumberPropertiesOnly { - /** - * - * @type {number} - * @memberof NumberPropertiesOnly - */ 'number'?: number; - /** - * - * @type {number} - * @memberof NumberPropertiesOnly - */ 'float'?: number; - /** - * - * @type {number} - * @memberof NumberPropertiesOnly - */ 'double'?: number; } -/** - * - * @export - * @interface Pet - */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -229,23 +94,11 @@ export const PetStatusEnum = { export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; -/** - * - * @export - * @interface Query - */ export interface Query { /** - * Query - * @type {number} - * @memberof Query - */ + * Query + */ 'id'?: number; - /** - * - * @type {Array} - * @memberof Query - */ 'outcomes'?: Array; } @@ -257,11 +110,6 @@ export const QueryOutcomesEnum = { export type QueryOutcomesEnum = typeof QueryOutcomesEnum[keyof typeof QueryOutcomesEnum]; -/** - * - * @export - * @enum {string} - */ export const StringEnumRef = { Success: 'success', @@ -272,86 +120,25 @@ export const StringEnumRef = { export type StringEnumRef = typeof StringEnumRef[keyof typeof StringEnumRef]; -/** - * - * @export - * @interface Tag - */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } -/** - * - * @export - * @interface TestFormObjectMultipartRequestMarker - */ export interface TestFormObjectMultipartRequestMarker { - /** - * - * @type {string} - * @memberof TestFormObjectMultipartRequestMarker - */ 'name'?: string; } -/** - * - * @export - * @interface TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter - */ export interface TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter { - /** - * - * @type {string} - * @memberof TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter - */ 'size'?: string; - /** - * - * @type {string} - * @memberof TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter - */ 'color'?: string; - /** - * - * @type {number} - * @memberof TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter - */ 'id'?: number; - /** - * - * @type {string} - * @memberof TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter - */ 'name'?: string; } -/** - * - * @export - * @interface TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter - */ export interface TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter { - /** - * - * @type {Array} - * @memberof TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter - */ 'values'?: Array; } /** * AuthApi - axios parameter creator - * @export */ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -428,7 +215,6 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) /** * AuthApi - functional programming interface - * @export */ export const AuthApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = AuthApiAxiosParamCreator(configuration) @@ -462,7 +248,6 @@ export const AuthApiFp = function(configuration?: Configuration) { /** * AuthApi - factory interface - * @export */ export const AuthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = AuthApiFp(configuration) @@ -490,9 +275,6 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? /** * AuthApi - object-oriented interface - * @export - * @class AuthApi - * @extends {BaseAPI} */ export class AuthApi extends BaseAPI { /** @@ -500,7 +282,6 @@ export class AuthApi extends BaseAPI { * @summary To test HTTP basic authentication * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AuthApi */ public testAuthHttpBasic(options?: RawAxiosRequestConfig) { return AuthApiFp(this.configuration).testAuthHttpBasic(options).then((request) => request(this.axios, this.basePath)); @@ -511,7 +292,6 @@ export class AuthApi extends BaseAPI { * @summary To test HTTP bearer authentication * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AuthApi */ public testAuthHttpBearer(options?: RawAxiosRequestConfig) { return AuthApiFp(this.configuration).testAuthHttpBearer(options).then((request) => request(this.axios, this.basePath)); @@ -522,7 +302,6 @@ export class AuthApi extends BaseAPI { /** * BodyApi - axios parameter creator - * @export */ export const BodyApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -881,7 +660,6 @@ export const BodyApiAxiosParamCreator = function (configuration?: Configuration) /** * BodyApi - functional programming interface - * @export */ export const BodyApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = BodyApiAxiosParamCreator(configuration) @@ -1020,7 +798,6 @@ export const BodyApiFp = function(configuration?: Configuration) { /** * BodyApi - factory interface - * @export */ export const BodyApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = BodyApiFp(configuration) @@ -1129,9 +906,6 @@ export const BodyApiFactory = function (configuration?: Configuration, basePath? /** * BodyApi - object-oriented interface - * @export - * @class BodyApi - * @extends {BaseAPI} */ export class BodyApi extends BaseAPI { /** @@ -1139,7 +913,6 @@ export class BodyApi extends BaseAPI { * @summary Test binary (gif) response body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testBinaryGif(options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testBinaryGif(options).then((request) => request(this.axios, this.basePath)); @@ -1151,7 +924,6 @@ export class BodyApi extends BaseAPI { * @param {File} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testBodyApplicationOctetstreamBinary(body?: File, options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testBodyApplicationOctetstreamBinary(body, options).then((request) => request(this.axios, this.basePath)); @@ -1163,7 +935,6 @@ export class BodyApi extends BaseAPI { * @param {Array} files * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testBodyMultipartFormdataArrayOfBinary(files: Array, options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testBodyMultipartFormdataArrayOfBinary(files, options).then((request) => request(this.axios, this.basePath)); @@ -1175,7 +946,6 @@ export class BodyApi extends BaseAPI { * @param {File} [myFile] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testBodyMultipartFormdataSingleBinary(myFile?: File, options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testBodyMultipartFormdataSingleBinary(myFile, options).then((request) => request(this.axios, this.basePath)); @@ -1187,7 +957,6 @@ export class BodyApi extends BaseAPI { * @param {Pet} [pet] Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testEchoBodyAllOfPet(pet?: Pet, options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testEchoBodyAllOfPet(pet, options).then((request) => request(this.axios, this.basePath)); @@ -1199,7 +968,6 @@ export class BodyApi extends BaseAPI { * @param {object} [body] Free form object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testEchoBodyFreeFormObjectResponseString(body?: object, options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testEchoBodyFreeFormObjectResponseString(body, options).then((request) => request(this.axios, this.basePath)); @@ -1211,7 +979,6 @@ export class BodyApi extends BaseAPI { * @param {Pet} [pet] Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testEchoBodyPet(pet?: Pet, options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testEchoBodyPet(pet, options).then((request) => request(this.axios, this.basePath)); @@ -1223,7 +990,6 @@ export class BodyApi extends BaseAPI { * @param {Pet} [pet] Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testEchoBodyPetResponseString(pet?: Pet, options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testEchoBodyPetResponseString(pet, options).then((request) => request(this.axios, this.basePath)); @@ -1235,7 +1001,6 @@ export class BodyApi extends BaseAPI { * @param {string} [body] String enum * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testEchoBodyStringEnum(body?: string, options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testEchoBodyStringEnum(body, options).then((request) => request(this.axios, this.basePath)); @@ -1247,7 +1012,6 @@ export class BodyApi extends BaseAPI { * @param {Tag} [tag] Tag object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof BodyApi */ public testEchoBodyTagResponseString(tag?: Tag, options?: RawAxiosRequestConfig) { return BodyApiFp(this.configuration).testEchoBodyTagResponseString(tag, options).then((request) => request(this.axios, this.basePath)); @@ -1258,7 +1022,6 @@ export class BodyApi extends BaseAPI { /** * FormApi - axios parameter creator - * @export */ export const FormApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1421,7 +1184,6 @@ export const FormApiAxiosParamCreator = function (configuration?: Configuration) /** * FormApi - functional programming interface - * @export */ export const FormApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = FormApiAxiosParamCreator(configuration) @@ -1477,7 +1239,6 @@ export const FormApiFp = function(configuration?: Configuration) { /** * FormApi - factory interface - * @export */ export const FormApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = FormApiFp(configuration) @@ -1524,9 +1285,6 @@ export const FormApiFactory = function (configuration?: Configuration, basePath? /** * FormApi - object-oriented interface - * @export - * @class FormApi - * @extends {BaseAPI} */ export class FormApi extends BaseAPI { /** @@ -1537,7 +1295,6 @@ export class FormApi extends BaseAPI { * @param {string} [stringForm] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FormApi */ public testFormIntegerBooleanString(integerForm?: number, booleanForm?: boolean, stringForm?: string, options?: RawAxiosRequestConfig) { return FormApiFp(this.configuration).testFormIntegerBooleanString(integerForm, booleanForm, stringForm, options).then((request) => request(this.axios, this.basePath)); @@ -1549,7 +1306,6 @@ export class FormApi extends BaseAPI { * @param {TestFormObjectMultipartRequestMarker} marker * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FormApi */ public testFormObjectMultipart(marker: TestFormObjectMultipartRequestMarker, options?: RawAxiosRequestConfig) { return FormApiFp(this.configuration).testFormObjectMultipart(marker, options).then((request) => request(this.axios, this.basePath)); @@ -1566,7 +1322,6 @@ export class FormApi extends BaseAPI { * @param {string} [name] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FormApi */ public testFormOneof(form1?: string, form2?: number, form3?: string, form4?: boolean, id?: number, name?: string, options?: RawAxiosRequestConfig) { return FormApiFp(this.configuration).testFormOneof(form1, form2, form3, form4, id, name, options).then((request) => request(this.axios, this.basePath)); @@ -1577,7 +1332,6 @@ export class FormApi extends BaseAPI { /** * HeaderApi - axios parameter creator - * @export */ export const HeaderApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1642,7 +1396,6 @@ export const HeaderApiAxiosParamCreator = function (configuration?: Configuratio /** * HeaderApi - functional programming interface - * @export */ export const HeaderApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = HeaderApiAxiosParamCreator(configuration) @@ -1669,7 +1422,6 @@ export const HeaderApiFp = function(configuration?: Configuration) { /** * HeaderApi - factory interface - * @export */ export const HeaderApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = HeaderApiFp(configuration) @@ -1693,9 +1445,6 @@ export const HeaderApiFactory = function (configuration?: Configuration, basePat /** * HeaderApi - object-oriented interface - * @export - * @class HeaderApi - * @extends {BaseAPI} */ export class HeaderApi extends BaseAPI { /** @@ -1708,16 +1457,12 @@ export class HeaderApi extends BaseAPI { * @param {StringEnumRef} [enumRefStringHeader] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof HeaderApi */ public testHeaderIntegerBooleanStringEnums(integerHeader?: number, booleanHeader?: boolean, stringHeader?: string, enumNonrefStringHeader?: TestHeaderIntegerBooleanStringEnumsEnumNonrefStringHeaderEnum, enumRefStringHeader?: StringEnumRef, options?: RawAxiosRequestConfig) { return HeaderApiFp(this.configuration).testHeaderIntegerBooleanStringEnums(integerHeader, booleanHeader, stringHeader, enumNonrefStringHeader, enumRefStringHeader, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const TestHeaderIntegerBooleanStringEnumsEnumNonrefStringHeaderEnum = { Success: 'success', Failure: 'failure', @@ -1728,7 +1473,6 @@ export type TestHeaderIntegerBooleanStringEnumsEnumNonrefStringHeaderEnum = type /** * PathApi - axios parameter creator - * @export */ export const PathApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1783,7 +1527,6 @@ export const PathApiAxiosParamCreator = function (configuration?: Configuration) /** * PathApi - functional programming interface - * @export */ export const PathApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PathApiAxiosParamCreator(configuration) @@ -1809,7 +1552,6 @@ export const PathApiFp = function(configuration?: Configuration) { /** * PathApi - factory interface - * @export */ export const PathApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PathApiFp(configuration) @@ -1832,9 +1574,6 @@ export const PathApiFactory = function (configuration?: Configuration, basePath? /** * PathApi - object-oriented interface - * @export - * @class PathApi - * @extends {BaseAPI} */ export class PathApi extends BaseAPI { /** @@ -1846,16 +1585,12 @@ export class PathApi extends BaseAPI { * @param {StringEnumRef} enumRefStringPath * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PathApi */ public testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath(pathString: string, pathInteger: number, enumNonrefStringPath: TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPathEnumNonrefStringPathEnum, enumRefStringPath: StringEnumRef, options?: RawAxiosRequestConfig) { return PathApiFp(this.configuration).testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath(pathString, pathInteger, enumNonrefStringPath, enumRefStringPath, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPathEnumNonrefStringPathEnum = { Success: 'success', Failure: 'failure', @@ -1866,7 +1601,6 @@ export type TestsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumR /** * QueryApi - axios parameter creator - * @export */ export const QueryApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -2304,7 +2038,6 @@ export const QueryApiAxiosParamCreator = function (configuration?: Configuration /** * QueryApi - functional programming interface - * @export */ export const QueryApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = QueryApiAxiosParamCreator(configuration) @@ -2463,7 +2196,6 @@ export const QueryApiFp = function(configuration?: Configuration) { /** * QueryApi - factory interface - * @export */ export const QueryApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = QueryApiFp(configuration) @@ -2589,9 +2321,6 @@ export const QueryApiFactory = function (configuration?: Configuration, basePath /** * QueryApi - object-oriented interface - * @export - * @class QueryApi - * @extends {BaseAPI} */ export class QueryApi extends BaseAPI { /** @@ -2601,7 +2330,6 @@ export class QueryApi extends BaseAPI { * @param {StringEnumRef} [enumRefStringQuery] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testEnumRefString(enumNonrefStringQuery?: TestEnumRefStringEnumNonrefStringQueryEnum, enumRefStringQuery?: StringEnumRef, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testEnumRefString(enumNonrefStringQuery, enumRefStringQuery, options).then((request) => request(this.axios, this.basePath)); @@ -2615,7 +2343,6 @@ export class QueryApi extends BaseAPI { * @param {string} [stringQuery] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryDatetimeDateString(datetimeQuery?: string, dateQuery?: string, stringQuery?: string, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryDatetimeDateString(datetimeQuery, dateQuery, stringQuery, options).then((request) => request(this.axios, this.basePath)); @@ -2629,7 +2356,6 @@ export class QueryApi extends BaseAPI { * @param {string} [stringQuery] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryIntegerBooleanString(integerQuery?: number, booleanQuery?: boolean, stringQuery?: string, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryIntegerBooleanString(integerQuery, booleanQuery, stringQuery, options).then((request) => request(this.axios, this.basePath)); @@ -2641,7 +2367,6 @@ export class QueryApi extends BaseAPI { * @param {Pet} [queryObject] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryStyleDeepObjectExplodeTrueObject(queryObject?: Pet, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryStyleDeepObjectExplodeTrueObject(queryObject, options).then((request) => request(this.axios, this.basePath)); @@ -2653,7 +2378,6 @@ export class QueryApi extends BaseAPI { * @param {TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter} [queryObject] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryStyleDeepObjectExplodeTrueObjectAllOf(queryObject?: TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryStyleDeepObjectExplodeTrueObjectAllOf(queryObject, options).then((request) => request(this.axios, this.basePath)); @@ -2665,7 +2389,6 @@ export class QueryApi extends BaseAPI { * @param {Array} [queryObject] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryStyleFormExplodeFalseArrayInteger(queryObject?: Array, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryStyleFormExplodeFalseArrayInteger(queryObject, options).then((request) => request(this.axios, this.basePath)); @@ -2677,7 +2400,6 @@ export class QueryApi extends BaseAPI { * @param {Array} [queryObject] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryStyleFormExplodeFalseArrayString(queryObject?: Array, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryStyleFormExplodeFalseArrayString(queryObject, options).then((request) => request(this.axios, this.basePath)); @@ -2689,7 +2411,6 @@ export class QueryApi extends BaseAPI { * @param {TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter} [queryObject] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryStyleFormExplodeTrueArrayString(queryObject?: TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryStyleFormExplodeTrueArrayString(queryObject, options).then((request) => request(this.axios, this.basePath)); @@ -2701,7 +2422,6 @@ export class QueryApi extends BaseAPI { * @param {Pet} [queryObject] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryStyleFormExplodeTrueObject(queryObject?: Pet, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryStyleFormExplodeTrueObject(queryObject, options).then((request) => request(this.axios, this.basePath)); @@ -2713,7 +2433,6 @@ export class QueryApi extends BaseAPI { * @param {DataQuery} [queryObject] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryStyleFormExplodeTrueObjectAllOf(queryObject?: DataQuery, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryStyleFormExplodeTrueObjectAllOf(queryObject, options).then((request) => request(this.axios, this.basePath)); @@ -2726,16 +2445,12 @@ export class QueryApi extends BaseAPI { * @param {Array} [jsonSerializedObjectArrayRefStringQuery] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof QueryApi */ public testQueryStyleJsonSerializationObject(jsonSerializedObjectRefStringQuery?: Pet, jsonSerializedObjectArrayRefStringQuery?: Array, options?: RawAxiosRequestConfig) { return QueryApiFp(this.configuration).testQueryStyleJsonSerializationObject(jsonSerializedObjectRefStringQuery, jsonSerializedObjectArrayRefStringQuery, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const TestEnumRefStringEnumNonrefStringQueryEnum = { Success: 'success', Failure: 'failure', diff --git a/samples/client/echo_api/typescript-axios/build/base.ts b/samples/client/echo_api/typescript-axios/build/base.ts index b95cd69a9ed8..b39791f583ba 100644 --- a/samples/client/echo_api/typescript-axios/build/base.ts +++ b/samples/client/echo_api/typescript-axios/build/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://localhost:3000".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/echo_api/typescript-axios/build/common.ts b/samples/client/echo_api/typescript-axios/build/common.ts index 5c8ff6b1c1aa..41e36d497493 100644 --- a/samples/client/echo_api/typescript-axios/build/common.ts +++ b/samples/client/echo_api/typescript-axios/build/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/echo_api/typescript-axios/build/configuration.ts b/samples/client/echo_api/typescript-axios/build/configuration.ts index 3e23346e61e3..34e7d2f62f17 100644 --- a/samples/client/echo_api/typescript-axios/build/configuration.ts +++ b/samples/client/echo_api/typescript-axios/build/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/base.ts b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/base.ts index 208ec53dda46..2b9c6ab69e98 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/base.ts +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://localhost".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/common.ts b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/common.ts index 7248f940d129..e6ac882c1dac 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/common.ts +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/configuration.ts b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/configuration.ts index 641fa859c704..a63c023257b3 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/configuration.ts +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/abstract-flat-stock-pick-order-base-dto.ts b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/abstract-flat-stock-pick-order-base-dto.ts index 9604cf4c300b..2708c0e0ff33 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/abstract-flat-stock-pick-order-base-dto.ts +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/abstract-flat-stock-pick-order-base-dto.ts @@ -14,65 +14,15 @@ -/** - * - * @export - * @interface AbstractFlatStockPickOrderBaseDto - */ export interface AbstractFlatStockPickOrderBaseDto { - /** - * - * @type {number} - * @memberof AbstractFlatStockPickOrderBaseDto - */ 'id': number; - /** - * - * @type {string} - * @memberof AbstractFlatStockPickOrderBaseDto - */ 'created'?: string; - /** - * - * @type {string} - * @memberof AbstractFlatStockPickOrderBaseDto - */ 'lastModified'?: string; - /** - * - * @type {number} - * @memberof AbstractFlatStockPickOrderBaseDto - */ 'warehouseId': number; - /** - * - * @type {number} - * @memberof AbstractFlatStockPickOrderBaseDto - */ 'quantity': number; - /** - * - * @type {string} - * @memberof AbstractFlatStockPickOrderBaseDto - */ 'stockLocation'?: string; - /** - * - * @type {string} - * @memberof AbstractFlatStockPickOrderBaseDto - */ 'barcode'?: string; - /** - * - * @type {number} - * @memberof AbstractFlatStockPickOrderBaseDto - */ 'pickedQuantity': number; - /** - * - * @type {string} - * @memberof AbstractFlatStockPickOrderBaseDto - */ 'type': string; } diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/abstract-user-dto.ts b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/abstract-user-dto.ts index 3643cc60cff6..f2d77ccc198c 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/abstract-user-dto.ts +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/abstract-user-dto.ts @@ -17,29 +17,9 @@ // @ts-ignore import type { BranchDto } from './branch-dto'; -/** - * - * @export - * @interface AbstractUserDto - */ export interface AbstractUserDto { - /** - * - * @type {string} - * @memberof AbstractUserDto - */ 'username'?: string; - /** - * - * @type {BranchDto} - * @memberof AbstractUserDto - */ 'branch'?: BranchDto; - /** - * - * @type {string} - * @memberof AbstractUserDto - */ 'type'?: string; } diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/branch-dto.ts b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/branch-dto.ts index 4c6d31ceb243..232891519f41 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/branch-dto.ts +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/branch-dto.ts @@ -14,17 +14,7 @@ -/** - * - * @export - * @interface BranchDto - */ export interface BranchDto { - /** - * - * @type {string} - * @memberof BranchDto - */ 'name'?: string; } diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/flat-stock-pick-order-dto.ts b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/flat-stock-pick-order-dto.ts index 12cd97a7d4cc..cadff4c989b8 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/flat-stock-pick-order-dto.ts +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/flat-stock-pick-order-dto.ts @@ -19,7 +19,6 @@ import type { AbstractFlatStockPickOrderBaseDto } from './abstract-flat-stock-pi /** * @type FlatStockPickOrderDto - * @export */ export type FlatStockPickOrderDto = AbstractFlatStockPickOrderBaseDto; diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/internal-authenticated-user-dto.ts b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/internal-authenticated-user-dto.ts index b3d1d3737cab..c8c709ddcd39 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/internal-authenticated-user-dto.ts +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/internal-authenticated-user-dto.ts @@ -22,7 +22,6 @@ import type { BranchDto } from './branch-dto'; /** * @type InternalAuthenticatedUserDto - * @export */ export type InternalAuthenticatedUserDto = AbstractUserDto; diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/remote-authenticated-user-dto.ts b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/remote-authenticated-user-dto.ts index 0cfe57c46a78..6b1ebe52355e 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/remote-authenticated-user-dto.ts +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/model/remote-authenticated-user-dto.ts @@ -22,7 +22,6 @@ import type { BranchDto } from './branch-dto'; /** * @type RemoteAuthenticatedUserDto - * @export */ export type RemoteAuthenticatedUserDto = AbstractUserDto; diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/api.ts b/samples/client/petstore/typescript-axios/builds/composed-schemas/api.ts index 0d660bab09db..a31c699ac3e8 100644 --- a/samples/client/petstore/typescript-axios/builds/composed-schemas/api.ts +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/api.ts @@ -23,42 +23,15 @@ import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; -/** - * - * @export - * @interface Cat - */ export interface Cat { - /** - * - * @type {boolean} - * @memberof Cat - */ 'hunts'?: boolean; - /** - * - * @type {number} - * @memberof Cat - */ 'age'?: number; } /** * Dog information - * @export - * @interface Dog */ export interface Dog { - /** - * - * @type {boolean} - * @memberof Dog - */ 'bark'?: boolean; - /** - * - * @type {string} - * @memberof Dog - */ 'breed'?: DogBreedEnum; } @@ -71,55 +44,15 @@ export const DogBreedEnum = { export type DogBreedEnum = typeof DogBreedEnum[keyof typeof DogBreedEnum]; -/** - * - * @export - * @interface FilePostRequest - */ export interface FilePostRequest { - /** - * - * @type {any} - * @memberof FilePostRequest - */ 'file'?: any; } -/** - * - * @export - * @interface PetByAge - */ export interface PetByAge { - /** - * - * @type {number} - * @memberof PetByAge - */ 'age': number; - /** - * - * @type {string} - * @memberof PetByAge - */ 'nickname'?: string; } -/** - * - * @export - * @interface PetByType - */ export interface PetByType { - /** - * - * @type {string} - * @memberof PetByType - */ 'pet_type': PetByTypePetTypeEnum; - /** - * - * @type {boolean} - * @memberof PetByType - */ 'hunts'?: boolean; } @@ -130,35 +63,10 @@ export const PetByTypePetTypeEnum = { export type PetByTypePetTypeEnum = typeof PetByTypePetTypeEnum[keyof typeof PetByTypePetTypeEnum]; -/** - * - * @export - * @interface PetsFilteredPatchRequest - */ export interface PetsFilteredPatchRequest { - /** - * - * @type {number} - * @memberof PetsFilteredPatchRequest - */ 'age': number; - /** - * - * @type {string} - * @memberof PetsFilteredPatchRequest - */ 'nickname'?: string; - /** - * - * @type {string} - * @memberof PetsFilteredPatchRequest - */ 'pet_type': PetsFilteredPatchRequestPetTypeEnum; - /** - * - * @type {boolean} - * @memberof PetsFilteredPatchRequest - */ 'hunts'?: boolean; } @@ -171,14 +79,12 @@ export type PetsFilteredPatchRequestPetTypeEnum = typeof PetsFilteredPatchReques /** * @type PetsPatchRequest - * @export */ export type PetsPatchRequest = Cat | Dog | any; /** * DefaultApi - axios parameter creator - * @export */ export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -286,7 +192,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * DefaultApi - functional programming interface - * @export */ export const DefaultApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration) @@ -332,7 +237,6 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * DefaultApi - factory interface - * @export */ export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = DefaultApiFp(configuration) @@ -369,9 +273,6 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa /** * DefaultApi - object-oriented interface - * @export - * @class DefaultApi - * @extends {BaseAPI} */ export class DefaultApi extends BaseAPI { /** @@ -379,7 +280,6 @@ export class DefaultApi extends BaseAPI { * @param {FilePostRequest} [filePostRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DefaultApi */ public filePost(filePostRequest?: FilePostRequest, options?: RawAxiosRequestConfig) { return DefaultApiFp(this.configuration).filePost(filePostRequest, options).then((request) => request(this.axios, this.basePath)); @@ -390,7 +290,6 @@ export class DefaultApi extends BaseAPI { * @param {PetsFilteredPatchRequest} [petsFilteredPatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DefaultApi */ public petsFilteredPatch(petsFilteredPatchRequest?: PetsFilteredPatchRequest, options?: RawAxiosRequestConfig) { return DefaultApiFp(this.configuration).petsFilteredPatch(petsFilteredPatchRequest, options).then((request) => request(this.axios, this.basePath)); @@ -401,7 +300,6 @@ export class DefaultApi extends BaseAPI { * @param {PetsPatchRequest} [petsPatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DefaultApi */ public petsPatch(petsPatchRequest?: PetsPatchRequest, options?: RawAxiosRequestConfig) { return DefaultApiFp(this.configuration).petsPatch(petsPatchRequest, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/base.ts b/samples/client/petstore/typescript-axios/builds/composed-schemas/base.ts index e215695bd26e..329ea708ed00 100644 --- a/samples/client/petstore/typescript-axios/builds/composed-schemas/base.ts +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://api.example.xyz/v1".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/common.ts b/samples/client/petstore/typescript-axios/builds/composed-schemas/common.ts index b2e7c457aaf7..ff80920e8850 100644 --- a/samples/client/petstore/typescript-axios/builds/composed-schemas/common.ts +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/configuration.ts b/samples/client/petstore/typescript-axios/builds/composed-schemas/configuration.ts index 322e144e1f63..9b343fd954ee 100644 --- a/samples/client/petstore/typescript-axios/builds/composed-schemas/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/default/api.ts b/samples/client/petstore/typescript-axios/builds/default/api.ts index a8605bb76b54..22a7ff99e9fd 100644 --- a/samples/client/petstore/typescript-axios/builds/default/api.ts +++ b/samples/client/petstore/typescript-axios/builds/default/api.ts @@ -25,89 +25,31 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -121,45 +63,16 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -173,82 +86,30 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -603,7 +464,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -723,7 +583,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -819,9 +678,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -830,7 +686,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(body, options).then((request) => request(this.axios, this.basePath)); @@ -843,7 +698,6 @@ export class PetApi extends BaseAPI { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -855,7 +709,6 @@ export class PetApi extends BaseAPI { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -868,7 +721,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -880,7 +732,6 @@ export class PetApi extends BaseAPI { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -892,7 +743,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(body, options).then((request) => request(this.axios, this.basePath)); @@ -906,7 +756,6 @@ export class PetApi extends BaseAPI { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -920,16 +769,12 @@ export class PetApi extends BaseAPI { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -940,7 +785,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1086,7 +930,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -1147,7 +990,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -1196,9 +1038,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -1207,7 +1046,6 @@ export class StoreApi extends BaseAPI { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1218,7 +1056,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -1230,7 +1067,6 @@ export class StoreApi extends BaseAPI { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1242,7 +1078,6 @@ export class StoreApi extends BaseAPI { * @param {Order} body order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(body: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(body, options).then((request) => request(this.axios, this.basePath)); @@ -1253,7 +1088,6 @@ export class StoreApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1552,7 +1386,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -1667,7 +1500,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -1758,9 +1590,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -1769,7 +1598,6 @@ export class UserApi extends BaseAPI { * @param {User} body Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(body, options).then((request) => request(this.axios, this.basePath)); @@ -1781,7 +1609,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1793,7 +1620,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1805,7 +1631,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -1817,7 +1642,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -1830,7 +1654,6 @@ export class UserApi extends BaseAPI { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -1841,7 +1664,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -1854,7 +1676,6 @@ export class UserApi extends BaseAPI { * @param {User} body Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/default/base.ts b/samples/client/petstore/typescript-axios/builds/default/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/default/base.ts +++ b/samples/client/petstore/typescript-axios/builds/default/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/default/common.ts b/samples/client/petstore/typescript-axios/builds/default/common.ts index e6be09b1fdd6..48a99b2fb1e0 100644 --- a/samples/client/petstore/typescript-axios/builds/default/common.ts +++ b/samples/client/petstore/typescript-axios/builds/default/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/default/configuration.ts b/samples/client/petstore/typescript-axios/builds/default/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/default/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/default/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/api.ts b/samples/client/petstore/typescript-axios/builds/es6-target/api.ts index a8605bb76b54..22a7ff99e9fd 100644 --- a/samples/client/petstore/typescript-axios/builds/es6-target/api.ts +++ b/samples/client/petstore/typescript-axios/builds/es6-target/api.ts @@ -25,89 +25,31 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -121,45 +63,16 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -173,82 +86,30 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -603,7 +464,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -723,7 +583,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -819,9 +678,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -830,7 +686,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(body, options).then((request) => request(this.axios, this.basePath)); @@ -843,7 +698,6 @@ export class PetApi extends BaseAPI { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -855,7 +709,6 @@ export class PetApi extends BaseAPI { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -868,7 +721,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -880,7 +732,6 @@ export class PetApi extends BaseAPI { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -892,7 +743,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(body, options).then((request) => request(this.axios, this.basePath)); @@ -906,7 +756,6 @@ export class PetApi extends BaseAPI { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -920,16 +769,12 @@ export class PetApi extends BaseAPI { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -940,7 +785,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1086,7 +930,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -1147,7 +990,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -1196,9 +1038,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -1207,7 +1046,6 @@ export class StoreApi extends BaseAPI { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1218,7 +1056,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -1230,7 +1067,6 @@ export class StoreApi extends BaseAPI { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1242,7 +1078,6 @@ export class StoreApi extends BaseAPI { * @param {Order} body order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(body: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(body, options).then((request) => request(this.axios, this.basePath)); @@ -1253,7 +1088,6 @@ export class StoreApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1552,7 +1386,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -1667,7 +1500,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -1758,9 +1590,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -1769,7 +1598,6 @@ export class UserApi extends BaseAPI { * @param {User} body Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(body, options).then((request) => request(this.axios, this.basePath)); @@ -1781,7 +1609,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1793,7 +1620,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1805,7 +1631,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -1817,7 +1642,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -1830,7 +1654,6 @@ export class UserApi extends BaseAPI { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -1841,7 +1664,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -1854,7 +1676,6 @@ export class UserApi extends BaseAPI { * @param {User} body Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/base.ts b/samples/client/petstore/typescript-axios/builds/es6-target/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/es6-target/base.ts +++ b/samples/client/petstore/typescript-axios/builds/es6-target/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/common.ts b/samples/client/petstore/typescript-axios/builds/es6-target/common.ts index e6be09b1fdd6..48a99b2fb1e0 100644 --- a/samples/client/petstore/typescript-axios/builds/es6-target/common.ts +++ b/samples/client/petstore/typescript-axios/builds/es6-target/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/configuration.ts b/samples/client/petstore/typescript-axios/builds/es6-target/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/es6-target/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/es6-target/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/api.ts b/samples/client/petstore/typescript-axios/builds/test-petstore/api.ts index 6e6e7852cf0e..96b6c5e4ffe1 100644 --- a/samples/client/petstore/typescript-axios/builds/test-petstore/api.ts +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/api.ts @@ -23,331 +23,77 @@ import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; -/** - * - * @export - * @interface AdditionalPropertiesClass - */ export interface AdditionalPropertiesClass { - /** - * - * @type {{ [key: string]: string; }} - * @memberof AdditionalPropertiesClass - */ 'map_property'?: { [key: string]: string; }; - /** - * - * @type {{ [key: string]: { [key: string]: string; }; }} - * @memberof AdditionalPropertiesClass - */ 'map_of_map_property'?: { [key: string]: { [key: string]: string; }; }; - /** - * - * @type {any} - * @memberof AdditionalPropertiesClass - */ 'anytype_1'?: any; - /** - * - * @type {object} - * @memberof AdditionalPropertiesClass - */ 'map_with_undeclared_properties_anytype_1'?: object; - /** - * - * @type {object} - * @memberof AdditionalPropertiesClass - */ 'map_with_undeclared_properties_anytype_2'?: object; - /** - * - * @type {{ [key: string]: any; }} - * @memberof AdditionalPropertiesClass - */ 'map_with_undeclared_properties_anytype_3'?: { [key: string]: any; }; /** - * an object with no declared properties and no undeclared properties, hence it\'s an empty map. - * @type {object} - * @memberof AdditionalPropertiesClass - */ + * an object with no declared properties and no undeclared properties, hence it\'s an empty map. + */ 'empty_map'?: object; - /** - * - * @type {{ [key: string]: string; }} - * @memberof AdditionalPropertiesClass - */ 'map_with_undeclared_properties_string'?: { [key: string]: string; }; } -/** - * - * @export - * @interface Animal - */ export interface Animal { - /** - * - * @type {string} - * @memberof Animal - */ 'className': string; - /** - * - * @type {string} - * @memberof Animal - */ 'color'?: string; } -/** - * - * @export - * @interface ApiResponse - */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } -/** - * - * @export - * @interface Apple - */ export interface Apple { - /** - * - * @type {string} - * @memberof Apple - */ 'cultivar'?: string; - /** - * - * @type {string} - * @memberof Apple - */ 'origin'?: string; } -/** - * - * @export - * @interface AppleReq - */ export interface AppleReq { - /** - * - * @type {string} - * @memberof AppleReq - */ 'cultivar': string; - /** - * - * @type {boolean} - * @memberof AppleReq - */ 'mealy'?: boolean; } -/** - * - * @export - * @interface ArrayOfArrayOfNumberOnly - */ export interface ArrayOfArrayOfNumberOnly { - /** - * - * @type {Array>} - * @memberof ArrayOfArrayOfNumberOnly - */ 'ArrayArrayNumber'?: Array>; } -/** - * - * @export - * @interface ArrayOfNumberOnly - */ export interface ArrayOfNumberOnly { - /** - * - * @type {Array} - * @memberof ArrayOfNumberOnly - */ 'ArrayNumber'?: Array; } -/** - * - * @export - * @interface ArrayTest - */ export interface ArrayTest { - /** - * - * @type {Array} - * @memberof ArrayTest - */ 'array_of_string'?: Array; - /** - * - * @type {Array>} - * @memberof ArrayTest - */ 'array_array_of_integer'?: Array>; - /** - * - * @type {Array>} - * @memberof ArrayTest - */ 'array_array_of_model'?: Array>; } -/** - * - * @export - * @interface Banana - */ export interface Banana { - /** - * - * @type {number} - * @memberof Banana - */ 'lengthCm'?: number; } -/** - * - * @export - * @interface BananaReq - */ export interface BananaReq { - /** - * - * @type {number} - * @memberof BananaReq - */ 'lengthCm': number; - /** - * - * @type {boolean} - * @memberof BananaReq - */ 'sweet'?: boolean; } -/** - * - * @export - * @interface BasquePig - */ export interface BasquePig { - /** - * - * @type {string} - * @memberof BasquePig - */ 'className': string; } -/** - * - * @export - * @interface Capitalization - */ export interface Capitalization { - /** - * - * @type {string} - * @memberof Capitalization - */ 'smallCamel'?: string; - /** - * - * @type {string} - * @memberof Capitalization - */ 'CapitalCamel'?: string; - /** - * - * @type {string} - * @memberof Capitalization - */ 'small_Snake'?: string; - /** - * - * @type {string} - * @memberof Capitalization - */ 'Capital_Snake'?: string; - /** - * - * @type {string} - * @memberof Capitalization - */ 'SCA_ETH_Flow_Points'?: string; /** - * Name of the pet - * @type {string} - * @memberof Capitalization - */ + * Name of the pet + */ 'ATT_NAME'?: string; } -/** - * - * @export - * @interface Cat - */ export interface Cat extends Animal { - /** - * - * @type {boolean} - * @memberof Cat - */ 'declawed'?: boolean; } -/** - * - * @export - * @interface Category - */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name': string; } -/** - * - * @export - * @interface ChildCat - */ export interface ChildCat extends ParentPet { - /** - * - * @type {string} - * @memberof ChildCat - */ 'name'?: string; - /** - * - * @type {string} - * @memberof ChildCat - */ 'pet_type'?: ChildCatPetTypeEnum; } @@ -359,138 +105,36 @@ export type ChildCatPetTypeEnum = typeof ChildCatPetTypeEnum[keyof typeof ChildC /** * Model for testing model with \"_class\" property - * @export - * @interface ClassModel */ export interface ClassModel { - /** - * - * @type {string} - * @memberof ClassModel - */ '_class'?: string; } -/** - * - * @export - * @interface Client - */ export interface Client { - /** - * - * @type {string} - * @memberof Client - */ 'client'?: string; } -/** - * - * @export - * @interface ComplexQuadrilateral - */ export interface ComplexQuadrilateral { - /** - * - * @type {string} - * @memberof ComplexQuadrilateral - */ 'shapeType': string; - /** - * - * @type {string} - * @memberof ComplexQuadrilateral - */ 'quadrilateralType': string; } -/** - * - * @export - * @interface DanishPig - */ export interface DanishPig { - /** - * - * @type {string} - * @memberof DanishPig - */ 'className': string; } -/** - * - * @export - * @interface DeprecatedObject - */ export interface DeprecatedObject { - /** - * - * @type {string} - * @memberof DeprecatedObject - */ 'name'?: string; } -/** - * - * @export - * @interface Dog - */ export interface Dog extends Animal { - /** - * - * @type {string} - * @memberof Dog - */ 'breed'?: string; } -/** - * - * @export - * @interface Drawing - */ export interface Drawing { [key: string]: Fruit | any; - /** - * - * @type {Shape} - * @memberof Drawing - */ 'mainShape'?: Shape; - /** - * - * @type {ShapeOrNull} - * @memberof Drawing - */ 'shapeOrNull'?: ShapeOrNull | null; - /** - * - * @type {NullableShape} - * @memberof Drawing - */ 'nullableShape'?: NullableShape | null; - /** - * - * @type {Array} - * @memberof Drawing - */ 'shapes'?: Array; } -/** - * - * @export - * @interface EnumArrays - */ export interface EnumArrays { - /** - * - * @type {string} - * @memberof EnumArrays - */ 'just_symbol'?: EnumArraysJustSymbolEnum; - /** - * - * @type {Array} - * @memberof EnumArrays - */ 'array_enum'?: Array; } @@ -507,11 +151,6 @@ export const EnumArraysArrayEnumEnum = { export type EnumArraysArrayEnumEnum = typeof EnumArraysArrayEnumEnum[keyof typeof EnumArraysArrayEnumEnum]; -/** - * - * @export - * @enum {string} - */ export const EnumClass = { Abc: '_abc', @@ -522,65 +161,15 @@ export const EnumClass = { export type EnumClass = typeof EnumClass[keyof typeof EnumClass]; -/** - * - * @export - * @interface EnumTest - */ export interface EnumTest { - /** - * - * @type {string} - * @memberof EnumTest - */ 'enum_string'?: EnumTestEnumStringEnum; - /** - * - * @type {string} - * @memberof EnumTest - */ 'enum_string_required': EnumTestEnumStringRequiredEnum; - /** - * - * @type {number} - * @memberof EnumTest - */ 'enum_integer'?: EnumTestEnumIntegerEnum; - /** - * - * @type {number} - * @memberof EnumTest - */ 'enum_integer_only'?: EnumTestEnumIntegerOnlyEnum; - /** - * - * @type {number} - * @memberof EnumTest - */ 'enum_number'?: EnumTestEnumNumberEnum; - /** - * - * @type {OuterEnum} - * @memberof EnumTest - */ 'outerEnum'?: OuterEnum | null; - /** - * - * @type {OuterEnumInteger} - * @memberof EnumTest - */ 'outerEnumInteger'?: OuterEnumInteger; - /** - * - * @type {OuterEnumDefaultValue} - * @memberof EnumTest - */ 'outerEnumDefaultValue'?: OuterEnumDefaultValue; - /** - * - * @type {OuterEnumIntegerDefaultValue} - * @memberof EnumTest - */ 'outerEnumIntegerDefaultValue'?: OuterEnumIntegerDefaultValue; } @@ -617,328 +206,89 @@ export const EnumTestEnumNumberEnum = { export type EnumTestEnumNumberEnum = typeof EnumTestEnumNumberEnum[keyof typeof EnumTestEnumNumberEnum]; -/** - * - * @export - * @interface EquilateralTriangle - */ export interface EquilateralTriangle { - /** - * - * @type {string} - * @memberof EquilateralTriangle - */ 'shapeType': string; - /** - * - * @type {string} - * @memberof EquilateralTriangle - */ 'triangleType': string; } -/** - * - * @export - * @interface FileSchemaTestClass - */ export interface FileSchemaTestClass { - /** - * - * @type {any} - * @memberof FileSchemaTestClass - */ 'file'?: any; - /** - * - * @type {Array} - * @memberof FileSchemaTestClass - */ 'files'?: Array; } -/** - * - * @export - * @interface Foo - */ export interface Foo { - /** - * - * @type {string} - * @memberof Foo - */ 'bar'?: string; } -/** - * - * @export - * @interface FooGetDefaultResponse - */ export interface FooGetDefaultResponse { - /** - * - * @type {Foo} - * @memberof FooGetDefaultResponse - */ 'string'?: Foo; } -/** - * - * @export - * @interface FormatTest - */ export interface FormatTest { - /** - * - * @type {number} - * @memberof FormatTest - */ 'integer'?: number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'int32'?: number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'int64'?: number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'number': number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'float'?: number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'double'?: number; - /** - * - * @type {string} - * @memberof FormatTest - */ 'decimal'?: string; - /** - * - * @type {string} - * @memberof FormatTest - */ 'string'?: string; - /** - * - * @type {string} - * @memberof FormatTest - */ 'byte': string; - /** - * - * @type {File} - * @memberof FormatTest - */ 'binary'?: File; - /** - * - * @type {string} - * @memberof FormatTest - */ 'date': string; - /** - * - * @type {string} - * @memberof FormatTest - */ 'dateTime'?: string; - /** - * - * @type {string} - * @memberof FormatTest - */ 'uuid'?: string; - /** - * - * @type {string} - * @memberof FormatTest - */ 'password': string; /** - * A string that is a 10 digit number. Can have leading zeros. - * @type {string} - * @memberof FormatTest - */ + * A string that is a 10 digit number. Can have leading zeros. + */ 'pattern_with_digits'?: string; /** - * A string starting with \'image_\' (case insensitive) and one to three digits following i.e. Image_01. - * @type {string} - * @memberof FormatTest - */ + * A string starting with \'image_\' (case insensitive) and one to three digits following i.e. Image_01. + */ 'pattern_with_digits_and_delimiter'?: string; } /** * @type Fruit - * @export */ export type Fruit = Apple | Banana; /** * @type FruitReq - * @export */ export type FruitReq = AppleReq | BananaReq; -/** - * - * @export - * @interface GmFruit - */ export interface GmFruit { - /** - * - * @type {string} - * @memberof GmFruit - */ 'color'?: string; - /** - * - * @type {string} - * @memberof GmFruit - */ 'cultivar'?: string; - /** - * - * @type {string} - * @memberof GmFruit - */ 'origin'?: string; - /** - * - * @type {number} - * @memberof GmFruit - */ 'lengthCm'?: number; } -/** - * - * @export - * @interface GrandparentAnimal - */ export interface GrandparentAnimal { - /** - * - * @type {string} - * @memberof GrandparentAnimal - */ 'pet_type': string; } -/** - * - * @export - * @interface HasOnlyReadOnly - */ export interface HasOnlyReadOnly { - /** - * - * @type {string} - * @memberof HasOnlyReadOnly - */ 'bar'?: string; - /** - * - * @type {string} - * @memberof HasOnlyReadOnly - */ 'foo'?: string; } /** * Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model. - * @export - * @interface HealthCheckResult */ export interface HealthCheckResult { - /** - * - * @type {string} - * @memberof HealthCheckResult - */ 'NullableMessage'?: string | null; } -/** - * - * @export - * @interface IsoscelesTriangle - */ export interface IsoscelesTriangle { - /** - * - * @type {string} - * @memberof IsoscelesTriangle - */ 'shapeType': string; - /** - * - * @type {string} - * @memberof IsoscelesTriangle - */ 'triangleType': string; } -/** - * - * @export - * @interface List - */ export interface List { - /** - * - * @type {string} - * @memberof List - */ '123-list'?: string; } /** * @type Mammal - * @export */ export type Mammal = Pig | Whale | Zebra; -/** - * - * @export - * @interface MammalAnyof - */ export interface MammalAnyof { - /** - * - * @type {boolean} - * @memberof MammalAnyof - */ 'hasBaleen'?: boolean; - /** - * - * @type {boolean} - * @memberof MammalAnyof - */ 'hasTeeth'?: boolean; - /** - * - * @type {string} - * @memberof MammalAnyof - */ 'className': string; - /** - * - * @type {string} - * @memberof MammalAnyof - */ 'type'?: MammalAnyofTypeEnum; } @@ -950,35 +300,10 @@ export const MammalAnyofTypeEnum = { export type MammalAnyofTypeEnum = typeof MammalAnyofTypeEnum[keyof typeof MammalAnyofTypeEnum]; -/** - * - * @export - * @interface MapTest - */ export interface MapTest { - /** - * - * @type {{ [key: string]: { [key: string]: string; }; }} - * @memberof MapTest - */ 'map_map_of_string'?: { [key: string]: { [key: string]: string; }; }; - /** - * - * @type {{ [key: string]: string; }} - * @memberof MapTest - */ 'map_of_enum_string'?: { [key: string]: string; }; - /** - * - * @type {{ [key: string]: boolean; }} - * @memberof MapTest - */ 'direct_map'?: { [key: string]: boolean; }; - /** - * - * @type {{ [key: string]: boolean; }} - * @memberof MapTest - */ 'indirect_map'?: { [key: string]: boolean; }; } @@ -989,270 +314,88 @@ export const MapTestMapOfEnumStringEnum = { export type MapTestMapOfEnumStringEnum = typeof MapTestMapOfEnumStringEnum[keyof typeof MapTestMapOfEnumStringEnum]; -/** - * - * @export - * @interface MixedPropertiesAndAdditionalPropertiesClass - */ export interface MixedPropertiesAndAdditionalPropertiesClass { - /** - * - * @type {string} - * @memberof MixedPropertiesAndAdditionalPropertiesClass - */ 'uuid'?: string; - /** - * - * @type {string} - * @memberof MixedPropertiesAndAdditionalPropertiesClass - */ 'dateTime'?: string; - /** - * - * @type {{ [key: string]: Animal; }} - * @memberof MixedPropertiesAndAdditionalPropertiesClass - */ 'map'?: { [key: string]: Animal; }; } /** * Model for testing model name starting with number - * @export - * @interface Model200Response */ export interface Model200Response { - /** - * - * @type {number} - * @memberof Model200Response - */ 'name'?: number; - /** - * - * @type {string} - * @memberof Model200Response - */ 'class'?: string; } /** * Must be named `File` for test. - * @export - * @interface ModelFile */ export interface ModelFile { /** - * Test capitalization - * @type {string} - * @memberof ModelFile - */ + * Test capitalization + */ 'sourceURI'?: string; } /** * Model for testing model name same as property name - * @export - * @interface Name */ export interface Name { - /** - * - * @type {number} - * @memberof Name - */ 'name': number; - /** - * - * @type {number} - * @memberof Name - */ 'snake_case'?: number; - /** - * - * @type {string} - * @memberof Name - */ 'property'?: string; - /** - * - * @type {number} - * @memberof Name - */ '123Number'?: number; } -/** - * - * @export - * @interface NullableClass - */ export interface NullableClass { [key: string]: object | any; - /** - * - * @type {number} - * @memberof NullableClass - */ 'integer_prop'?: number | null; - /** - * - * @type {number} - * @memberof NullableClass - */ 'number_prop'?: number | null; - /** - * - * @type {boolean} - * @memberof NullableClass - */ 'boolean_prop'?: boolean | null; - /** - * - * @type {string} - * @memberof NullableClass - */ 'string_prop'?: string | null; - /** - * - * @type {string} - * @memberof NullableClass - */ 'date_prop'?: string | null; - /** - * - * @type {string} - * @memberof NullableClass - */ 'datetime_prop'?: string | null; - /** - * - * @type {Array} - * @memberof NullableClass - */ 'array_nullable_prop'?: Array | null; - /** - * - * @type {Array} - * @memberof NullableClass - */ 'array_and_items_nullable_prop'?: Array | null; - /** - * - * @type {Array} - * @memberof NullableClass - */ 'array_items_nullable'?: Array; - /** - * - * @type {{ [key: string]: object; }} - * @memberof NullableClass - */ 'object_nullable_prop'?: { [key: string]: object; } | null; - /** - * - * @type {{ [key: string]: object | null; }} - * @memberof NullableClass - */ 'object_and_items_nullable_prop'?: { [key: string]: object | null; } | null; - /** - * - * @type {{ [key: string]: object | null; }} - * @memberof NullableClass - */ 'object_items_nullable'?: { [key: string]: object | null; }; } /** * @type NullableShape * The value may be a shape or the \'null\' value. The \'nullable\' attribute was introduced in OAS schema >= 3.0 and has been deprecated in OAS schema >= 3.1. - * @export */ export type NullableShape = Quadrilateral | Triangle; -/** - * - * @export - * @interface NumberOnly - */ export interface NumberOnly { - /** - * - * @type {number} - * @memberof NumberOnly - */ 'JustNumber'?: number; } -/** - * - * @export - * @interface ObjectWithDeprecatedFields - */ export interface ObjectWithDeprecatedFields { - /** - * - * @type {string} - * @memberof ObjectWithDeprecatedFields - */ 'uuid'?: string; /** - * - * @type {number} - * @memberof ObjectWithDeprecatedFields - * @deprecated - */ + * + * @deprecated + */ 'id'?: number; /** - * - * @type {DeprecatedObject} - * @memberof ObjectWithDeprecatedFields - * @deprecated - */ + * + * @deprecated + */ 'deprecatedRef'?: DeprecatedObject; /** - * - * @type {Array} - * @memberof ObjectWithDeprecatedFields - * @deprecated - */ + * + * @deprecated + */ 'bars'?: Array; } -/** - * - * @export - * @interface Order - */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -1264,36 +407,11 @@ export const OrderStatusEnum = { export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum]; -/** - * - * @export - * @interface OuterComposite - */ export interface OuterComposite { - /** - * - * @type {number} - * @memberof OuterComposite - */ 'my_number'?: number; - /** - * - * @type {string} - * @memberof OuterComposite - */ 'my_string'?: string; - /** - * - * @type {boolean} - * @memberof OuterComposite - */ 'my_boolean'?: boolean; } -/** - * - * @export - * @enum {string} - */ export const OuterEnum = { Placed: 'placed', @@ -1304,11 +422,6 @@ export const OuterEnum = { export type OuterEnum = typeof OuterEnum[keyof typeof OuterEnum]; -/** - * - * @export - * @enum {string} - */ export const OuterEnumDefaultValue = { Placed: 'placed', @@ -1319,11 +432,6 @@ export const OuterEnumDefaultValue = { export type OuterEnumDefaultValue = typeof OuterEnumDefaultValue[keyof typeof OuterEnumDefaultValue]; -/** - * - * @export - * @enum {number} - */ export const OuterEnumInteger = { NUMBER_0: 0, @@ -1334,11 +442,6 @@ export const OuterEnumInteger = { export type OuterEnumInteger = typeof OuterEnumInteger[keyof typeof OuterEnumInteger]; -/** - * - * @export - * @enum {number} - */ export const OuterEnumIntegerDefaultValue = { NUMBER_0: 0, @@ -1349,54 +452,17 @@ export const OuterEnumIntegerDefaultValue = { export type OuterEnumIntegerDefaultValue = typeof OuterEnumIntegerDefaultValue[keyof typeof OuterEnumIntegerDefaultValue]; -/** - * - * @export - * @interface ParentPet - */ export interface ParentPet extends GrandparentAnimal { } -/** - * - * @export - * @interface Pet - */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -1410,320 +476,108 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; /** * @type Pig - * @export */ export type Pig = BasquePig | DanishPig; /** * @type Quadrilateral - * @export */ export type Quadrilateral = ComplexQuadrilateral | SimpleQuadrilateral; -/** - * - * @export - * @interface QuadrilateralInterface - */ export interface QuadrilateralInterface { - /** - * - * @type {string} - * @memberof QuadrilateralInterface - */ 'quadrilateralType': string; } -/** - * - * @export - * @interface ReadOnlyFirst - */ export interface ReadOnlyFirst { - /** - * - * @type {string} - * @memberof ReadOnlyFirst - */ 'bar'?: string; - /** - * - * @type {string} - * @memberof ReadOnlyFirst - */ 'baz'?: string; } /** * Model for testing reserved words - * @export - * @interface Return */ export interface Return { - /** - * - * @type {number} - * @memberof Return - */ 'return'?: number; } -/** - * - * @export - * @interface ScaleneTriangle - */ export interface ScaleneTriangle { - /** - * - * @type {string} - * @memberof ScaleneTriangle - */ 'shapeType': string; - /** - * - * @type {string} - * @memberof ScaleneTriangle - */ 'triangleType': string; } /** * @type Shape - * @export */ export type Shape = Quadrilateral | Triangle; -/** - * - * @export - * @interface ShapeInterface - */ export interface ShapeInterface { - /** - * - * @type {string} - * @memberof ShapeInterface - */ 'shapeType': string; } /** * @type ShapeOrNull * The value may be a shape or the \'null\' value. This is introduced in OAS schema >= 3.1. - * @export */ export type ShapeOrNull = Quadrilateral | Triangle; -/** - * - * @export - * @interface SimpleQuadrilateral - */ export interface SimpleQuadrilateral { - /** - * - * @type {string} - * @memberof SimpleQuadrilateral - */ 'shapeType': string; - /** - * - * @type {string} - * @memberof SimpleQuadrilateral - */ 'quadrilateralType': string; } -/** - * - * @export - * @interface SpecialModelName - */ export interface SpecialModelName { - /** - * - * @type {number} - * @memberof SpecialModelName - */ '$special[property.name]'?: number; - /** - * - * @type {string} - * @memberof SpecialModelName - */ '_special_model.name_'?: string; } -/** - * - * @export - * @interface Tag - */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } -/** - * - * @export - * @interface TestInlineFreeformAdditionalPropertiesRequest - */ export interface TestInlineFreeformAdditionalPropertiesRequest { [key: string]: any; - /** - * - * @type {string} - * @memberof TestInlineFreeformAdditionalPropertiesRequest - */ 'someProperty'?: string; } /** * @type Triangle - * @export */ export type Triangle = EquilateralTriangle | IsoscelesTriangle | ScaleneTriangle; -/** - * - * @export - * @interface TriangleInterface - */ export interface TriangleInterface { - /** - * - * @type {string} - * @memberof TriangleInterface - */ 'triangleType': string; } -/** - * - * @export - * @interface User - */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; /** - * test code generation for objects Value must be a map of strings to values. It cannot be the \'null\' value. - * @type {object} - * @memberof User - */ + * test code generation for objects Value must be a map of strings to values. It cannot be the \'null\' value. + */ 'objectWithNoDeclaredProps'?: object; /** - * test code generation for nullable objects. Value must be a map of strings to values or the \'null\' value. - * @type {object} - * @memberof User - */ + * test code generation for nullable objects. Value must be a map of strings to values or the \'null\' value. + */ 'objectWithNoDeclaredPropsNullable'?: object | null; /** - * test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. See https://github.com/OAI/OpenAPI-Specification/issues/1389 - * @type {any} - * @memberof User - */ + * test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. See https://github.com/OAI/OpenAPI-Specification/issues/1389 + */ 'anyTypeProp'?: any; /** - * test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. The \'nullable\' attribute does not change the allowed values. - * @type {any} - * @memberof User - */ + * test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. The \'nullable\' attribute does not change the allowed values. + */ 'anyTypePropNullable'?: any | null; } -/** - * - * @export - * @interface Whale - */ export interface Whale { - /** - * - * @type {boolean} - * @memberof Whale - */ 'hasBaleen'?: boolean; - /** - * - * @type {boolean} - * @memberof Whale - */ 'hasTeeth'?: boolean; - /** - * - * @type {string} - * @memberof Whale - */ 'className': string; } -/** - * - * @export - * @interface Zebra - */ export interface Zebra { [key: string]: any; - /** - * - * @type {string} - * @memberof Zebra - */ 'type'?: ZebraTypeEnum; - /** - * - * @type {string} - * @memberof Zebra - */ 'className': string; } @@ -1738,7 +592,6 @@ export type ZebraTypeEnum = typeof ZebraTypeEnum[keyof typeof ZebraTypeEnum]; /** * AnotherFakeApi - axios parameter creator - * @export */ export const AnotherFakeApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1783,7 +636,6 @@ export const AnotherFakeApiAxiosParamCreator = function (configuration?: Configu /** * AnotherFakeApi - functional programming interface - * @export */ export const AnotherFakeApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = AnotherFakeApiAxiosParamCreator(configuration) @@ -1806,7 +658,6 @@ export const AnotherFakeApiFp = function(configuration?: Configuration) { /** * AnotherFakeApi - factory interface - * @export */ export const AnotherFakeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = AnotherFakeApiFp(configuration) @@ -1826,9 +677,6 @@ export const AnotherFakeApiFactory = function (configuration?: Configuration, ba /** * AnotherFakeApi - object-oriented interface - * @export - * @class AnotherFakeApi - * @extends {BaseAPI} */ export class AnotherFakeApi extends BaseAPI { /** @@ -1837,7 +685,6 @@ export class AnotherFakeApi extends BaseAPI { * @param {Client} client client model * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AnotherFakeApi */ public _123testSpecialTags(client: Client, options?: RawAxiosRequestConfig) { return AnotherFakeApiFp(this.configuration)._123testSpecialTags(client, options).then((request) => request(this.axios, this.basePath)); @@ -1848,7 +695,6 @@ export class AnotherFakeApi extends BaseAPI { /** * DefaultApi - axios parameter creator - * @export */ export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1886,7 +732,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * DefaultApi - functional programming interface - * @export */ export const DefaultApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration) @@ -1907,7 +752,6 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * DefaultApi - factory interface - * @export */ export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = DefaultApiFp(configuration) @@ -1925,16 +769,12 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa /** * DefaultApi - object-oriented interface - * @export - * @class DefaultApi - * @extends {BaseAPI} */ export class DefaultApi extends BaseAPI { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DefaultApi */ public fooGet(options?: RawAxiosRequestConfig) { return DefaultApiFp(this.configuration).fooGet(options).then((request) => request(this.axios, this.basePath)); @@ -1945,7 +785,6 @@ export class DefaultApi extends BaseAPI { /** * FakeApi - axios parameter creator - * @export */ export const FakeApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -2810,7 +1649,6 @@ export const FakeApiAxiosParamCreator = function (configuration?: Configuration) /** * FakeApi - functional programming interface - * @export */ export const FakeApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = FakeApiAxiosParamCreator(configuration) @@ -3089,7 +1927,6 @@ export const FakeApiFp = function(configuration?: Configuration) { /** * FakeApi - factory interface - * @export */ export const FakeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = FakeApiFp(configuration) @@ -3311,9 +2148,6 @@ export const FakeApiFactory = function (configuration?: Configuration, basePath? /** * FakeApi - object-oriented interface - * @export - * @class FakeApi - * @extends {BaseAPI} */ export class FakeApi extends BaseAPI { /** @@ -3321,7 +2155,6 @@ export class FakeApi extends BaseAPI { * @summary Health check endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeHealthGet(options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeHealthGet(options).then((request) => request(this.axios, this.basePath)); @@ -3332,7 +2165,6 @@ export class FakeApi extends BaseAPI { * @param {boolean} [body] Input boolean as post body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeOuterBooleanSerialize(body?: boolean, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeOuterBooleanSerialize(body, options).then((request) => request(this.axios, this.basePath)); @@ -3343,7 +2175,6 @@ export class FakeApi extends BaseAPI { * @param {OuterComposite} [outerComposite] Input composite as post body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeOuterCompositeSerialize(outerComposite?: OuterComposite, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeOuterCompositeSerialize(outerComposite, options).then((request) => request(this.axios, this.basePath)); @@ -3354,7 +2185,6 @@ export class FakeApi extends BaseAPI { * @param {number} [body] Input number as post body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeOuterNumberSerialize(body?: number, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeOuterNumberSerialize(body, options).then((request) => request(this.axios, this.basePath)); @@ -3365,7 +2195,6 @@ export class FakeApi extends BaseAPI { * @param {string} [body] Input string as post body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeOuterStringSerialize(body?: string, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeOuterStringSerialize(body, options).then((request) => request(this.axios, this.basePath)); @@ -3376,7 +2205,6 @@ export class FakeApi extends BaseAPI { * @summary Array of Enums * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public getArrayOfEnums(options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).getArrayOfEnums(options).then((request) => request(this.axios, this.basePath)); @@ -3388,7 +2216,6 @@ export class FakeApi extends BaseAPI { * @param {Array} [requestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public postArrayOfString(requestBody?: Array, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).postArrayOfString(requestBody, options).then((request) => request(this.axios, this.basePath)); @@ -3400,7 +2227,6 @@ export class FakeApi extends BaseAPI { * @param {{ [key: string]: any; }} requestBody request body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testAdditionalPropertiesReference(requestBody: { [key: string]: any; }, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testAdditionalPropertiesReference(requestBody, options).then((request) => request(this.axios, this.basePath)); @@ -3411,7 +2237,6 @@ export class FakeApi extends BaseAPI { * @param {FileSchemaTestClass} fileSchemaTestClass * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testBodyWithFileSchema(fileSchemaTestClass: FileSchemaTestClass, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testBodyWithFileSchema(fileSchemaTestClass, options).then((request) => request(this.axios, this.basePath)); @@ -3423,7 +2248,6 @@ export class FakeApi extends BaseAPI { * @param {User} user * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testBodyWithQueryParams(query: string, user: User, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testBodyWithQueryParams(query, user, options).then((request) => request(this.axios, this.basePath)); @@ -3435,7 +2259,6 @@ export class FakeApi extends BaseAPI { * @param {Client} client client model * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testClientModel(client: Client, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testClientModel(client, options).then((request) => request(this.axios, this.basePath)); @@ -3460,7 +2283,6 @@ export class FakeApi extends BaseAPI { * @param {string} [callback] None * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testEndpointParameters(number: number, _double: number, patternWithoutDelimiter: string, _byte: string, integer?: number, int32?: number, int64?: number, _float?: number, string?: string, binary?: File, date?: string, dateTime?: string, password?: string, callback?: string, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, callback, options).then((request) => request(this.axios, this.basePath)); @@ -3479,7 +2301,6 @@ export class FakeApi extends BaseAPI { * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testEnumParameters(enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString, options).then((request) => request(this.axios, this.basePath)); @@ -3496,7 +2317,6 @@ export class FakeApi extends BaseAPI { * @param {number} [int64Group] Integer in group parameters * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testGroupParameters(requiredStringGroup: number, requiredBooleanGroup: boolean, requiredInt64Group: number, stringGroup?: number, booleanGroup?: boolean, int64Group?: number, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group, options).then((request) => request(this.axios, this.basePath)); @@ -3508,7 +2328,6 @@ export class FakeApi extends BaseAPI { * @param {{ [key: string]: string; }} requestBody request body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testInlineAdditionalProperties(requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testInlineAdditionalProperties(requestBody, options).then((request) => request(this.axios, this.basePath)); @@ -3520,7 +2339,6 @@ export class FakeApi extends BaseAPI { * @param {TestInlineFreeformAdditionalPropertiesRequest} testInlineFreeformAdditionalPropertiesRequest request body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testInlineFreeformAdditionalProperties(testInlineFreeformAdditionalPropertiesRequest: TestInlineFreeformAdditionalPropertiesRequest, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testInlineFreeformAdditionalProperties(testInlineFreeformAdditionalPropertiesRequest, options).then((request) => request(this.axios, this.basePath)); @@ -3533,7 +2351,6 @@ export class FakeApi extends BaseAPI { * @param {string} param2 field2 * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testJsonFormData(param: string, param2: string, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testJsonFormData(param, param2, options).then((request) => request(this.axios, this.basePath)); @@ -3548,7 +2365,6 @@ export class FakeApi extends BaseAPI { * @param {Array} context * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testQueryParameterCollectionFormat(pipe: Array, ioutil: Array, http: Array, url: Array, context: Array, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testQueryParameterCollectionFormat(pipe, ioutil, http, url, context, options).then((request) => request(this.axios, this.basePath)); @@ -3560,74 +2376,49 @@ export class FakeApi extends BaseAPI { * @param {{ [key: string]: string; }} requestBody request body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testStringMapReference(requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testStringMapReference(requestBody, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const TestEnumParametersEnumHeaderStringArrayEnum = { GreaterThan: '>', Dollar: '$' } as const; export type TestEnumParametersEnumHeaderStringArrayEnum = typeof TestEnumParametersEnumHeaderStringArrayEnum[keyof typeof TestEnumParametersEnumHeaderStringArrayEnum]; -/** - * @export - */ export const TestEnumParametersEnumHeaderStringEnum = { Abc: '_abc', Efg: '-efg', Xyz: '(xyz)' } as const; export type TestEnumParametersEnumHeaderStringEnum = typeof TestEnumParametersEnumHeaderStringEnum[keyof typeof TestEnumParametersEnumHeaderStringEnum]; -/** - * @export - */ export const TestEnumParametersEnumQueryStringArrayEnum = { GreaterThan: '>', Dollar: '$' } as const; export type TestEnumParametersEnumQueryStringArrayEnum = typeof TestEnumParametersEnumQueryStringArrayEnum[keyof typeof TestEnumParametersEnumQueryStringArrayEnum]; -/** - * @export - */ export const TestEnumParametersEnumQueryStringEnum = { Abc: '_abc', Efg: '-efg', Xyz: '(xyz)' } as const; export type TestEnumParametersEnumQueryStringEnum = typeof TestEnumParametersEnumQueryStringEnum[keyof typeof TestEnumParametersEnumQueryStringEnum]; -/** - * @export - */ export const TestEnumParametersEnumQueryIntegerEnum = { NUMBER_1: 1, NUMBER_MINUS_2: -2 } as const; export type TestEnumParametersEnumQueryIntegerEnum = typeof TestEnumParametersEnumQueryIntegerEnum[keyof typeof TestEnumParametersEnumQueryIntegerEnum]; -/** - * @export - */ export const TestEnumParametersEnumQueryDoubleEnum = { NUMBER_1_DOT_1: 1.1, NUMBER_MINUS_1_DOT_2: -1.2 } as const; export type TestEnumParametersEnumQueryDoubleEnum = typeof TestEnumParametersEnumQueryDoubleEnum[keyof typeof TestEnumParametersEnumQueryDoubleEnum]; -/** - * @export - */ export const TestEnumParametersEnumFormStringArrayEnum = { GreaterThan: '>', Dollar: '$' } as const; export type TestEnumParametersEnumFormStringArrayEnum = typeof TestEnumParametersEnumFormStringArrayEnum[keyof typeof TestEnumParametersEnumFormStringArrayEnum]; -/** - * @export - */ export const TestEnumParametersEnumFormStringEnum = { Abc: '_abc', Efg: '-efg', @@ -3638,7 +2429,6 @@ export type TestEnumParametersEnumFormStringEnum = typeof TestEnumParametersEnum /** * FakeClassnameTags123Api - axios parameter creator - * @export */ export const FakeClassnameTags123ApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -3686,7 +2476,6 @@ export const FakeClassnameTags123ApiAxiosParamCreator = function (configuration? /** * FakeClassnameTags123Api - functional programming interface - * @export */ export const FakeClassnameTags123ApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = FakeClassnameTags123ApiAxiosParamCreator(configuration) @@ -3709,7 +2498,6 @@ export const FakeClassnameTags123ApiFp = function(configuration?: Configuration) /** * FakeClassnameTags123Api - factory interface - * @export */ export const FakeClassnameTags123ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = FakeClassnameTags123ApiFp(configuration) @@ -3729,9 +2517,6 @@ export const FakeClassnameTags123ApiFactory = function (configuration?: Configur /** * FakeClassnameTags123Api - object-oriented interface - * @export - * @class FakeClassnameTags123Api - * @extends {BaseAPI} */ export class FakeClassnameTags123Api extends BaseAPI { /** @@ -3740,7 +2525,6 @@ export class FakeClassnameTags123Api extends BaseAPI { * @param {Client} client client model * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeClassnameTags123Api */ public testClassname(client: Client, options?: RawAxiosRequestConfig) { return FakeClassnameTags123ApiFp(this.configuration).testClassname(client, options).then((request) => request(this.axios, this.basePath)); @@ -3751,7 +2535,6 @@ export class FakeClassnameTags123Api extends BaseAPI { /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -4168,7 +2951,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -4303,7 +3085,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -4411,9 +3192,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -4422,7 +3200,6 @@ export class PetApi extends BaseAPI { * @param {Pet} pet Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(pet: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(pet, options).then((request) => request(this.axios, this.basePath)); @@ -4435,7 +3212,6 @@ export class PetApi extends BaseAPI { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -4447,7 +3223,6 @@ export class PetApi extends BaseAPI { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -4460,7 +3235,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -4472,7 +3246,6 @@ export class PetApi extends BaseAPI { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -4484,7 +3257,6 @@ export class PetApi extends BaseAPI { * @param {Pet} pet Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(pet: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(pet, options).then((request) => request(this.axios, this.basePath)); @@ -4498,7 +3270,6 @@ export class PetApi extends BaseAPI { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -4512,7 +3283,6 @@ export class PetApi extends BaseAPI { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); @@ -4526,16 +3296,12 @@ export class PetApi extends BaseAPI { * @param {string} [additionalMetadata] Additional data to pass to server * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFileWithRequiredFile(petId: number, requiredFile: File, additionalMetadata?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -4546,7 +3312,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -4692,7 +3457,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -4753,7 +3517,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -4802,9 +3565,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -4813,7 +3573,6 @@ export class StoreApi extends BaseAPI { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -4824,7 +3583,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -4836,7 +3594,6 @@ export class StoreApi extends BaseAPI { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -4848,7 +3605,6 @@ export class StoreApi extends BaseAPI { * @param {Order} order order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(order: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(order, options).then((request) => request(this.axios, this.basePath)); @@ -4859,7 +3615,6 @@ export class StoreApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -5158,7 +3913,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -5273,7 +4027,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -5364,9 +4117,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -5375,7 +4125,6 @@ export class UserApi extends BaseAPI { * @param {User} user Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(user: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(user, options).then((request) => request(this.axios, this.basePath)); @@ -5387,7 +4136,6 @@ export class UserApi extends BaseAPI { * @param {Array} user List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(user: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(user, options).then((request) => request(this.axios, this.basePath)); @@ -5399,7 +4147,6 @@ export class UserApi extends BaseAPI { * @param {Array} user List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(user: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(user, options).then((request) => request(this.axios, this.basePath)); @@ -5411,7 +4158,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -5423,7 +4169,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -5436,7 +4181,6 @@ export class UserApi extends BaseAPI { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -5447,7 +4191,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -5460,7 +4203,6 @@ export class UserApi extends BaseAPI { * @param {User} user Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, user: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, user, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/base.ts b/samples/client/petstore/typescript-axios/builds/test-petstore/base.ts index ba1854123f7c..4d582764f6ef 100644 --- a/samples/client/petstore/typescript-axios/builds/test-petstore/base.ts +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io:80/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,10 +58,6 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { "PetApi.addPet": [ { diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/common.ts b/samples/client/petstore/typescript-axios/builds/test-petstore/common.ts index aa331b45fe27..0a5b63b231ff 100644 --- a/samples/client/petstore/typescript-axios/builds/test-petstore/common.ts +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/configuration.ts b/samples/client/petstore/typescript-axios/builds/test-petstore/configuration.ts index 169a95b6b422..db98c9fdf6fe 100644 --- a/samples/client/petstore/typescript-axios/builds/test-petstore/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/api.ts b/samples/client/petstore/typescript-axios/builds/with-complex-headers/api.ts index 0e70f1dd2fc9..8b1482540828 100644 --- a/samples/client/petstore/typescript-axios/builds/with-complex-headers/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/api.ts @@ -25,53 +25,19 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } -/** - * - * @export - * @enum {string} - */ export const MediaType = { ApplicationJson: 'application/json', @@ -83,45 +49,16 @@ export type MediaType = typeof MediaType[keyof typeof MediaType]; /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -135,45 +72,16 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -187,82 +95,30 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -638,7 +494,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -762,7 +617,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -862,9 +716,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -876,7 +727,6 @@ export class PetApi extends BaseAPI { * @param {MediaType} [accept] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(pet: Pet, header1?: Pet, header2?: Array, accept?: MediaType, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(pet, header1, header2, accept, options).then((request) => request(this.axios, this.basePath)); @@ -889,7 +739,6 @@ export class PetApi extends BaseAPI { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -901,7 +750,6 @@ export class PetApi extends BaseAPI { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -914,7 +762,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -926,7 +773,6 @@ export class PetApi extends BaseAPI { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -938,7 +784,6 @@ export class PetApi extends BaseAPI { * @param {Pet} pet Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(pet: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(pet, options).then((request) => request(this.axios, this.basePath)); @@ -952,7 +797,6 @@ export class PetApi extends BaseAPI { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -967,16 +811,12 @@ export class PetApi extends BaseAPI { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, contentType?: string, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, contentType, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -987,7 +827,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1133,7 +972,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -1194,7 +1032,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -1243,9 +1080,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -1254,7 +1088,6 @@ export class StoreApi extends BaseAPI { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1265,7 +1098,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -1277,7 +1109,6 @@ export class StoreApi extends BaseAPI { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1289,7 +1120,6 @@ export class StoreApi extends BaseAPI { * @param {Order} order order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(order: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(order, options).then((request) => request(this.axios, this.basePath)); @@ -1300,7 +1130,6 @@ export class StoreApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1599,7 +1428,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -1714,7 +1542,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -1805,9 +1632,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -1816,7 +1640,6 @@ export class UserApi extends BaseAPI { * @param {User} user Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(user: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(user, options).then((request) => request(this.axios, this.basePath)); @@ -1828,7 +1651,6 @@ export class UserApi extends BaseAPI { * @param {Array} user List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(user: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(user, options).then((request) => request(this.axios, this.basePath)); @@ -1840,7 +1662,6 @@ export class UserApi extends BaseAPI { * @param {Array} user List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(user: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(user, options).then((request) => request(this.axios, this.basePath)); @@ -1852,7 +1673,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -1864,7 +1684,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -1877,7 +1696,6 @@ export class UserApi extends BaseAPI { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -1888,7 +1706,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -1901,7 +1718,6 @@ export class UserApi extends BaseAPI { * @param {User} user Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, user: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, user, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/base.ts b/samples/client/petstore/typescript-axios/builds/with-complex-headers/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/with-complex-headers/base.ts +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/common.ts b/samples/client/petstore/typescript-axios/builds/with-complex-headers/common.ts index e6be09b1fdd6..48a99b2fb1e0 100644 --- a/samples/client/petstore/typescript-axios/builds/with-complex-headers/common.ts +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-complex-headers/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/with-complex-headers/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/api.ts b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/api.ts index a2e245084ac7..d09a7251e6f7 100644 --- a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/api.ts @@ -23,317 +23,78 @@ import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; -/** - * - * @export - * @interface AdditionalPropertiesClass - */ export interface AdditionalPropertiesClass { - /** - * - * @type {{ [key: string]: string; }} - * @memberof AdditionalPropertiesClass - */ 'map_property'?: { [key: string]: string; }; - /** - * - * @type {{ [key: string]: { [key: string]: string; }; }} - * @memberof AdditionalPropertiesClass - */ 'map_of_map_property'?: { [key: string]: { [key: string]: string; }; }; } -/** - * - * @export - * @interface Animal - */ export interface Animal { - /** - * - * @type {string} - * @memberof Animal - */ 'className': string; - /** - * - * @type {string} - * @memberof Animal - */ 'color'?: string; } -/** - * - * @export - * @interface ApiResponse - */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } -/** - * - * @export - * @interface Apple - */ export interface Apple { - /** - * - * @type {string} - * @memberof Apple - */ 'cultivar'?: string; } -/** - * - * @export - * @interface AppleReq - */ export interface AppleReq { - /** - * - * @type {string} - * @memberof AppleReq - */ 'cultivar': string; - /** - * - * @type {boolean} - * @memberof AppleReq - */ 'mealy'?: boolean; } -/** - * - * @export - * @interface ArrayOfArrayOfNumberOnly - */ export interface ArrayOfArrayOfNumberOnly { - /** - * - * @type {Array>} - * @memberof ArrayOfArrayOfNumberOnly - */ 'ArrayArrayNumber'?: Array>; } -/** - * - * @export - * @interface ArrayOfNumberOnly - */ export interface ArrayOfNumberOnly { - /** - * - * @type {Array} - * @memberof ArrayOfNumberOnly - */ 'ArrayNumber'?: Array; } -/** - * - * @export - * @interface ArrayTest - */ export interface ArrayTest { - /** - * - * @type {Array} - * @memberof ArrayTest - */ 'array_of_string'?: Array; - /** - * - * @type {Array>} - * @memberof ArrayTest - */ 'array_array_of_integer'?: Array>; - /** - * - * @type {Array>} - * @memberof ArrayTest - */ 'array_array_of_model'?: Array>; } -/** - * - * @export - * @interface Banana - */ export interface Banana { [key: string]: any; - /** - * - * @type {number} - * @memberof Banana - */ 'lengthCm'?: number; } -/** - * - * @export - * @interface BananaReq - */ export interface BananaReq { - /** - * - * @type {number} - * @memberof BananaReq - */ 'lengthCm': number; - /** - * - * @type {boolean} - * @memberof BananaReq - */ 'sweet'?: boolean; } -/** - * - * @export - * @interface Capitalization - */ export interface Capitalization { - /** - * - * @type {string} - * @memberof Capitalization - */ 'smallCamel'?: string; - /** - * - * @type {string} - * @memberof Capitalization - */ 'CapitalCamel'?: string; - /** - * - * @type {string} - * @memberof Capitalization - */ 'small_Snake'?: string; - /** - * - * @type {string} - * @memberof Capitalization - */ 'Capital_Snake'?: string; - /** - * - * @type {string} - * @memberof Capitalization - */ 'SCA_ETH_Flow_Points'?: string; /** - * Name of the pet - * @type {string} - * @memberof Capitalization - */ + * Name of the pet + */ 'ATT_NAME'?: string; } -/** - * - * @export - * @interface Cat - */ export interface Cat extends Animal { - /** - * - * @type {boolean} - * @memberof Cat - */ 'declawed'?: boolean; } -/** - * - * @export - * @interface Category - */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name': string; } /** * Model for testing model with \"_class\" property - * @export - * @interface ClassModel */ export interface ClassModel { - /** - * - * @type {string} - * @memberof ClassModel - */ '_class'?: string; } -/** - * - * @export - * @interface Client - */ export interface Client { - /** - * - * @type {string} - * @memberof Client - */ 'client'?: string; } -/** - * - * @export - * @interface Dog - */ export interface Dog extends Animal { - /** - * - * @type {string} - * @memberof Dog - */ 'breed'?: string; } -/** - * - * @export - * @interface EnumArrays - */ export interface EnumArrays { - /** - * - * @type {string} - * @memberof EnumArrays - */ 'just_symbol'?: EnumArraysJustSymbolEnum; - /** - * - * @type {Array} - * @memberof EnumArrays - */ 'array_enum'?: Array; } @@ -350,11 +111,6 @@ export const EnumArraysArrayEnumEnum = { export type EnumArraysArrayEnumEnum = typeof EnumArraysArrayEnumEnum[keyof typeof EnumArraysArrayEnumEnum]; -/** - * - * @export - * @enum {string} - */ export const EnumClass = { Abc: '_abc', @@ -365,59 +121,14 @@ export const EnumClass = { export type EnumClass = typeof EnumClass[keyof typeof EnumClass]; -/** - * - * @export - * @interface EnumTest - */ export interface EnumTest { - /** - * - * @type {string} - * @memberof EnumTest - */ 'enum_string'?: EnumTestEnumStringEnum; - /** - * - * @type {string} - * @memberof EnumTest - */ 'enum_string_required': EnumTestEnumStringRequiredEnum; - /** - * - * @type {number} - * @memberof EnumTest - */ 'enum_integer'?: EnumTestEnumIntegerEnum; - /** - * - * @type {number} - * @memberof EnumTest - */ 'enum_number'?: EnumTestEnumNumberEnum; - /** - * - * @type {OuterEnum} - * @memberof EnumTest - */ 'outerEnum'?: OuterEnum | null; - /** - * - * @type {OuterEnumInteger} - * @memberof EnumTest - */ 'outerEnumInteger'?: OuterEnumInteger; - /** - * - * @type {OuterEnumDefaultValue} - * @memberof EnumTest - */ 'outerEnumDefaultValue'?: OuterEnumDefaultValue; - /** - * - * @type {OuterEnumIntegerDefaultValue} - * @memberof EnumTest - */ 'outerEnumIntegerDefaultValue'?: OuterEnumIntegerDefaultValue; } @@ -448,265 +159,76 @@ export const EnumTestEnumNumberEnum = { export type EnumTestEnumNumberEnum = typeof EnumTestEnumNumberEnum[keyof typeof EnumTestEnumNumberEnum]; -/** - * - * @export - * @interface FileSchemaTestClass - */ export interface FileSchemaTestClass { - /** - * - * @type {any} - * @memberof FileSchemaTestClass - */ 'file'?: any; - /** - * - * @type {Array} - * @memberof FileSchemaTestClass - */ 'files'?: Array; } -/** - * - * @export - * @interface Foo - */ export interface Foo { - /** - * - * @type {string} - * @memberof Foo - */ 'bar'?: string; } -/** - * - * @export - * @interface FooGetDefaultResponse - */ export interface FooGetDefaultResponse { - /** - * - * @type {Foo} - * @memberof FooGetDefaultResponse - */ 'string'?: Foo; } -/** - * - * @export - * @interface FormatTest - */ export interface FormatTest { - /** - * - * @type {number} - * @memberof FormatTest - */ 'integer'?: number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'int32'?: number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'int64'?: number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'number': number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'float'?: number; - /** - * - * @type {number} - * @memberof FormatTest - */ 'double'?: number; - /** - * - * @type {string} - * @memberof FormatTest - */ 'string'?: string; - /** - * - * @type {string} - * @memberof FormatTest - */ 'byte': string; - /** - * - * @type {File} - * @memberof FormatTest - */ 'binary'?: File; - /** - * - * @type {string} - * @memberof FormatTest - */ 'date': string; - /** - * - * @type {string} - * @memberof FormatTest - */ 'dateTime'?: string; - /** - * - * @type {string} - * @memberof FormatTest - */ 'uuid'?: string; - /** - * - * @type {string} - * @memberof FormatTest - */ 'password': string; /** - * A string that is a 10 digit number. Can have leading zeros. - * @type {string} - * @memberof FormatTest - */ + * A string that is a 10 digit number. Can have leading zeros. + */ 'pattern_with_digits'?: string; /** - * A string starting with \'image_\' (case insensitive) and one to three digits following i.e. Image_01. - * @type {string} - * @memberof FormatTest - */ + * A string starting with \'image_\' (case insensitive) and one to three digits following i.e. Image_01. + */ 'pattern_with_digits_and_delimiter'?: string; } /** * @type Fruit - * @export */ export type Fruit = Apple | Banana; /** * @type FruitReq - * @export */ export type FruitReq = AppleReq | BananaReq; -/** - * - * @export - * @interface GmFruit - */ export interface GmFruit { - /** - * - * @type {string} - * @memberof GmFruit - */ 'color'?: string; - /** - * - * @type {string} - * @memberof GmFruit - */ 'cultivar'?: string; - /** - * - * @type {number} - * @memberof GmFruit - */ 'lengthCm'?: number; } -/** - * - * @export - * @interface HasOnlyReadOnly - */ export interface HasOnlyReadOnly { - /** - * - * @type {string} - * @memberof HasOnlyReadOnly - */ 'bar'?: string; - /** - * - * @type {string} - * @memberof HasOnlyReadOnly - */ 'foo'?: string; } /** * Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model. - * @export - * @interface HealthCheckResult */ export interface HealthCheckResult { - /** - * - * @type {string} - * @memberof HealthCheckResult - */ 'NullableMessage'?: string | null; } -/** - * - * @export - * @interface List - */ export interface List { - /** - * - * @type {string} - * @memberof List - */ '123-list'?: string; } /** * @type Mammal - * @export */ export type Mammal = { className: 'whale' } & Whale | { className: 'zebra' } & Zebra; -/** - * - * @export - * @interface MapTest - */ export interface MapTest { - /** - * - * @type {{ [key: string]: { [key: string]: string; }; }} - * @memberof MapTest - */ 'map_map_of_string'?: { [key: string]: { [key: string]: string; }; }; - /** - * - * @type {{ [key: string]: string; }} - * @memberof MapTest - */ 'map_of_enum_string'?: { [key: string]: string; }; - /** - * - * @type {{ [key: string]: boolean; }} - * @memberof MapTest - */ 'direct_map'?: { [key: string]: boolean; }; - /** - * - * @type {{ [key: string]: boolean; }} - * @memberof MapTest - */ 'indirect_map'?: { [key: string]: boolean; }; } @@ -717,229 +239,64 @@ export const MapTestMapOfEnumStringEnum = { export type MapTestMapOfEnumStringEnum = typeof MapTestMapOfEnumStringEnum[keyof typeof MapTestMapOfEnumStringEnum]; -/** - * - * @export - * @interface MixedPropertiesAndAdditionalPropertiesClass - */ export interface MixedPropertiesAndAdditionalPropertiesClass { - /** - * - * @type {string} - * @memberof MixedPropertiesAndAdditionalPropertiesClass - */ - 'uuid'?: string; - /** - * - * @type {string} - * @memberof MixedPropertiesAndAdditionalPropertiesClass - */ + 'uuid'?: string; 'dateTime'?: string; - /** - * - * @type {{ [key: string]: Animal; }} - * @memberof MixedPropertiesAndAdditionalPropertiesClass - */ 'map'?: { [key: string]: Animal; }; } /** * Model for testing model name starting with number - * @export - * @interface Model200Response */ export interface Model200Response { - /** - * - * @type {number} - * @memberof Model200Response - */ 'name'?: number; - /** - * - * @type {string} - * @memberof Model200Response - */ 'class'?: string; } /** * Must be named `File` for test. - * @export - * @interface ModelFile */ export interface ModelFile { /** - * Test capitalization - * @type {string} - * @memberof ModelFile - */ + * Test capitalization + */ 'sourceURI'?: string; } /** * Model for testing model name same as property name - * @export - * @interface Name */ export interface Name { - /** - * - * @type {number} - * @memberof Name - */ 'name': number; - /** - * - * @type {number} - * @memberof Name - */ 'snake_case'?: number; - /** - * - * @type {string} - * @memberof Name - */ 'property'?: string; - /** - * - * @type {number} - * @memberof Name - */ '123Number'?: number; } -/** - * - * @export - * @interface NullableClass - */ export interface NullableClass { [key: string]: object | any; - /** - * - * @type {number} - * @memberof NullableClass - */ 'integer_prop'?: number | null; - /** - * - * @type {number} - * @memberof NullableClass - */ 'number_prop'?: number | null; - /** - * - * @type {boolean} - * @memberof NullableClass - */ 'boolean_prop'?: boolean | null; - /** - * - * @type {string} - * @memberof NullableClass - */ 'string_prop'?: string | null; - /** - * - * @type {string} - * @memberof NullableClass - */ 'date_prop'?: string | null; - /** - * - * @type {string} - * @memberof NullableClass - */ 'datetime_prop'?: string | null; - /** - * - * @type {Array} - * @memberof NullableClass - */ 'array_nullable_prop'?: Array | null; - /** - * - * @type {Array} - * @memberof NullableClass - */ 'array_and_items_nullable_prop'?: Array | null; - /** - * - * @type {Array} - * @memberof NullableClass - */ 'array_items_nullable'?: Array; - /** - * - * @type {{ [key: string]: object; }} - * @memberof NullableClass - */ 'object_nullable_prop'?: { [key: string]: object; } | null; - /** - * - * @type {{ [key: string]: object | null; }} - * @memberof NullableClass - */ 'object_and_items_nullable_prop'?: { [key: string]: object | null; } | null; - /** - * - * @type {{ [key: string]: object | null; }} - * @memberof NullableClass - */ 'object_items_nullable'?: { [key: string]: object | null; }; } -/** - * - * @export - * @interface NumberOnly - */ export interface NumberOnly { - /** - * - * @type {number} - * @memberof NumberOnly - */ 'JustNumber'?: number; } -/** - * - * @export - * @interface Order - */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -951,36 +308,11 @@ export const OrderStatusEnum = { export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum]; -/** - * - * @export - * @interface OuterComposite - */ export interface OuterComposite { - /** - * - * @type {number} - * @memberof OuterComposite - */ 'my_number'?: number; - /** - * - * @type {string} - * @memberof OuterComposite - */ 'my_string'?: string; - /** - * - * @type {boolean} - * @memberof OuterComposite - */ 'my_boolean'?: boolean; } -/** - * - * @export - * @enum {string} - */ export const OuterEnum = { Placed: 'placed', @@ -991,11 +323,6 @@ export const OuterEnum = { export type OuterEnum = typeof OuterEnum[keyof typeof OuterEnum]; -/** - * - * @export - * @enum {string} - */ export const OuterEnumDefaultValue = { Placed: 'placed', @@ -1006,11 +333,6 @@ export const OuterEnumDefaultValue = { export type OuterEnumDefaultValue = typeof OuterEnumDefaultValue[keyof typeof OuterEnumDefaultValue]; -/** - * - * @export - * @enum {number} - */ export const OuterEnumInteger = { NUMBER_0: 0, @@ -1021,11 +343,6 @@ export const OuterEnumInteger = { export type OuterEnumInteger = typeof OuterEnumInteger[keyof typeof OuterEnumInteger]; -/** - * - * @export - * @enum {number} - */ export const OuterEnumIntegerDefaultValue = { NUMBER_0: 0, @@ -1036,48 +353,16 @@ export const OuterEnumIntegerDefaultValue = { export type OuterEnumIntegerDefaultValue = typeof OuterEnumIntegerDefaultValue[keyof typeof OuterEnumIntegerDefaultValue]; -/** - * - * @export - * @interface Pet - */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - * @deprecated - */ + * pet status in the store + * @deprecated + */ 'status'?: PetStatusEnum; } @@ -1089,255 +374,73 @@ export const PetStatusEnum = { export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; -/** - * - * @export - * @interface ReadOnlyFirst - */ export interface ReadOnlyFirst { - /** - * - * @type {string} - * @memberof ReadOnlyFirst - */ 'bar'?: string; - /** - * - * @type {string} - * @memberof ReadOnlyFirst - */ 'baz'?: string; } -/** - * - * @export - * @interface ReadOnlyWithDefault - */ export interface ReadOnlyWithDefault { - /** - * - * @type {string} - * @memberof ReadOnlyWithDefault - */ 'prop1'?: string; - /** - * - * @type {string} - * @memberof ReadOnlyWithDefault - */ 'prop2'?: string; - /** - * - * @type {string} - * @memberof ReadOnlyWithDefault - */ 'prop3'?: string; - /** - * - * @type {boolean} - * @memberof ReadOnlyWithDefault - */ 'boolProp1'?: boolean; - /** - * - * @type {boolean} - * @memberof ReadOnlyWithDefault - */ 'boolProp2'?: boolean; - /** - * - * @type {number} - * @memberof ReadOnlyWithDefault - */ 'intProp1'?: number; - /** - * - * @type {number} - * @memberof ReadOnlyWithDefault - */ 'intProp2'?: number; } /** * Model for testing reserved words - * @export - * @interface Return */ export interface Return { - /** - * - * @type {number} - * @memberof Return - */ 'return'?: number; } -/** - * - * @export - * @interface SpecialModelName - */ export interface SpecialModelName { - /** - * - * @type {number} - * @memberof SpecialModelName - */ '$special[property.name]'?: number; } -/** - * - * @export - * @interface Tag - */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } -/** - * - * @export - * @interface TestInlineFreeformAdditionalPropertiesRequest - */ export interface TestInlineFreeformAdditionalPropertiesRequest { [key: string]: any; - /** - * - * @type {string} - * @memberof TestInlineFreeformAdditionalPropertiesRequest - */ 'someProperty'?: string; } -/** - * - * @export - * @interface User - */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; /** - * test code generation for objects Value must be a map of strings to values. It cannot be the \'null\' value. - * @type {object} - * @memberof User - */ + * test code generation for objects Value must be a map of strings to values. It cannot be the \'null\' value. + */ 'arbitraryObject'?: object; /** - * test code generation for nullable objects. Value must be a map of strings to values or the \'null\' value. - * @type {object} - * @memberof User - */ + * test code generation for nullable objects. Value must be a map of strings to values or the \'null\' value. + */ 'arbitraryNullableObject'?: object | null; /** - * test code generation for any type Value can be any type - string, number, boolean, array or object. - * @type {any} - * @memberof User - */ + * test code generation for any type Value can be any type - string, number, boolean, array or object. + */ 'arbitraryTypeValue'?: any; /** - * test code generation for any type Value can be any type - string, number, boolean, array, object or the \'null\' value. - * @type {any} - * @memberof User - */ + * test code generation for any type Value can be any type - string, number, boolean, array, object or the \'null\' value. + */ 'arbitraryNullableTypeValue'?: any | null; } -/** - * - * @export - * @interface Whale - */ export interface Whale { - /** - * - * @type {boolean} - * @memberof Whale - */ 'hasBaleen'?: boolean; - /** - * - * @type {boolean} - * @memberof Whale - */ 'hasTeeth'?: boolean; - /** - * - * @type {string} - * @memberof Whale - */ 'className': string; } -/** - * - * @export - * @interface Zebra - */ export interface Zebra { - /** - * - * @type {string} - * @memberof Zebra - */ 'type'?: ZebraTypeEnum; - /** - * - * @type {string} - * @memberof Zebra - */ 'className': string; } @@ -1352,7 +455,6 @@ export type ZebraTypeEnum = typeof ZebraTypeEnum[keyof typeof ZebraTypeEnum]; /** * AnotherFakeApi - axios parameter creator - * @export */ export const AnotherFakeApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1397,7 +499,6 @@ export const AnotherFakeApiAxiosParamCreator = function (configuration?: Configu /** * AnotherFakeApi - functional programming interface - * @export */ export const AnotherFakeApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = AnotherFakeApiAxiosParamCreator(configuration) @@ -1420,7 +521,6 @@ export const AnotherFakeApiFp = function(configuration?: Configuration) { /** * AnotherFakeApi - factory interface - * @export */ export const AnotherFakeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = AnotherFakeApiFp(configuration) @@ -1440,9 +540,6 @@ export const AnotherFakeApiFactory = function (configuration?: Configuration, ba /** * AnotherFakeApi - object-oriented interface - * @export - * @class AnotherFakeApi - * @extends {BaseAPI} */ export class AnotherFakeApi extends BaseAPI { /** @@ -1451,7 +548,6 @@ export class AnotherFakeApi extends BaseAPI { * @param {Client} client client model * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof AnotherFakeApi */ public _123testSpecialTags(client: Client, options?: RawAxiosRequestConfig) { return AnotherFakeApiFp(this.configuration)._123testSpecialTags(client, options).then((request) => request(this.axios, this.basePath)); @@ -1462,7 +558,6 @@ export class AnotherFakeApi extends BaseAPI { /** * DefaultApi - axios parameter creator - * @export */ export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1500,7 +595,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati /** * DefaultApi - functional programming interface - * @export */ export const DefaultApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration) @@ -1521,7 +615,6 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * DefaultApi - factory interface - * @export */ export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = DefaultApiFp(configuration) @@ -1539,16 +632,12 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa /** * DefaultApi - object-oriented interface - * @export - * @class DefaultApi - * @extends {BaseAPI} */ export class DefaultApi extends BaseAPI { /** * * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DefaultApi */ public fooGet(options?: RawAxiosRequestConfig) { return DefaultApiFp(this.configuration).fooGet(options).then((request) => request(this.axios, this.basePath)); @@ -1559,7 +648,6 @@ export class DefaultApi extends BaseAPI { /** * FakeApi - axios parameter creator - * @export */ export const FakeApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -2403,7 +1491,6 @@ export const FakeApiAxiosParamCreator = function (configuration?: Configuration) /** * FakeApi - functional programming interface - * @export */ export const FakeApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = FakeApiAxiosParamCreator(configuration) @@ -2670,7 +1757,6 @@ export const FakeApiFp = function(configuration?: Configuration) { /** * FakeApi - factory interface - * @export */ export const FakeApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = FakeApiFp(configuration) @@ -2883,9 +1969,6 @@ export const FakeApiFactory = function (configuration?: Configuration, basePath? /** * FakeApi - object-oriented interface - * @export - * @class FakeApi - * @extends {BaseAPI} */ export class FakeApi extends BaseAPI { /** @@ -2893,7 +1976,6 @@ export class FakeApi extends BaseAPI { * @summary Health check endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeHealthGet(options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeHealthGet(options).then((request) => request(this.axios, this.basePath)); @@ -2904,7 +1986,6 @@ export class FakeApi extends BaseAPI { * @param {boolean} [body] Input boolean as post body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeOuterBooleanSerialize(body?: boolean, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeOuterBooleanSerialize(body, options).then((request) => request(this.axios, this.basePath)); @@ -2915,7 +1996,6 @@ export class FakeApi extends BaseAPI { * @param {OuterComposite} [outerComposite] Input composite as post body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeOuterCompositeSerialize(outerComposite?: OuterComposite, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeOuterCompositeSerialize(outerComposite, options).then((request) => request(this.axios, this.basePath)); @@ -2926,7 +2006,6 @@ export class FakeApi extends BaseAPI { * @param {number} [body] Input number as post body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeOuterNumberSerialize(body?: number, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeOuterNumberSerialize(body, options).then((request) => request(this.axios, this.basePath)); @@ -2937,7 +2016,6 @@ export class FakeApi extends BaseAPI { * @param {string} [body] Input string as post body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public fakeOuterStringSerialize(body?: string, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).fakeOuterStringSerialize(body, options).then((request) => request(this.axios, this.basePath)); @@ -2949,7 +2027,6 @@ export class FakeApi extends BaseAPI { * @param {{ [key: string]: any; }} requestBody request body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testAdditionalPropertiesReference(requestBody: { [key: string]: any; }, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testAdditionalPropertiesReference(requestBody, options).then((request) => request(this.axios, this.basePath)); @@ -2960,7 +2037,6 @@ export class FakeApi extends BaseAPI { * @param {FileSchemaTestClass} fileSchemaTestClass * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testBodyWithFileSchema(fileSchemaTestClass: FileSchemaTestClass, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testBodyWithFileSchema(fileSchemaTestClass, options).then((request) => request(this.axios, this.basePath)); @@ -2972,7 +2048,6 @@ export class FakeApi extends BaseAPI { * @param {User} user * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testBodyWithQueryParams(query: string, user: User, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testBodyWithQueryParams(query, user, options).then((request) => request(this.axios, this.basePath)); @@ -2984,7 +2059,6 @@ export class FakeApi extends BaseAPI { * @param {Client} client client model * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testClientModel(client: Client, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testClientModel(client, options).then((request) => request(this.axios, this.basePath)); @@ -3009,7 +2083,6 @@ export class FakeApi extends BaseAPI { * @param {string} [callback] None * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testEndpointParameters(number: number, _double: number, patternWithoutDelimiter: string, _byte: string, integer?: number, int32?: number, int64?: number, _float?: number, string?: string, binary?: File, date?: string, dateTime?: string, password?: string, callback?: string, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, callback, options).then((request) => request(this.axios, this.basePath)); @@ -3028,7 +2101,6 @@ export class FakeApi extends BaseAPI { * @param {TestEnumParametersEnumFormStringEnum} [enumFormString] Form parameter enum test (string) * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testEnumParameters(enumHeaderStringArray?: Array, enumHeaderString?: TestEnumParametersEnumHeaderStringEnum, enumQueryStringArray?: Array, enumQueryString?: TestEnumParametersEnumQueryStringEnum, enumQueryInteger?: TestEnumParametersEnumQueryIntegerEnum, enumQueryDouble?: TestEnumParametersEnumQueryDoubleEnum, enumFormStringArray?: Array, enumFormString?: TestEnumParametersEnumFormStringEnum, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString, options).then((request) => request(this.axios, this.basePath)); @@ -3045,7 +2117,6 @@ export class FakeApi extends BaseAPI { * @param {number} [int64Group] Integer in group parameters * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testGroupParameters(requiredStringGroup: number, requiredBooleanGroup: boolean, requiredInt64Group: number, stringGroup?: number, booleanGroup?: boolean, int64Group?: number, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group, options).then((request) => request(this.axios, this.basePath)); @@ -3057,7 +2128,6 @@ export class FakeApi extends BaseAPI { * @param {{ [key: string]: string; }} requestBody request body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testInlineAdditionalProperties(requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testInlineAdditionalProperties(requestBody, options).then((request) => request(this.axios, this.basePath)); @@ -3069,7 +2139,6 @@ export class FakeApi extends BaseAPI { * @param {TestInlineFreeformAdditionalPropertiesRequest} testInlineFreeformAdditionalPropertiesRequest request body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testInlineFreeformAdditionalProperties(testInlineFreeformAdditionalPropertiesRequest: TestInlineFreeformAdditionalPropertiesRequest, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testInlineFreeformAdditionalProperties(testInlineFreeformAdditionalPropertiesRequest, options).then((request) => request(this.axios, this.basePath)); @@ -3082,7 +2151,6 @@ export class FakeApi extends BaseAPI { * @param {string} param2 field2 * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testJsonFormData(param: string, param2: string, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testJsonFormData(param, param2, options).then((request) => request(this.axios, this.basePath)); @@ -3097,7 +2165,6 @@ export class FakeApi extends BaseAPI { * @param {Array} context * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testQueryParameterCollectionFormat(pipe: Array, ioutil: Array, http: Array, url: Array, context: Array, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testQueryParameterCollectionFormat(pipe, ioutil, http, url, context, options).then((request) => request(this.axios, this.basePath)); @@ -3109,7 +2176,6 @@ export class FakeApi extends BaseAPI { * @param {{ [key: string]: string; }} requestBody request body * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testStringMapReference(requestBody: { [key: string]: string; }, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testStringMapReference(requestBody, options).then((request) => request(this.axios, this.basePath)); @@ -3121,74 +2187,49 @@ export class FakeApi extends BaseAPI { * @param {Set} headerUnique * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeApi */ public testUniqueItemsHeaderAndQueryParameterCollectionFormat(queryUnique: Set, headerUnique: Set, options?: RawAxiosRequestConfig) { return FakeApiFp(this.configuration).testUniqueItemsHeaderAndQueryParameterCollectionFormat(queryUnique, headerUnique, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const TestEnumParametersEnumHeaderStringArrayEnum = { GreaterThan: '>', Dollar: '$' } as const; export type TestEnumParametersEnumHeaderStringArrayEnum = typeof TestEnumParametersEnumHeaderStringArrayEnum[keyof typeof TestEnumParametersEnumHeaderStringArrayEnum]; -/** - * @export - */ export const TestEnumParametersEnumHeaderStringEnum = { Abc: '_abc', Efg: '-efg', Xyz: '(xyz)' } as const; export type TestEnumParametersEnumHeaderStringEnum = typeof TestEnumParametersEnumHeaderStringEnum[keyof typeof TestEnumParametersEnumHeaderStringEnum]; -/** - * @export - */ export const TestEnumParametersEnumQueryStringArrayEnum = { GreaterThan: '>', Dollar: '$' } as const; export type TestEnumParametersEnumQueryStringArrayEnum = typeof TestEnumParametersEnumQueryStringArrayEnum[keyof typeof TestEnumParametersEnumQueryStringArrayEnum]; -/** - * @export - */ export const TestEnumParametersEnumQueryStringEnum = { Abc: '_abc', Efg: '-efg', Xyz: '(xyz)' } as const; export type TestEnumParametersEnumQueryStringEnum = typeof TestEnumParametersEnumQueryStringEnum[keyof typeof TestEnumParametersEnumQueryStringEnum]; -/** - * @export - */ export const TestEnumParametersEnumQueryIntegerEnum = { NUMBER_1: 1, NUMBER_MINUS_2: -2 } as const; export type TestEnumParametersEnumQueryIntegerEnum = typeof TestEnumParametersEnumQueryIntegerEnum[keyof typeof TestEnumParametersEnumQueryIntegerEnum]; -/** - * @export - */ export const TestEnumParametersEnumQueryDoubleEnum = { NUMBER_1_DOT_1: 1.1, NUMBER_MINUS_1_DOT_2: -1.2 } as const; export type TestEnumParametersEnumQueryDoubleEnum = typeof TestEnumParametersEnumQueryDoubleEnum[keyof typeof TestEnumParametersEnumQueryDoubleEnum]; -/** - * @export - */ export const TestEnumParametersEnumFormStringArrayEnum = { GreaterThan: '>', Dollar: '$' } as const; export type TestEnumParametersEnumFormStringArrayEnum = typeof TestEnumParametersEnumFormStringArrayEnum[keyof typeof TestEnumParametersEnumFormStringArrayEnum]; -/** - * @export - */ export const TestEnumParametersEnumFormStringEnum = { Abc: '_abc', Efg: '-efg', @@ -3199,7 +2240,6 @@ export type TestEnumParametersEnumFormStringEnum = typeof TestEnumParametersEnum /** * FakeClassnameTags123Api - axios parameter creator - * @export */ export const FakeClassnameTags123ApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -3247,7 +2287,6 @@ export const FakeClassnameTags123ApiAxiosParamCreator = function (configuration? /** * FakeClassnameTags123Api - functional programming interface - * @export */ export const FakeClassnameTags123ApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = FakeClassnameTags123ApiAxiosParamCreator(configuration) @@ -3270,7 +2309,6 @@ export const FakeClassnameTags123ApiFp = function(configuration?: Configuration) /** * FakeClassnameTags123Api - factory interface - * @export */ export const FakeClassnameTags123ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = FakeClassnameTags123ApiFp(configuration) @@ -3290,9 +2328,6 @@ export const FakeClassnameTags123ApiFactory = function (configuration?: Configur /** * FakeClassnameTags123Api - object-oriented interface - * @export - * @class FakeClassnameTags123Api - * @extends {BaseAPI} */ export class FakeClassnameTags123Api extends BaseAPI { /** @@ -3301,7 +2336,6 @@ export class FakeClassnameTags123Api extends BaseAPI { * @param {Client} client client model * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof FakeClassnameTags123Api */ public testClassname(client: Client, options?: RawAxiosRequestConfig) { return FakeClassnameTags123ApiFp(this.configuration).testClassname(client, options).then((request) => request(this.axios, this.basePath)); @@ -3312,7 +2346,6 @@ export class FakeClassnameTags123Api extends BaseAPI { /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -3729,7 +2762,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -3864,7 +2896,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -3972,9 +3003,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -3983,7 +3011,6 @@ export class PetApi extends BaseAPI { * @param {Pet} pet Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(pet: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(pet, options).then((request) => request(this.axios, this.basePath)); @@ -3996,7 +3023,6 @@ export class PetApi extends BaseAPI { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -4008,7 +3034,6 @@ export class PetApi extends BaseAPI { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -4021,7 +3046,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -4033,7 +3057,6 @@ export class PetApi extends BaseAPI { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -4045,7 +3068,6 @@ export class PetApi extends BaseAPI { * @param {Pet} pet Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(pet: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(pet, options).then((request) => request(this.axios, this.basePath)); @@ -4059,7 +3081,6 @@ export class PetApi extends BaseAPI { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -4073,7 +3094,6 @@ export class PetApi extends BaseAPI { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); @@ -4087,16 +3107,12 @@ export class PetApi extends BaseAPI { * @param {string} [additionalMetadata] Additional data to pass to server * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFileWithRequiredFile(petId: number, requiredFile: File, additionalMetadata?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -4107,7 +3123,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -4253,7 +3268,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -4314,7 +3328,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -4363,9 +3376,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -4374,7 +3384,6 @@ export class StoreApi extends BaseAPI { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -4385,7 +3394,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -4397,7 +3405,6 @@ export class StoreApi extends BaseAPI { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -4409,7 +3416,6 @@ export class StoreApi extends BaseAPI { * @param {Order} order order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(order: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(order, options).then((request) => request(this.axios, this.basePath)); @@ -4420,7 +3426,6 @@ export class StoreApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -4719,7 +3724,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -4834,7 +3838,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -4925,9 +3928,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -4936,7 +3936,6 @@ export class UserApi extends BaseAPI { * @param {User} user Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(user: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(user, options).then((request) => request(this.axios, this.basePath)); @@ -4948,7 +3947,6 @@ export class UserApi extends BaseAPI { * @param {Array} user List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(user: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(user, options).then((request) => request(this.axios, this.basePath)); @@ -4960,7 +3958,6 @@ export class UserApi extends BaseAPI { * @param {Array} user List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(user: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(user, options).then((request) => request(this.axios, this.basePath)); @@ -4972,7 +3969,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -4984,7 +3980,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -4997,7 +3992,6 @@ export class UserApi extends BaseAPI { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -5008,7 +4002,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -5021,7 +4014,6 @@ export class UserApi extends BaseAPI { * @param {User} user Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, user: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, user, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/base.ts b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/base.ts index ba1854123f7c..4d582764f6ef 100644 --- a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/base.ts +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io:80/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,10 +58,6 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { "PetApi.addPet": [ { diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/common.ts b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/common.ts index aa331b45fe27..0a5b63b231ff 100644 --- a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/common.ts +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/configuration.ts index 169a95b6b422..db98c9fdf6fe 100644 --- a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/api.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/api.ts index 3866dac8281f..fc6fd196c7ad 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/api.ts @@ -25,89 +25,31 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -121,45 +63,16 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -173,82 +86,30 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -603,7 +464,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -723,7 +583,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -814,8 +673,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - interface - * @export - * @interface PetApi */ export interface PetApiInterface { /** @@ -824,7 +681,6 @@ export interface PetApiInterface { * @param {PetApiAddPetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ addPet(requestParameters: PetApiAddPetRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -834,7 +690,6 @@ export interface PetApiInterface { * @param {PetApiDeletePetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ deletePet(requestParameters: PetApiDeletePetRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -844,7 +699,6 @@ export interface PetApiInterface { * @param {PetApiFindPetsByStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ findPetsByStatus(requestParameters: PetApiFindPetsByStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise>; @@ -855,7 +709,6 @@ export interface PetApiInterface { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApiInterface */ findPetsByTags(requestParameters: PetApiFindPetsByTagsRequest, options?: RawAxiosRequestConfig): AxiosPromise>; @@ -865,7 +718,6 @@ export interface PetApiInterface { * @param {PetApiGetPetByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ getPetById(requestParameters: PetApiGetPetByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -875,7 +727,6 @@ export interface PetApiInterface { * @param {PetApiUpdatePetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ updatePet(requestParameters: PetApiUpdatePetRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -885,7 +736,6 @@ export interface PetApiInterface { * @param {PetApiUpdatePetWithFormRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ updatePetWithForm(requestParameters: PetApiUpdatePetWithFormRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -895,7 +745,6 @@ export interface PetApiInterface { * @param {PetApiUploadFileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ uploadFile(requestParameters: PetApiUploadFileRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -903,156 +752,108 @@ export interface PetApiInterface { /** * Request parameters for addPet operation in PetApi. - * @export - * @interface PetApiAddPetRequest */ export interface PetApiAddPetRequest { /** * Pet object that needs to be added to the store - * @type {Pet} - * @memberof PetApiAddPet */ readonly body: Pet } /** * Request parameters for deletePet operation in PetApi. - * @export - * @interface PetApiDeletePetRequest */ export interface PetApiDeletePetRequest { /** * Pet id to delete - * @type {number} - * @memberof PetApiDeletePet */ readonly petId: number - /** - * - * @type {string} - * @memberof PetApiDeletePet - */ readonly apiKey?: string } /** * Request parameters for findPetsByStatus operation in PetApi. - * @export - * @interface PetApiFindPetsByStatusRequest */ export interface PetApiFindPetsByStatusRequest { /** * Status values that need to be considered for filter - * @type {Array<'available' | 'pending' | 'sold'>} - * @memberof PetApiFindPetsByStatus */ readonly status: Array } /** * Request parameters for findPetsByTags operation in PetApi. - * @export - * @interface PetApiFindPetsByTagsRequest */ export interface PetApiFindPetsByTagsRequest { /** * Tags to filter by - * @type {Array} - * @memberof PetApiFindPetsByTags */ readonly tags: Array } /** * Request parameters for getPetById operation in PetApi. - * @export - * @interface PetApiGetPetByIdRequest */ export interface PetApiGetPetByIdRequest { /** * ID of pet to return - * @type {number} - * @memberof PetApiGetPetById */ readonly petId: number } /** * Request parameters for updatePet operation in PetApi. - * @export - * @interface PetApiUpdatePetRequest */ export interface PetApiUpdatePetRequest { /** * Pet object that needs to be added to the store - * @type {Pet} - * @memberof PetApiUpdatePet */ readonly body: Pet } /** * Request parameters for updatePetWithForm operation in PetApi. - * @export - * @interface PetApiUpdatePetWithFormRequest */ export interface PetApiUpdatePetWithFormRequest { /** * ID of pet that needs to be updated - * @type {number} - * @memberof PetApiUpdatePetWithForm */ readonly petId: number /** * Updated name of the pet - * @type {string} - * @memberof PetApiUpdatePetWithForm */ readonly name?: string /** * Updated status of the pet - * @type {string} - * @memberof PetApiUpdatePetWithForm */ readonly status?: string } /** * Request parameters for uploadFile operation in PetApi. - * @export - * @interface PetApiUploadFileRequest */ export interface PetApiUploadFileRequest { /** * ID of pet to update - * @type {number} - * @memberof PetApiUploadFile */ readonly petId: number /** * Additional data to pass to server - * @type {string} - * @memberof PetApiUploadFile */ readonly additionalMetadata?: string /** * file to upload - * @type {File} - * @memberof PetApiUploadFile */ readonly file?: File } /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI implements PetApiInterface { /** @@ -1061,7 +862,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {PetApiAddPetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(requestParameters: PetApiAddPetRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -1073,7 +873,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {PetApiDeletePetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(requestParameters: PetApiDeletePetRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(requestParameters.petId, requestParameters.apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -1085,7 +884,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {PetApiFindPetsByStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(requestParameters: PetApiFindPetsByStatusRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(requestParameters.status, options).then((request) => request(this.axios, this.basePath)); @@ -1098,7 +896,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(requestParameters: PetApiFindPetsByTagsRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(requestParameters.tags, options).then((request) => request(this.axios, this.basePath)); @@ -1110,7 +907,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {PetApiGetPetByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(requestParameters: PetApiGetPetByIdRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(requestParameters.petId, options).then((request) => request(this.axios, this.basePath)); @@ -1122,7 +918,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {PetApiUpdatePetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(requestParameters: PetApiUpdatePetRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -1134,7 +929,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {PetApiUpdatePetWithFormRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(requestParameters: PetApiUpdatePetWithFormRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(requestParameters.petId, requestParameters.name, requestParameters.status, options).then((request) => request(this.axios, this.basePath)); @@ -1146,16 +940,12 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {PetApiUploadFileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(requestParameters: PetApiUploadFileRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(requestParameters.petId, requestParameters.additionalMetadata, requestParameters.file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -1166,7 +956,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1312,7 +1101,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -1373,7 +1161,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -1422,8 +1209,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - interface - * @export - * @interface StoreApi */ export interface StoreApiInterface { /** @@ -1432,7 +1217,6 @@ export interface StoreApiInterface { * @param {StoreApiDeleteOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApiInterface */ deleteOrder(requestParameters: StoreApiDeleteOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1441,7 +1225,6 @@ export interface StoreApiInterface { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApiInterface */ getInventory(options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: number; }>; @@ -1451,7 +1234,6 @@ export interface StoreApiInterface { * @param {StoreApiGetOrderByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApiInterface */ getOrderById(requestParameters: StoreApiGetOrderByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1461,7 +1243,6 @@ export interface StoreApiInterface { * @param {StoreApiPlaceOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApiInterface */ placeOrder(requestParameters: StoreApiPlaceOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1469,51 +1250,36 @@ export interface StoreApiInterface { /** * Request parameters for deleteOrder operation in StoreApi. - * @export - * @interface StoreApiDeleteOrderRequest */ export interface StoreApiDeleteOrderRequest { /** * ID of the order that needs to be deleted - * @type {string} - * @memberof StoreApiDeleteOrder */ readonly orderId: string } /** * Request parameters for getOrderById operation in StoreApi. - * @export - * @interface StoreApiGetOrderByIdRequest */ export interface StoreApiGetOrderByIdRequest { /** * ID of pet that needs to be fetched - * @type {number} - * @memberof StoreApiGetOrderById */ readonly orderId: number } /** * Request parameters for placeOrder operation in StoreApi. - * @export - * @interface StoreApiPlaceOrderRequest */ export interface StoreApiPlaceOrderRequest { /** * order placed for purchasing the pet - * @type {Order} - * @memberof StoreApiPlaceOrder */ readonly body: Order } /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI implements StoreApiInterface { /** @@ -1522,7 +1288,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { * @param {StoreApiDeleteOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(requestParameters: StoreApiDeleteOrderRequest, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1533,7 +1298,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -1545,7 +1309,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { * @param {StoreApiGetOrderByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(requestParameters: StoreApiGetOrderByIdRequest, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1557,7 +1320,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { * @param {StoreApiPlaceOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(requestParameters: StoreApiPlaceOrderRequest, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -1568,7 +1330,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1867,7 +1628,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -1982,7 +1742,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -2071,8 +1830,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - interface - * @export - * @interface UserApi */ export interface UserApiInterface { /** @@ -2081,7 +1838,6 @@ export interface UserApiInterface { * @param {UserApiCreateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ createUser(requestParameters: UserApiCreateUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -2091,7 +1847,6 @@ export interface UserApiInterface { * @param {UserApiCreateUsersWithArrayInputRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ createUsersWithArrayInput(requestParameters: UserApiCreateUsersWithArrayInputRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -2101,7 +1856,6 @@ export interface UserApiInterface { * @param {UserApiCreateUsersWithListInputRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ createUsersWithListInput(requestParameters: UserApiCreateUsersWithListInputRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -2111,7 +1865,6 @@ export interface UserApiInterface { * @param {UserApiDeleteUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ deleteUser(requestParameters: UserApiDeleteUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -2121,7 +1874,6 @@ export interface UserApiInterface { * @param {UserApiGetUserByNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ getUserByName(requestParameters: UserApiGetUserByNameRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -2131,7 +1883,6 @@ export interface UserApiInterface { * @param {UserApiLoginUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ loginUser(requestParameters: UserApiLoginUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -2140,7 +1891,6 @@ export interface UserApiInterface { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ logoutUser(options?: RawAxiosRequestConfig): AxiosPromise; @@ -2150,7 +1900,6 @@ export interface UserApiInterface { * @param {UserApiUpdateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ updateUser(requestParameters: UserApiUpdateUserRequest, options?: RawAxiosRequestConfig): AxiosPromise; @@ -2158,121 +1907,86 @@ export interface UserApiInterface { /** * Request parameters for createUser operation in UserApi. - * @export - * @interface UserApiCreateUserRequest */ export interface UserApiCreateUserRequest { /** * Created user object - * @type {User} - * @memberof UserApiCreateUser */ readonly body: User } /** * Request parameters for createUsersWithArrayInput operation in UserApi. - * @export - * @interface UserApiCreateUsersWithArrayInputRequest */ export interface UserApiCreateUsersWithArrayInputRequest { /** * List of user object - * @type {Array} - * @memberof UserApiCreateUsersWithArrayInput */ readonly body: Array } /** * Request parameters for createUsersWithListInput operation in UserApi. - * @export - * @interface UserApiCreateUsersWithListInputRequest */ export interface UserApiCreateUsersWithListInputRequest { /** * List of user object - * @type {Array} - * @memberof UserApiCreateUsersWithListInput */ readonly body: Array } /** * Request parameters for deleteUser operation in UserApi. - * @export - * @interface UserApiDeleteUserRequest */ export interface UserApiDeleteUserRequest { /** * The name that needs to be deleted - * @type {string} - * @memberof UserApiDeleteUser */ readonly username: string } /** * Request parameters for getUserByName operation in UserApi. - * @export - * @interface UserApiGetUserByNameRequest */ export interface UserApiGetUserByNameRequest { /** * The name that needs to be fetched. Use user1 for testing. - * @type {string} - * @memberof UserApiGetUserByName */ readonly username: string } /** * Request parameters for loginUser operation in UserApi. - * @export - * @interface UserApiLoginUserRequest */ export interface UserApiLoginUserRequest { /** * The user name for login - * @type {string} - * @memberof UserApiLoginUser */ readonly username: string /** * The password for login in clear text - * @type {string} - * @memberof UserApiLoginUser */ readonly password: string } /** * Request parameters for updateUser operation in UserApi. - * @export - * @interface UserApiUpdateUserRequest */ export interface UserApiUpdateUserRequest { /** * name that need to be deleted - * @type {string} - * @memberof UserApiUpdateUser */ readonly username: string /** * Updated user object - * @type {User} - * @memberof UserApiUpdateUser */ readonly body: User } /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI implements UserApiInterface { /** @@ -2281,7 +1995,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {UserApiCreateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(requestParameters: UserApiCreateUserRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -2293,7 +2006,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {UserApiCreateUsersWithArrayInputRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(requestParameters: UserApiCreateUsersWithArrayInputRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -2305,7 +2017,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {UserApiCreateUsersWithListInputRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(requestParameters: UserApiCreateUsersWithListInputRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -2317,7 +2028,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {UserApiDeleteUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(requestParameters: UserApiDeleteUserRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(requestParameters.username, options).then((request) => request(this.axios, this.basePath)); @@ -2329,7 +2039,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {UserApiGetUserByNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(requestParameters: UserApiGetUserByNameRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(requestParameters.username, options).then((request) => request(this.axios, this.basePath)); @@ -2341,7 +2050,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {UserApiLoginUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(requestParameters: UserApiLoginUserRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(requestParameters.username, requestParameters.password, options).then((request) => request(this.axios, this.basePath)); @@ -2352,7 +2060,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -2364,7 +2071,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {UserApiUpdateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(requestParameters: UserApiUpdateUserRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(requestParameters.username, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/base.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/base.ts +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/common.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/common.ts index e6be09b1fdd6..48a99b2fb1e0 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/common.ts +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/api.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces/api.ts index f420a14d982f..997cad9167da 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/api.ts @@ -25,89 +25,31 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -121,45 +63,16 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -173,82 +86,30 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -603,7 +464,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -723,7 +583,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -819,8 +678,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - interface - * @export - * @interface PetApi */ export interface PetApiInterface { /** @@ -829,7 +686,6 @@ export interface PetApiInterface { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ addPet(body: Pet, options?: RawAxiosRequestConfig): AxiosPromise; @@ -840,7 +696,6 @@ export interface PetApiInterface { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig): AxiosPromise; @@ -850,7 +705,6 @@ export interface PetApiInterface { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ findPetsByStatus(status: Array, options?: RawAxiosRequestConfig): AxiosPromise>; @@ -861,7 +715,6 @@ export interface PetApiInterface { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApiInterface */ findPetsByTags(tags: Array, options?: RawAxiosRequestConfig): AxiosPromise>; @@ -871,7 +724,6 @@ export interface PetApiInterface { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ getPetById(petId: number, options?: RawAxiosRequestConfig): AxiosPromise; @@ -881,7 +733,6 @@ export interface PetApiInterface { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ updatePet(body: Pet, options?: RawAxiosRequestConfig): AxiosPromise; @@ -893,7 +744,6 @@ export interface PetApiInterface { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig): AxiosPromise; @@ -905,7 +755,6 @@ export interface PetApiInterface { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApiInterface */ uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig): AxiosPromise; @@ -913,9 +762,6 @@ export interface PetApiInterface { /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI implements PetApiInterface { /** @@ -924,7 +770,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(body, options).then((request) => request(this.axios, this.basePath)); @@ -937,7 +782,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -949,7 +793,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -962,7 +805,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -974,7 +816,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -986,7 +827,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(body, options).then((request) => request(this.axios, this.basePath)); @@ -1000,7 +840,6 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -1014,16 +853,12 @@ export class PetApi extends BaseAPI implements PetApiInterface { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -1034,7 +869,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1180,7 +1014,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -1241,7 +1074,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -1290,8 +1122,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - interface - * @export - * @interface StoreApi */ export interface StoreApiInterface { /** @@ -1300,7 +1130,6 @@ export interface StoreApiInterface { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApiInterface */ deleteOrder(orderId: string, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1309,7 +1138,6 @@ export interface StoreApiInterface { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApiInterface */ getInventory(options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: number; }>; @@ -1319,7 +1147,6 @@ export interface StoreApiInterface { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApiInterface */ getOrderById(orderId: number, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1329,7 +1156,6 @@ export interface StoreApiInterface { * @param {Order} body order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApiInterface */ placeOrder(body: Order, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1337,9 +1163,6 @@ export interface StoreApiInterface { /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI implements StoreApiInterface { /** @@ -1348,7 +1171,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1359,7 +1181,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -1371,7 +1192,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1383,7 +1203,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { * @param {Order} body order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(body: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(body, options).then((request) => request(this.axios, this.basePath)); @@ -1394,7 +1213,6 @@ export class StoreApi extends BaseAPI implements StoreApiInterface { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1693,7 +1511,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -1808,7 +1625,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -1899,8 +1715,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - interface - * @export - * @interface UserApi */ export interface UserApiInterface { /** @@ -1909,7 +1723,6 @@ export interface UserApiInterface { * @param {User} body Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ createUser(body: User, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1919,7 +1732,6 @@ export interface UserApiInterface { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ createUsersWithArrayInput(body: Array, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1929,7 +1741,6 @@ export interface UserApiInterface { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ createUsersWithListInput(body: Array, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1939,7 +1750,6 @@ export interface UserApiInterface { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ deleteUser(username: string, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1949,7 +1759,6 @@ export interface UserApiInterface { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ getUserByName(username: string, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1960,7 +1769,6 @@ export interface UserApiInterface { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ loginUser(username: string, password: string, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1969,7 +1777,6 @@ export interface UserApiInterface { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ logoutUser(options?: RawAxiosRequestConfig): AxiosPromise; @@ -1980,7 +1787,6 @@ export interface UserApiInterface { * @param {User} body Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApiInterface */ updateUser(username: string, body: User, options?: RawAxiosRequestConfig): AxiosPromise; @@ -1988,9 +1794,6 @@ export interface UserApiInterface { /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI implements UserApiInterface { /** @@ -1999,7 +1802,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {User} body Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(body, options).then((request) => request(this.axios, this.basePath)); @@ -2011,7 +1813,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -2023,7 +1824,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -2035,7 +1835,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -2047,7 +1846,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -2060,7 +1858,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -2071,7 +1868,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -2084,7 +1880,6 @@ export class UserApi extends BaseAPI implements UserApiInterface { * @param {User} body Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/base.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces/base.ts +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/common.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces/common.ts index e6be09b1fdd6..48a99b2fb1e0 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces/common.ts +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-interfaces/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/api.ts b/samples/client/petstore/typescript-axios/builds/with-node-imports/api.ts index 1e960d666b57..9887f1c7fadb 100644 --- a/samples/client/petstore/typescript-axios/builds/with-node-imports/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/api.ts @@ -29,89 +29,31 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -125,45 +67,16 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -177,82 +90,30 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -607,7 +468,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -727,7 +587,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -823,9 +682,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -834,7 +690,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(body, options).then((request) => request(this.axios, this.basePath)); @@ -847,7 +702,6 @@ export class PetApi extends BaseAPI { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -859,7 +713,6 @@ export class PetApi extends BaseAPI { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -872,7 +725,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -884,7 +736,6 @@ export class PetApi extends BaseAPI { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -896,7 +747,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(body, options).then((request) => request(this.axios, this.basePath)); @@ -910,7 +760,6 @@ export class PetApi extends BaseAPI { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -924,16 +773,12 @@ export class PetApi extends BaseAPI { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -944,7 +789,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1088,7 +932,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -1149,7 +992,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -1198,9 +1040,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -1209,7 +1048,6 @@ export class StoreApi extends BaseAPI { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1220,7 +1058,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -1232,7 +1069,6 @@ export class StoreApi extends BaseAPI { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1244,7 +1080,6 @@ export class StoreApi extends BaseAPI { * @param {Order} [body] order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(body?: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(body, options).then((request) => request(this.axios, this.basePath)); @@ -1255,7 +1090,6 @@ export class StoreApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1554,7 +1388,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -1669,7 +1502,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -1760,9 +1592,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -1771,7 +1600,6 @@ export class UserApi extends BaseAPI { * @param {User} body Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(body, options).then((request) => request(this.axios, this.basePath)); @@ -1783,7 +1611,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1795,7 +1622,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1807,7 +1633,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -1819,7 +1644,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -1832,7 +1656,6 @@ export class UserApi extends BaseAPI { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -1843,7 +1666,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -1856,7 +1678,6 @@ export class UserApi extends BaseAPI { * @param {User} body Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/base.ts b/samples/client/petstore/typescript-axios/builds/with-node-imports/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/with-node-imports/base.ts +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/common.ts b/samples/client/petstore/typescript-axios/builds/with-node-imports/common.ts index dbdacb60f824..69c609709819 100644 --- a/samples/client/petstore/typescript-axios/builds/with-node-imports/common.ts +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/common.ts @@ -19,16 +19,11 @@ import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; import { URL, URLSearchParams } from 'url'; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -36,10 +31,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -49,20 +40,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -72,10 +55,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -107,20 +86,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -131,18 +102,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-node-imports/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/with-node-imports/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/pet-api.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/pet-api.ts index 7d1587e114d9..93c8f1e8f893 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/pet-api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/pet-api.ts @@ -27,7 +27,6 @@ import type { ApiResponse } from '../../../model/some/levels/deep'; import type { Pet } from '../../../model/some/levels/deep'; /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -382,7 +381,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -502,7 +500,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -598,9 +595,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -609,7 +603,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(body, options).then((request) => request(this.axios, this.basePath)); @@ -622,7 +615,6 @@ export class PetApi extends BaseAPI { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -634,7 +626,6 @@ export class PetApi extends BaseAPI { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -647,7 +638,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -659,7 +649,6 @@ export class PetApi extends BaseAPI { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -671,7 +660,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(body, options).then((request) => request(this.axios, this.basePath)); @@ -685,7 +673,6 @@ export class PetApi extends BaseAPI { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -699,16 +686,12 @@ export class PetApi extends BaseAPI { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/store-api.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/store-api.ts index 0fcfd906cc8c..11c75f8d1a65 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/store-api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/store-api.ts @@ -25,7 +25,6 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError import type { Order } from '../../../model/some/levels/deep'; /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -171,7 +170,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -232,7 +230,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -281,9 +278,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -292,7 +286,6 @@ export class StoreApi extends BaseAPI { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -303,7 +296,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -315,7 +307,6 @@ export class StoreApi extends BaseAPI { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -327,7 +318,6 @@ export class StoreApi extends BaseAPI { * @param {Order} body order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(body: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/user-api.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/user-api.ts index 7d6d6aeb2b66..fa726a095dc9 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/user-api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/api/another/level/user-api.ts @@ -25,7 +25,6 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError import type { User } from '../../../model/some/levels/deep'; /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -324,7 +323,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -439,7 +437,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -530,9 +527,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -541,7 +535,6 @@ export class UserApi extends BaseAPI { * @param {User} body Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(body, options).then((request) => request(this.axios, this.basePath)); @@ -553,7 +546,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -565,7 +557,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -577,7 +568,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -589,7 +579,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -602,7 +591,6 @@ export class UserApi extends BaseAPI { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -613,7 +601,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -626,7 +613,6 @@ export class UserApi extends BaseAPI { * @param {User} body Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/base.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/base.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/common.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/common.ts index e6be09b1fdd6..48a99b2fb1e0 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/common.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/api-response.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/api-response.ts index 6b04a026e17f..8a7ede2299e8 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/api-response.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/api-response.ts @@ -16,27 +16,10 @@ /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/category.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/category.ts index 9e615116bb3e..a9e49cab89aa 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/category.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/category.ts @@ -16,21 +16,9 @@ /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/order.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/order.ts index 1ed788e1ec8f..3d93c81bdece 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/order.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/order.ts @@ -16,45 +16,16 @@ /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/pet.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/pet.ts index e0378b94c286..55e3a08cf99d 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/pet.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/pet.ts @@ -22,45 +22,16 @@ import type { Tag } from './tag'; /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/tag.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/tag.ts index 3529b9273085..607244456831 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/tag.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/tag.ts @@ -16,21 +16,9 @@ /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/user.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/user.ts index a33949559e3d..24242f6738fd 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/user.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/model/some/levels/deep/user.ts @@ -16,57 +16,18 @@ /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/api.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version/api.ts index a8605bb76b54..22a7ff99e9fd 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/api.ts @@ -25,89 +25,31 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -121,45 +63,16 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -173,82 +86,30 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -603,7 +464,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -723,7 +583,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -819,9 +678,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -830,7 +686,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(body, options).then((request) => request(this.axios, this.basePath)); @@ -843,7 +698,6 @@ export class PetApi extends BaseAPI { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -855,7 +709,6 @@ export class PetApi extends BaseAPI { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -868,7 +721,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -880,7 +732,6 @@ export class PetApi extends BaseAPI { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -892,7 +743,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(body, options).then((request) => request(this.axios, this.basePath)); @@ -906,7 +756,6 @@ export class PetApi extends BaseAPI { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -920,16 +769,12 @@ export class PetApi extends BaseAPI { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -940,7 +785,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1086,7 +930,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -1147,7 +990,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -1196,9 +1038,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -1207,7 +1046,6 @@ export class StoreApi extends BaseAPI { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1218,7 +1056,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -1230,7 +1067,6 @@ export class StoreApi extends BaseAPI { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1242,7 +1078,6 @@ export class StoreApi extends BaseAPI { * @param {Order} body order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(body: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(body, options).then((request) => request(this.axios, this.basePath)); @@ -1253,7 +1088,6 @@ export class StoreApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1552,7 +1386,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -1667,7 +1500,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -1758,9 +1590,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -1769,7 +1598,6 @@ export class UserApi extends BaseAPI { * @param {User} body Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(body, options).then((request) => request(this.axios, this.basePath)); @@ -1781,7 +1609,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1793,7 +1620,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1805,7 +1631,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -1817,7 +1642,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -1830,7 +1654,6 @@ export class UserApi extends BaseAPI { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -1841,7 +1664,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -1854,7 +1676,6 @@ export class UserApi extends BaseAPI { * @param {User} body Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/base.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version/base.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/common.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version/common.ts index e6be09b1fdd6..48a99b2fb1e0 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version/common.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-npm-version/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/api.ts b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/api.ts index d2c2e92a5de9..9070fc0d75bf 100644 --- a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/api.ts @@ -25,89 +25,31 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } @@ -121,45 +63,16 @@ export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnu /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } @@ -173,82 +86,30 @@ export type PetStatusEnum = typeof PetStatusEnum[keyof typeof PetStatusEnum]; /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -603,7 +464,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -723,7 +583,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -814,156 +673,108 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * Request parameters for addPet operation in PetApi. - * @export - * @interface PetApiAddPetRequest */ export interface PetApiAddPetRequest { /** * Pet object that needs to be added to the store - * @type {Pet} - * @memberof PetApiAddPet */ readonly body: Pet } /** * Request parameters for deletePet operation in PetApi. - * @export - * @interface PetApiDeletePetRequest */ export interface PetApiDeletePetRequest { /** * Pet id to delete - * @type {number} - * @memberof PetApiDeletePet */ readonly petId: number - /** - * - * @type {string} - * @memberof PetApiDeletePet - */ readonly apiKey?: string } /** * Request parameters for findPetsByStatus operation in PetApi. - * @export - * @interface PetApiFindPetsByStatusRequest */ export interface PetApiFindPetsByStatusRequest { /** * Status values that need to be considered for filter - * @type {Array<'available' | 'pending' | 'sold'>} - * @memberof PetApiFindPetsByStatus */ readonly status: Array } /** * Request parameters for findPetsByTags operation in PetApi. - * @export - * @interface PetApiFindPetsByTagsRequest */ export interface PetApiFindPetsByTagsRequest { /** * Tags to filter by - * @type {Array} - * @memberof PetApiFindPetsByTags */ readonly tags: Array } /** * Request parameters for getPetById operation in PetApi. - * @export - * @interface PetApiGetPetByIdRequest */ export interface PetApiGetPetByIdRequest { /** * ID of pet to return - * @type {number} - * @memberof PetApiGetPetById */ readonly petId: number } /** * Request parameters for updatePet operation in PetApi. - * @export - * @interface PetApiUpdatePetRequest */ export interface PetApiUpdatePetRequest { /** * Pet object that needs to be added to the store - * @type {Pet} - * @memberof PetApiUpdatePet */ readonly body: Pet } /** * Request parameters for updatePetWithForm operation in PetApi. - * @export - * @interface PetApiUpdatePetWithFormRequest */ export interface PetApiUpdatePetWithFormRequest { /** * ID of pet that needs to be updated - * @type {number} - * @memberof PetApiUpdatePetWithForm */ readonly petId: number /** * Updated name of the pet - * @type {string} - * @memberof PetApiUpdatePetWithForm */ readonly name?: string /** * Updated status of the pet - * @type {string} - * @memberof PetApiUpdatePetWithForm */ readonly status?: string } /** * Request parameters for uploadFile operation in PetApi. - * @export - * @interface PetApiUploadFileRequest */ export interface PetApiUploadFileRequest { /** * ID of pet to update - * @type {number} - * @memberof PetApiUploadFile */ readonly petId: number /** * Additional data to pass to server - * @type {string} - * @memberof PetApiUploadFile */ readonly additionalMetadata?: string /** * file to upload - * @type {File} - * @memberof PetApiUploadFile */ readonly file?: File } /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -972,7 +783,6 @@ export class PetApi extends BaseAPI { * @param {PetApiAddPetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(requestParameters: PetApiAddPetRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -984,7 +794,6 @@ export class PetApi extends BaseAPI { * @param {PetApiDeletePetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(requestParameters: PetApiDeletePetRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(requestParameters.petId, requestParameters.apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -996,7 +805,6 @@ export class PetApi extends BaseAPI { * @param {PetApiFindPetsByStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(requestParameters: PetApiFindPetsByStatusRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(requestParameters.status, options).then((request) => request(this.axios, this.basePath)); @@ -1009,7 +817,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(requestParameters: PetApiFindPetsByTagsRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(requestParameters.tags, options).then((request) => request(this.axios, this.basePath)); @@ -1021,7 +828,6 @@ export class PetApi extends BaseAPI { * @param {PetApiGetPetByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(requestParameters: PetApiGetPetByIdRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(requestParameters.petId, options).then((request) => request(this.axios, this.basePath)); @@ -1033,7 +839,6 @@ export class PetApi extends BaseAPI { * @param {PetApiUpdatePetRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(requestParameters: PetApiUpdatePetRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -1045,7 +850,6 @@ export class PetApi extends BaseAPI { * @param {PetApiUpdatePetWithFormRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(requestParameters: PetApiUpdatePetWithFormRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(requestParameters.petId, requestParameters.name, requestParameters.status, options).then((request) => request(this.axios, this.basePath)); @@ -1057,16 +861,12 @@ export class PetApi extends BaseAPI { * @param {PetApiUploadFileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(requestParameters: PetApiUploadFileRequest, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(requestParameters.petId, requestParameters.additionalMetadata, requestParameters.file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - */ export const FindPetsByStatusStatusEnum = { Available: 'available', Pending: 'pending', @@ -1077,7 +877,6 @@ export type FindPetsByStatusStatusEnum = typeof FindPetsByStatusStatusEnum[keyof /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1221,7 +1020,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -1282,7 +1080,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -1331,51 +1128,36 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * Request parameters for deleteOrder operation in StoreApi. - * @export - * @interface StoreApiDeleteOrderRequest */ export interface StoreApiDeleteOrderRequest { /** * ID of the order that needs to be deleted - * @type {string} - * @memberof StoreApiDeleteOrder */ readonly orderId: string } /** * Request parameters for getOrderById operation in StoreApi. - * @export - * @interface StoreApiGetOrderByIdRequest */ export interface StoreApiGetOrderByIdRequest { /** * ID of pet that needs to be fetched - * @type {number} - * @memberof StoreApiGetOrderById */ readonly orderId: number } /** * Request parameters for placeOrder operation in StoreApi. - * @export - * @interface StoreApiPlaceOrderRequest */ export interface StoreApiPlaceOrderRequest { /** * order placed for purchasing the pet - * @type {Order} - * @memberof StoreApiPlaceOrder */ readonly body?: Order } /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -1384,7 +1166,6 @@ export class StoreApi extends BaseAPI { * @param {StoreApiDeleteOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(requestParameters: StoreApiDeleteOrderRequest, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1395,7 +1176,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -1407,7 +1187,6 @@ export class StoreApi extends BaseAPI { * @param {StoreApiGetOrderByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(requestParameters: StoreApiGetOrderByIdRequest, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1419,7 +1198,6 @@ export class StoreApi extends BaseAPI { * @param {StoreApiPlaceOrderRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(requestParameters: StoreApiPlaceOrderRequest = {}, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -1430,7 +1208,6 @@ export class StoreApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1729,7 +1506,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -1844,7 +1620,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -1933,121 +1708,86 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * Request parameters for createUser operation in UserApi. - * @export - * @interface UserApiCreateUserRequest */ export interface UserApiCreateUserRequest { /** * Created user object - * @type {User} - * @memberof UserApiCreateUser */ readonly body: User } /** * Request parameters for createUsersWithArrayInput operation in UserApi. - * @export - * @interface UserApiCreateUsersWithArrayInputRequest */ export interface UserApiCreateUsersWithArrayInputRequest { /** * List of user object - * @type {Array} - * @memberof UserApiCreateUsersWithArrayInput */ readonly body: Array } /** * Request parameters for createUsersWithListInput operation in UserApi. - * @export - * @interface UserApiCreateUsersWithListInputRequest */ export interface UserApiCreateUsersWithListInputRequest { /** * List of user object - * @type {Array} - * @memberof UserApiCreateUsersWithListInput */ readonly body: Array } /** * Request parameters for deleteUser operation in UserApi. - * @export - * @interface UserApiDeleteUserRequest */ export interface UserApiDeleteUserRequest { /** * The name that needs to be deleted - * @type {string} - * @memberof UserApiDeleteUser */ readonly username: string } /** * Request parameters for getUserByName operation in UserApi. - * @export - * @interface UserApiGetUserByNameRequest */ export interface UserApiGetUserByNameRequest { /** * The name that needs to be fetched. Use user1 for testing. - * @type {string} - * @memberof UserApiGetUserByName */ readonly username: string } /** * Request parameters for loginUser operation in UserApi. - * @export - * @interface UserApiLoginUserRequest */ export interface UserApiLoginUserRequest { /** * The user name for login - * @type {string} - * @memberof UserApiLoginUser */ readonly username: string /** * The password for login in clear text - * @type {string} - * @memberof UserApiLoginUser */ readonly password: string } /** * Request parameters for updateUser operation in UserApi. - * @export - * @interface UserApiUpdateUserRequest */ export interface UserApiUpdateUserRequest { /** * name that need to be deleted - * @type {string} - * @memberof UserApiUpdateUser */ readonly username: string /** * Updated user object - * @type {User} - * @memberof UserApiUpdateUser */ readonly body: User } /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -2056,7 +1796,6 @@ export class UserApi extends BaseAPI { * @param {UserApiCreateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(requestParameters: UserApiCreateUserRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -2068,7 +1807,6 @@ export class UserApi extends BaseAPI { * @param {UserApiCreateUsersWithArrayInputRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(requestParameters: UserApiCreateUsersWithArrayInputRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -2080,7 +1818,6 @@ export class UserApi extends BaseAPI { * @param {UserApiCreateUsersWithListInputRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(requestParameters: UserApiCreateUsersWithListInputRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(requestParameters.body, options).then((request) => request(this.axios, this.basePath)); @@ -2092,7 +1829,6 @@ export class UserApi extends BaseAPI { * @param {UserApiDeleteUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(requestParameters: UserApiDeleteUserRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(requestParameters.username, options).then((request) => request(this.axios, this.basePath)); @@ -2104,7 +1840,6 @@ export class UserApi extends BaseAPI { * @param {UserApiGetUserByNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(requestParameters: UserApiGetUserByNameRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(requestParameters.username, options).then((request) => request(this.axios, this.basePath)); @@ -2116,7 +1851,6 @@ export class UserApi extends BaseAPI { * @param {UserApiLoginUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(requestParameters: UserApiLoginUserRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(requestParameters.username, requestParameters.password, options).then((request) => request(this.axios, this.basePath)); @@ -2127,7 +1861,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -2139,7 +1872,6 @@ export class UserApi extends BaseAPI { * @param {UserApiUpdateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(requestParameters: UserApiUpdateUserRequest, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(requestParameters.username, requestParameters.body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/base.ts b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/base.ts +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/common.ts b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/common.ts index e6be09b1fdd6..48a99b2fb1e0 100644 --- a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/common.ts +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /** diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/api.ts b/samples/client/petstore/typescript-axios/builds/with-string-enums/api.ts index ef7d47558d90..48406b52c3cd 100644 --- a/samples/client/petstore/typescript-axios/builds/with-string-enums/api.ts +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/api.ts @@ -25,96 +25,34 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerM /** * Describes the result of uploading an image resource - * @export - * @interface ApiResponse */ export interface ApiResponse { - /** - * - * @type {number} - * @memberof ApiResponse - */ 'code'?: number; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'type'?: string; - /** - * - * @type {string} - * @memberof ApiResponse - */ 'message'?: string; } /** * A category for a pet - * @export - * @interface Category */ export interface Category { - /** - * - * @type {number} - * @memberof Category - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Category - */ 'name'?: string; } /** * An order for a pets from the pet store - * @export - * @interface Order */ export interface Order { - /** - * - * @type {number} - * @memberof Order - */ 'id'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'petId'?: number; - /** - * - * @type {number} - * @memberof Order - */ 'quantity'?: number; - /** - * - * @type {string} - * @memberof Order - */ 'shipDate'?: string; /** - * Order Status - * @type {string} - * @memberof Order - */ + * Order Status + */ 'status'?: OrderStatusEnum; - /** - * - * @type {boolean} - * @memberof Order - */ 'complete'?: boolean; } -/** - * @export - * @enum {string} - */ export enum OrderStatusEnum { Placed = 'placed', Approved = 'approved', @@ -123,52 +61,19 @@ export enum OrderStatusEnum { /** * A pet for sale in the pet store - * @export - * @interface Pet */ export interface Pet { - /** - * - * @type {number} - * @memberof Pet - */ 'id'?: number; - /** - * - * @type {Category} - * @memberof Pet - */ 'category'?: Category; - /** - * - * @type {string} - * @memberof Pet - */ 'name': string; - /** - * - * @type {Array} - * @memberof Pet - */ 'photoUrls': Array; - /** - * - * @type {Array} - * @memberof Pet - */ 'tags'?: Array; /** - * pet status in the store - * @type {string} - * @memberof Pet - */ + * pet status in the store + */ 'status'?: PetStatusEnum; } -/** - * @export - * @enum {string} - */ export enum PetStatusEnum { Available = 'available', Pending = 'pending', @@ -177,82 +82,30 @@ export enum PetStatusEnum { /** * A tag for a pet - * @export - * @interface Tag */ export interface Tag { - /** - * - * @type {number} - * @memberof Tag - */ 'id'?: number; - /** - * - * @type {string} - * @memberof Tag - */ 'name'?: string; } /** * A User who is purchasing from the pet store - * @export - * @interface User */ export interface User { - /** - * - * @type {number} - * @memberof User - */ 'id'?: number; - /** - * - * @type {string} - * @memberof User - */ 'username'?: string; - /** - * - * @type {string} - * @memberof User - */ 'firstName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'lastName'?: string; - /** - * - * @type {string} - * @memberof User - */ 'email'?: string; - /** - * - * @type {string} - * @memberof User - */ 'password'?: string; - /** - * - * @type {string} - * @memberof User - */ 'phone'?: string; /** - * User Status - * @type {number} - * @memberof User - */ + * User Status + */ 'userStatus'?: number; } /** * PetApi - axios parameter creator - * @export */ export const PetApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -607,7 +460,6 @@ export const PetApiAxiosParamCreator = function (configuration?: Configuration) /** * PetApi - functional programming interface - * @export */ export const PetApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = PetApiAxiosParamCreator(configuration) @@ -727,7 +579,6 @@ export const PetApiFp = function(configuration?: Configuration) { /** * PetApi - factory interface - * @export */ export const PetApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = PetApiFp(configuration) @@ -823,9 +674,6 @@ export const PetApiFactory = function (configuration?: Configuration, basePath?: /** * PetApi - object-oriented interface - * @export - * @class PetApi - * @extends {BaseAPI} */ export class PetApi extends BaseAPI { /** @@ -834,7 +682,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public addPet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).addPet(body, options).then((request) => request(this.axios, this.basePath)); @@ -847,7 +694,6 @@ export class PetApi extends BaseAPI { * @param {string} [apiKey] * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public deletePet(petId: number, apiKey?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).deletePet(petId, apiKey, options).then((request) => request(this.axios, this.basePath)); @@ -859,7 +705,6 @@ export class PetApi extends BaseAPI { * @param {Array} status Status values that need to be considered for filter * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public findPetsByStatus(status: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByStatus(status, options).then((request) => request(this.axios, this.basePath)); @@ -872,7 +717,6 @@ export class PetApi extends BaseAPI { * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} - * @memberof PetApi */ public findPetsByTags(tags: Array, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).findPetsByTags(tags, options).then((request) => request(this.axios, this.basePath)); @@ -884,7 +728,6 @@ export class PetApi extends BaseAPI { * @param {number} petId ID of pet to return * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public getPetById(petId: number, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).getPetById(petId, options).then((request) => request(this.axios, this.basePath)); @@ -896,7 +739,6 @@ export class PetApi extends BaseAPI { * @param {Pet} body Pet object that needs to be added to the store * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePet(body: Pet, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePet(body, options).then((request) => request(this.axios, this.basePath)); @@ -910,7 +752,6 @@ export class PetApi extends BaseAPI { * @param {string} [status] Updated status of the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public updatePetWithForm(petId: number, name?: string, status?: string, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).updatePetWithForm(petId, name, status, options).then((request) => request(this.axios, this.basePath)); @@ -924,17 +765,12 @@ export class PetApi extends BaseAPI { * @param {File} [file] file to upload * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof PetApi */ public uploadFile(petId: number, additionalMetadata?: string, file?: File, options?: RawAxiosRequestConfig) { return PetApiFp(this.configuration).uploadFile(petId, additionalMetadata, file, options).then((request) => request(this.axios, this.basePath)); } } -/** - * @export - * @enum {string} - */ export enum FindPetsByStatusStatusEnum { Available = 'available', Pending = 'pending', @@ -944,7 +780,6 @@ export enum FindPetsByStatusStatusEnum { /** * StoreApi - axios parameter creator - * @export */ export const StoreApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1090,7 +925,6 @@ export const StoreApiAxiosParamCreator = function (configuration?: Configuration /** * StoreApi - functional programming interface - * @export */ export const StoreApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = StoreApiAxiosParamCreator(configuration) @@ -1151,7 +985,6 @@ export const StoreApiFp = function(configuration?: Configuration) { /** * StoreApi - factory interface - * @export */ export const StoreApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = StoreApiFp(configuration) @@ -1200,9 +1033,6 @@ export const StoreApiFactory = function (configuration?: Configuration, basePath /** * StoreApi - object-oriented interface - * @export - * @class StoreApi - * @extends {BaseAPI} */ export class StoreApi extends BaseAPI { /** @@ -1211,7 +1041,6 @@ export class StoreApi extends BaseAPI { * @param {string} orderId ID of the order that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public deleteOrder(orderId: string, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).deleteOrder(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1222,7 +1051,6 @@ export class StoreApi extends BaseAPI { * @summary Returns pet inventories by status * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getInventory(options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getInventory(options).then((request) => request(this.axios, this.basePath)); @@ -1234,7 +1062,6 @@ export class StoreApi extends BaseAPI { * @param {number} orderId ID of pet that needs to be fetched * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public getOrderById(orderId: number, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).getOrderById(orderId, options).then((request) => request(this.axios, this.basePath)); @@ -1246,7 +1073,6 @@ export class StoreApi extends BaseAPI { * @param {Order} body order placed for purchasing the pet * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof StoreApi */ public placeOrder(body: Order, options?: RawAxiosRequestConfig) { return StoreApiFp(this.configuration).placeOrder(body, options).then((request) => request(this.axios, this.basePath)); @@ -1257,7 +1083,6 @@ export class StoreApi extends BaseAPI { /** * UserApi - axios parameter creator - * @export */ export const UserApiAxiosParamCreator = function (configuration?: Configuration) { return { @@ -1556,7 +1381,6 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * UserApi - functional programming interface - * @export */ export const UserApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration) @@ -1671,7 +1495,6 @@ export const UserApiFp = function(configuration?: Configuration) { /** * UserApi - factory interface - * @export */ export const UserApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = UserApiFp(configuration) @@ -1762,9 +1585,6 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * UserApi - object-oriented interface - * @export - * @class UserApi - * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** @@ -1773,7 +1593,6 @@ export class UserApi extends BaseAPI { * @param {User} body Created user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUser(body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUser(body, options).then((request) => request(this.axios, this.basePath)); @@ -1785,7 +1604,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithArrayInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithArrayInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1797,7 +1615,6 @@ export class UserApi extends BaseAPI { * @param {Array} body List of user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public createUsersWithListInput(body: Array, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).createUsersWithListInput(body, options).then((request) => request(this.axios, this.basePath)); @@ -1809,7 +1626,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be deleted * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public deleteUser(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).deleteUser(username, options).then((request) => request(this.axios, this.basePath)); @@ -1821,7 +1637,6 @@ export class UserApi extends BaseAPI { * @param {string} username The name that needs to be fetched. Use user1 for testing. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public getUserByName(username: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).getUserByName(username, options).then((request) => request(this.axios, this.basePath)); @@ -1834,7 +1649,6 @@ export class UserApi extends BaseAPI { * @param {string} password The password for login in clear text * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public loginUser(username: string, password: string, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).loginUser(username, password, options).then((request) => request(this.axios, this.basePath)); @@ -1845,7 +1659,6 @@ export class UserApi extends BaseAPI { * @summary Logs out current logged in user session * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public logoutUser(options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).logoutUser(options).then((request) => request(this.axios, this.basePath)); @@ -1858,7 +1671,6 @@ export class UserApi extends BaseAPI { * @param {User} body Updated user object * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof UserApi */ public updateUser(username: string, body: User, options?: RawAxiosRequestConfig) { return UserApiFp(this.configuration).updateUser(username, body, options).then((request) => request(this.axios, this.basePath)); diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/base.ts b/samples/client/petstore/typescript-axios/builds/with-string-enums/base.ts index b92a383a84c7..b67c62acc84f 100644 --- a/samples/client/petstore/typescript-axios/builds/with-string-enums/base.ts +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/base.ts @@ -21,10 +21,6 @@ import globalAxios from 'axios'; export const BASE_PATH = "http://petstore.swagger.io/v2".replace(/\/+$/, ""); -/** - * - * @export - */ export const COLLECTION_FORMATS = { csv: ",", ssv: " ", @@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = { pipes: "|", }; -/** - * - * @export - * @interface RequestArgs - */ export interface RequestArgs { url: string; options: RawAxiosRequestConfig; } -/** - * - * @export - * @class BaseAPI - */ export class BaseAPI { protected configuration: Configuration | undefined; @@ -58,12 +44,6 @@ export class BaseAPI { } }; -/** - * - * @export - * @class RequiredError - * @extends {Error} - */ export class RequiredError extends Error { constructor(public field: string, msg?: string) { super(msg); @@ -78,9 +58,5 @@ interface ServerMap { }[]; } -/** - * - * @export - */ export const operationServerMap: ServerMap = { } diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/common.ts b/samples/client/petstore/typescript-axios/builds/with-string-enums/common.ts index e6be09b1fdd6..48a99b2fb1e0 100644 --- a/samples/client/petstore/typescript-axios/builds/with-string-enums/common.ts +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/common.ts @@ -18,16 +18,11 @@ import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; import { RequiredError } from "./base"; -/** - * - * @export - */ export const DUMMY_BASE_URL = 'https://example.com' /** * * @throws {RequiredError} - * @export */ export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { if (paramValue === null || paramValue === undefined) { @@ -35,10 +30,6 @@ export const assertParamExists = function (functionName: string, paramName: stri } } -/** - * - * @export - */ export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { if (configuration && configuration.apiKey) { const localVarApiKeyValue = typeof configuration.apiKey === 'function' @@ -48,20 +39,12 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri } } -/** - * - * @export - */ export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { if (configuration && (configuration.username || configuration.password)) { object["auth"] = { username: configuration.username, password: configuration.password }; } } -/** - * - * @export - */ export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { if (configuration && configuration.accessToken) { const accessToken = typeof configuration.accessToken === 'function' @@ -71,10 +54,6 @@ export const setBearerAuthToObject = async function (object: any, configuration? } } -/** - * - * @export - */ export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { if (configuration && configuration.accessToken) { const localVarAccessTokenValue = typeof configuration.accessToken === 'function' @@ -106,20 +85,12 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an } } -/** - * - * @export - */ export const setSearchParams = function (url: URL, ...objects: any[]) { const searchParams = new URLSearchParams(url.search); setFlattenedQueryParams(searchParams, objects); url.search = searchParams.toString(); } -/** - * - * @export - */ export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { const nonString = typeof value !== 'string'; const needsSerialization = nonString && configuration && configuration.isJsonMime @@ -130,18 +101,10 @@ export const serializeDataIfNeeded = function (value: any, requestOptions: any, : (value || ""); } -/** - * - * @export - */ export const toPathString = function (url: URL) { return url.pathname + url.search + url.hash } -/** - * - * @export - */ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url}; diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/configuration.ts b/samples/client/petstore/typescript-axios/builds/with-string-enums/configuration.ts index 9641634b92b3..c50ec4bf5d5b 100644 --- a/samples/client/petstore/typescript-axios/builds/with-string-enums/configuration.ts +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/configuration.ts @@ -28,49 +28,32 @@ export class Configuration { /** * parameter for apiKey security * @param name security name - * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ username?: string; /** * parameter for basic security - * - * @type {string} - * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope - * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * - * @type {string} - * @memberof Configuration */ basePath?: string; /** * override server index - * - * @type {number} - * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls - * - * @type {any} - * @memberof Configuration */ baseOptions?: any; /**