-
-
Notifications
You must be signed in to change notification settings - Fork 7.1k
Add create requestOpts method to {{classname}}Interface #21708 #21709
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
base: master
Are you sure you want to change the base?
Add create requestOpts method to {{classname}}Interface #21708 #21709
Conversation
* @throws {RequiredError} | ||
* @memberof {{classname}}Interface | ||
*/ | ||
{{nickname}}RequestConfig({{#allParams.0}}requestParameters: {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}Request, {{/allParams.0}}initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.RequestOpts>; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The interface in Runtime.ts
is RequestOpts
. It might be better to refer to this as {{nickname}}RequestOpts
instead of {{nickname}}RequestConfig
& creates request options
as otherwise the name of the method may be misleading.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In some libraries it's called request config, such as axios. But it indeed makes more sense to have opts/options here.
@@ -302,7 +311,7 @@ export class {{classname}} extends runtime.BaseAPI { | |||
{{/isDateTimeType}} | |||
{{/pathParams}} | |||
|
|||
const response = await this.request({ | |||
const requestOpts: runtime.RequestOpts = { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should be able to return the object directly without having a intermediate variable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you're right. writing code in mustache is hard
fix #21708 |
This PR splits some logic, instead of creating/building the request inline and sending it instantly we now use a function to do this. Functionally there should be no changes.
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*
.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master
(upcoming7.x.0
minor release - breaking changes with fallbacks),8.0.x
(breaking changes without fallbacks)"fixes #123"
present in the PR description)