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

remove default value in Modular #1977

Merged
merged 1 commit into from
Aug 18, 2023
Merged

remove default value in Modular #1977

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
2 changes: 1 addition & 1 deletion packages/typespec-test/test/openai_modular/generated/typespec-ts/src/api/operations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ export function _beginAzureBatchImageGenerationSend(
...operationOptionsToRequestParameters(options),
body: {
prompt: prompt,
n: options.n ?? 1,
n: options?.n,
Copy link
Member Author

Choose a reason for hiding this comment

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

This is the change about question mark

size: options?.size,
response_format: options?.responseFormat,
user: options?.user,
Expand Down
58 changes: 12 additions & 46 deletions packages/typespec-ts/src/modular/helpers/operationHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,12 +395,9 @@ function getParameterMap(
return getConstantValue(param);
}

if (isOptionalWithouDefault(param)) {
return getOptionalWithoutDefault(param, importSet);
}

if (isOptionalWithDefault(param)) {
return getOptionalWithDefault(param, importSet);
// if the parameter or property is optional, we don't need to handle the
if (isOptional(param)) {
return getOptional(param, importSet);
}

if (isRequired(param)) {
Expand Down Expand Up @@ -476,16 +473,18 @@ function isConstant(param: Parameter | Property): param is ConstantType {
);
}

type OptionalWithoutDefaultType = (Parameter | Property) & {
type: { optional: true; clientDefaultValue: never };
type OptionalType = (Parameter | Property) & {
type: { optional: true };
};
function isOptionalWithouDefault(

function isOptional(
param: Parameter | Property
): param is OptionalWithoutDefaultType {
return Boolean(param.optional && !param.clientDefaultValue);
): param is OptionalType {
return Boolean(param.optional);
}
function getOptionalWithoutDefault(
param: OptionalWithoutDefaultType,

function getOptional(
param: OptionalType,
importSet: Map<string, Set<string>>
) {
if (param.type.type === "model") {
Expand All @@ -498,39 +497,6 @@ function getOptionalWithoutDefault(
return `"${param.restApiName}": options?.${param.clientName}`;
}

type OptionalWithDefaultType = (Parameter | Property) & {
type: { optional: true; clientDefaultValue: string };
};
function isOptionalWithDefault(
param: Parameter | Property
): param is OptionalWithDefaultType {
return Boolean(param.clientDefaultValue);
}

function getOptionalWithDefault(
param: OptionalWithDefaultType,
importSet: Map<string, Set<string>>
) {
if (param.type.type === "model") {
return `"${param.restApiName}": {${getRequestModelMapping(
param.type,
"options?." + param.clientName,
importSet
).join(", ")}} ?? ${getQuotedValue(param)}`;
}
return `"${param.restApiName}": options.${
param.clientName
} ?? ${getQuotedValue(param)}`;
Comment on lines -521 to -523
Copy link
Member Author

Choose a reason for hiding this comment

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

the question mark change is because of we now using getOptional which used to be getOptionalWithoutDefault and for OpenAI's case, they have a default value, they previously go into getOptionalWithDefault function.

Copy link
Member Author

Choose a reason for hiding this comment

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

Compared with all the places that is using options to build the request body, this is the only places that doesn't have a question mark.

As options by literal means this parameter is optional, we should keep options?. no matter if it has a default value or not. Besides, even if it does have a default value. options?. won't report any errors.

}

function getQuotedValue(param: OptionalWithDefaultType) {
if (param.type.type === "string") {
return `"${param.clientDefaultValue}"`;
} else {
return param.clientDefaultValue;
}
}

/**
* Builds the assignment for when a property or parameter has a default value
*/
Expand Down
Loading