Skip to content

fix(tuple): Repeat tupple type maxItems times #1938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/friendly-wasps-lay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@test/openapi-ts": patch
---

fix: repeat tuple type `maxItems` times
7 changes: 7 additions & 0 deletions packages/openapi-ts-tests/test/3.1.x.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -487,6 +487,13 @@ describe(`OpenAPI ${version}`, () => {
}),
description: 'handles non-exploded array query parameters (Axios)',
},
{
config: createConfig({
input: 'parameter-tuple.json',
output: 'parameter-tuple',
}),
description: 'handles tuple query parameters',
},
{
config: createConfig({
input: 'read-write-only.yaml',
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// This file is auto-generated by @hey-api/openapi-ts

import type { ClientOptions } from './types.gen';
import { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';

/**
* The `createClientConfig()` function will be called on client initialization
* and the returned object will become the client's initial configuration.
*
* You may want to initialize your client this way instead of calling
* `setConfig()`. This is useful for example if you're using Next.js
* to ensure your client always has the correct values.
*/
export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;

export const client = createClient(createConfig<ClientOptions>());
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// This file is auto-generated by @hey-api/openapi-ts
export * from './types.gen';
export * from './sdk.gen';
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// This file is auto-generated by @hey-api/openapi-ts

import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { PostFooData } from './types.gen';
import { client as _heyApiClient } from './client.gen';

export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
/**
* You can provide a client instance returned by `createClient()` instead of
* individual options. This might be also useful if you want to implement a
* custom client.
*/
client?: Client;
/**
* You can pass arbitrary values through the `meta` object. This can be
* used to access values that aren't defined as part of the SDK function.
*/
meta?: Record<string, unknown>;
};

export const postFoo = <ThrowOnError extends boolean = false>(options?: Options<PostFooData, ThrowOnError>) => {
return (options?.client ?? _heyApiClient).post<unknown, unknown, ThrowOnError>({
url: '/foo',
...options
});
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// This file is auto-generated by @hey-api/openapi-ts

export type PostFooData = {
body?: never;
path?: never;
query?: {
tuple?: [
number,
number,
number,
number
];
};
url: '/foo';
};

export type PostFooResponses = {
/**
* OK
*/
default: unknown;
};

export type ClientOptions = {
baseUrl: `${string}://${string}` | (string & {});
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// This file is auto-generated by @hey-api/openapi-ts
export * from './types.gen';
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// This file is auto-generated by @hey-api/openapi-ts

export type PostFooData = {
body?: never;
path?: never;
query?: {
tuple?: [
number,
number,
number,
number
];
};
url: '/foo';
};

export type PostFooResponses = {
/**
* OK
*/
default: unknown;
};

export type ClientOptions = {
baseUrl: `${string}://${string}` | (string & {});
};
Original file line number Diff line number Diff line change
Expand Up @@ -1692,6 +1692,15 @@ export type TypesData = {
* This is an enum parameter
*/
parameterEnum: 'Success' | 'Warning' | 'Error';
/**
* This is tuple parameter
*/
parameterTuple: [
number,
number,
number,
number
];
};
url: '/api/v{api-version}/types';
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,7 @@ export class TypesService {
* @param data.parameterArray This is an array parameter
* @param data.parameterDictionary This is a dictionary parameter
* @param data.parameterEnum This is an enum parameter
* @param data.parameterTuple This is tuple parameter
* @param data.parameterNumber This is a number parameter
* @param data.parameterString This is a string parameter
* @param data.parameterBoolean This is a boolean parameter
Expand All @@ -885,7 +886,8 @@ export class TypesService {
parameterObject: data.parameterObject,
parameterArray: data.parameterArray,
parameterDictionary: data.parameterDictionary,
parameterEnum: data.parameterEnum
parameterEnum: data.parameterEnum,
parameterTuple: data.parameterTuple
}
});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1515,6 +1515,15 @@ export type TypesData = {
* This is a string parameter
*/
parameterString: (string) | null;
/**
* This is tuple parameter
*/
parameterTuple: [
number,
number,
number,
number
];
};

export type TypesResponse = (number | string | boolean | {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -972,6 +972,7 @@ export class TypesService {
* @param data.parameterArray This is an array parameter
* @param data.parameterDictionary This is a dictionary parameter
* @param data.parameterEnum This is an enum parameter
* @param data.parameterTuple This is tuple parameter
* @param data.parameterNumber This is a number parameter
* @param data.parameterString This is a string parameter
* @param data.parameterBoolean This is a boolean parameter
Expand All @@ -997,7 +998,8 @@ export class TypesService {
parameterObject: data.parameterObject,
parameterArray: data.parameterArray,
parameterDictionary: data.parameterDictionary,
parameterEnum: data.parameterEnum
parameterEnum: data.parameterEnum,
parameterTuple: data.parameterTuple
}
});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1392,6 +1392,15 @@ export type TypesData = {
* This is a string parameter
*/
parameterString: (string) | null;
/**
* This is tuple parameter
*/
parameterTuple: [
number,
number,
number,
number
];
};

export type TypesResponse = (number | string | boolean | {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,7 @@ export const collectionFormat = function (data: CollectionFormatData): Observabl
* @param data.parameterArray This is an array parameter
* @param data.parameterDictionary This is a dictionary parameter
* @param data.parameterEnum This is an enum parameter
* @param data.parameterTuple This is tuple parameter
* @param data.parameterNumber This is a number parameter
* @param data.parameterString This is a string parameter
* @param data.parameterBoolean This is a boolean parameter
Expand All @@ -627,7 +628,8 @@ export const types = function (data: TypesData): Observable<TypesResponse> {
parameterObject: data.parameterObject,
parameterArray: data.parameterArray,
parameterDictionary: data.parameterDictionary,
parameterEnum: data.parameterEnum
parameterEnum: data.parameterEnum,
parameterTuple: data.parameterTuple
}
});
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1309,6 +1309,15 @@ export type TypesData = {
* This is a string parameter
*/
parameterString: (string) | null;
/**
* This is tuple parameter
*/
parameterTuple: [
number,
number,
number,
number
];
};

export type TypesResponse = (number | string | boolean | {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,7 @@ export class TypesService {
* @param data.parameterArray This is an array parameter
* @param data.parameterDictionary This is a dictionary parameter
* @param data.parameterEnum This is an enum parameter
* @param data.parameterTuple This is tuple parameter
* @param data.parameterNumber This is a number parameter
* @param data.parameterString This is a string parameter
* @param data.parameterBoolean This is a boolean parameter
Expand All @@ -885,7 +886,8 @@ export class TypesService {
parameterObject: data.parameterObject,
parameterArray: data.parameterArray,
parameterDictionary: data.parameterDictionary,
parameterEnum: data.parameterEnum
parameterEnum: data.parameterEnum,
parameterTuple: data.parameterTuple
}
});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1515,6 +1515,15 @@ export type TypesData = {
* This is a string parameter
*/
parameterString: (string) | null;
/**
* This is tuple parameter
*/
parameterTuple: [
number,
number,
number,
number
];
};

export type TypesResponse = (number | string | boolean | {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -903,6 +903,7 @@ export class TypesService {
* @param data.parameterArray This is an array parameter
* @param data.parameterDictionary This is a dictionary parameter
* @param data.parameterEnum This is an enum parameter
* @param data.parameterTuple This is tuple parameter
* @param data.parameterNumber This is a number parameter
* @param data.parameterString This is a string parameter
* @param data.parameterBoolean This is a boolean parameter
Expand All @@ -928,7 +929,8 @@ export class TypesService {
parameterObject: data.parameterObject,
parameterArray: data.parameterArray,
parameterDictionary: data.parameterDictionary,
parameterEnum: data.parameterEnum
parameterEnum: data.parameterEnum,
parameterTuple: data.parameterTuple
}
});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1392,6 +1392,15 @@ export type TypesData = {
* This is a string parameter
*/
parameterString: (string) | null;
/**
* This is tuple parameter
*/
parameterTuple: [
number,
number,
number,
number
];
};

export type TypesResponse = (number | string | boolean | {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,7 @@ export class TypesService {
* @param data.parameterArray This is an array parameter
* @param data.parameterDictionary This is a dictionary parameter
* @param data.parameterEnum This is an enum parameter
* @param data.parameterTuple This is tuple parameter
* @param data.parameterNumber This is a number parameter
* @param data.parameterString This is a string parameter
* @param data.parameterBoolean This is a boolean parameter
Expand All @@ -885,7 +886,8 @@ export class TypesService {
parameterObject: data.parameterObject,
parameterArray: data.parameterArray,
parameterDictionary: data.parameterDictionary,
parameterEnum: data.parameterEnum
parameterEnum: data.parameterEnum,
parameterTuple: data.parameterTuple
}
});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1471,6 +1471,15 @@ export type TypesData = {
* This is a string parameter
*/
parameterString: (string) | null;
/**
* This is tuple parameter
*/
parameterTuple: [
number,
number,
number,
number
];
};

export type TypesResponse = (number | string | boolean | {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,7 @@ export class TypesService {
* @param data.parameterArray This is an array parameter
* @param data.parameterDictionary This is a dictionary parameter
* @param data.parameterEnum This is an enum parameter
* @param data.parameterTuple This is tuple parameter
* @param data.parameterNumber This is a number parameter
* @param data.parameterString This is a string parameter
* @param data.parameterBoolean This is a boolean parameter
Expand All @@ -885,7 +886,8 @@ export class TypesService {
parameterObject: data.parameterObject,
parameterArray: data.parameterArray,
parameterDictionary: data.parameterDictionary,
parameterEnum: data.parameterEnum
parameterEnum: data.parameterEnum,
parameterTuple: data.parameterTuple
}
});
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1502,6 +1502,15 @@ export type TypesData = {
* This is a string parameter
*/
parameterString: (string) | null;
/**
* This is tuple parameter
*/
parameterTuple: [
number,
number,
number,
number
];
};

export type TypesResponse = (number | string | boolean | {
Expand Down
Loading