feat(js): avoid wrapping bodyParams
#77
Conversation
shortcuts
requested review from
a team and
damcou
and removed request for
a team
shortcuts
force-pushed
the
feat/APIC-254/unwrap-bodyparams
branch
from
6e3061a to
5c256e5
Compare
| @@ -3002,7 +2949,7 @@ export type SearchRulesProps = { | |||
| */ | |||
| indexName: string; | |||
| /** | |||
| * The searchRulesParams. | |||
| * The searchRulesParams parameter. | |||
There was a problem hiding this comment.
Are all those comments really needed ? They juste repeat the name of the param, it's juste noise.
There was a problem hiding this comment.
It's only when no definitions are provided in the specs, it's either that on remove the ESLint rules that requires a description and/or the one that requires a @param
There was a problem hiding this comment.
actually if we keep it, it should be object not parameter
There was a problem hiding this comment.
Personally I would remove the rule
There was a problem hiding this comment.
Let's go for no description required then, we need to make sure we don't forget to provide it in the specs.
There was a problem hiding this comment.
I've removed the description for the parameter, it feels weird and I'd rather at least see it's an object
There was a problem hiding this comment.
I'm ok with the comment after @param, but the ones in the Props is totally superfluous
There was a problem hiding this comment.
You mean in the type def? Definitely
There was a problem hiding this comment.
seems better here 920dc83
shortcuts
force-pushed
the
feat/APIC-254/unwrap-bodyparams
branch
from
7d3753a to
daf57d7
Compare
shortcuts
force-pushed
the
feat/APIC-254/unwrap-bodyparams
branch
from
daf57d7 to
920dc83
Compare
| export type OperationIndexProps = { | ||
| /** | ||
| * The index in which to perform the request. | ||
| */ | ||
| indexName: string; | ||
| /** | ||
| * The operationIndexObject. | ||
| */ | ||
| operationIndexObject: OperationIndexObject; | ||
| }; | ||
|
|
There was a problem hiding this comment.
I don't know where it's coming from but line 2787 the description is wrong for buildInOperations
There was a problem hiding this comment.
Good catch, should be fixed in 8f891f6
There was a problem hiding this comment.
I guess I misread the comment and the type, It's all good now
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-254
Changes included:
Avoid wrapping parameters in an object when only
bodyParamsare required.🧪 Test
CI :D