Skip to content

Correctly mark parameters as deprecated #146

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.

Sign up for GitHub

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
skonves merged 1 commit into from
Nov 13, 2025
Merged

Correctly mark parameters as deprecated #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions packages/express/src/snapshot/zod/v1/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ export type ExhaustiveParamsParams = {
};

export type GetGizmosParams = {
/** @deprecated */
search?: string;
};

Expand Down
1 change: 1 addition & 0 deletions packages/http-client/src/snapshot/zod/v1/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ export type ExhaustiveParamsParams = {
};

export type GetGizmosParams = {
/** @deprecated */
search?: string;
};

Expand Down
4 changes: 1 addition & 3 deletions packages/typescript/src/interface-factory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,9 +376,7 @@ function* internalBuildParamsType(
yield '{';

for (const param of sortedParams) {
if (param.description) {
yield* buildDescription(param.description, param.deprecated?.value);
}
yield* buildDescription(param.description, param.deprecated?.value);

yield ` ${buildParameterName(param)}${
isRequired(param.value) ? '' : '?'
Expand Down
5 changes: 2 additions & 3 deletions packages/typescript/src/spec/4.1-structure/4.1.15-parameter.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,7 @@ describe('4.1.15 Parameter', () => {
});
});

// TODO: fix and enable these tests
// https://github.com/basketry/typescript/issues/136
describe.skip('deprecated', () => {
describe('deprecated', () => {
it('creates a parameter marked as deprecated', async () => {
// ARRANGE
const service = sut(
Expand Down Expand Up @@ -174,6 +172,7 @@ describe('4.1.15 Parameter', () => {
value: ir.primitiveValue({
typeName: ir.primitiveLiteral('string'),
}),
deprecated: ir.trueLiteral(),
}),
);

Expand Down