Skip to content
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

Jump to bottom

fix(schematic-sdk): to support the multi tag API #1739

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+15 −9
Open

fix(schematic-sdk): to support the multi tag API #1739

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7df34aa
fix(schematic-sdk): to support the multi tag API
kpanot May 1, 2024
26a6bfd
fix(schematic-sdk): breaking change to fully support the multi tags APIs
kpanot Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 12 additions & 6 deletions ...cript/core/openapi-codegen-typescript/src/main/resources/typescriptFetch/api/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,29 @@ import { Api, ApiClient, ApiTypes, computePiiParameterTokens, isJsonMimeType, Re
{{#operation}}
{{#allParams}}
{{#isEnum}}
export type {{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}{{#uppercaseFirst}}{{paramName}}{{/uppercaseFirst}}Enum = {{#trimPipe}}{{#allowableValues}}{{#values}}'{{.}}' | {{/values}}{{/allowableValues}}{{/trimPipe}};
/** Enum {{paramName}} used in the {{classname}}'s {{nickname}} function parameter */
export type {{classname}}{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}{{#uppercaseFirst}}{{paramName}}{{/uppercaseFirst}}Enum = {{#trimPipe}}{{#allowableValues}}{{#values}}'{{.}}' | {{/values}}{{/allowableValues}}{{/trimPipe}};

/** @deprecated please use {{classname}}{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}{{#uppercaseFirst}}{{paramName}}{{/uppercaseFirst}}Enum instead, will be removed in Otter v12 */
export type {{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}{{#uppercaseFirst}}{{paramName}}{{/uppercaseFirst}}Enum = {{classname}}{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}{{#uppercaseFirst}}{{paramName}}{{/uppercaseFirst}}Enum;
{{/isEnum}}
{{/allParams}}
{{/operation}}
{{#operation}}
export interface {{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData {
/** Parameters object to {{classname}}'s {{nickname}} function */
export interface {{classname}}{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData {
{{#allParams}}
/** {{#description}}{{{description}}}{{/description}}{{^description}}{{#isArray}}List of {{#plurialize}}{{#noArrayInType}}{{{dataType}}}{{/noArrayInType}}{{/plurialize}}{{/isArray}}{{/description}} */
'{{baseName}}'{{^required}}?{{/required}}{{#required}}{{#defaultValue}}?{{/defaultValue}}{{/required}}: {{#isEnum}}{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}{{#uppercaseFirst}}{{paramName}}{{/uppercaseFirst}}Enum{{#isArray}}[]{{/isArray}}{{/isEnum}}{{^isEnum}}{{#isBodyParam}}{{{baseType}}}{{#isArray}}[]{{/isArray}}{{/isBodyParam}}{{^isBodyParam}}{{{dataType}}}{{/isBodyParam}}{{/isEnum}};
{{/allParams}}
}
{{/operation}}
{{#operation}}
/**
* @Deprecated, please use {{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData
*/
export interface {{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}} extends {{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData {}
/** @deprecated please use {{classname}}{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData instead, will be remove in Otter v12 */
export interface {{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData extends {{classname}}{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData {}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

even if the interface is deprecated it is still exported, and I am afraid that we will still have duplications on the barrel file, no ?
{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData from one my.api.ts file and the same maybe from another file your.api.ts

Copy link
Contributor Author

@kpanot kpanot May 2, 2024 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, unfortunately the multi tag support cannot be achieved without breaking change (as we cannot really removed an interfaced exported already).
So this PR is an enabler but the support will be effective only after breaking change.


/** @deprecated please use {{classname}}{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData instead, will be remove in Otter v12 */
export interface {{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}} extends {{classname}}{{#uppercaseFirst}}{{nickname}}{{/uppercaseFirst}}RequestData {}

{{/operation}}
{{#description}}
Expand Down