[TS][Angular] Avoid strictNullChecks errors for apiKeys #1611
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- ./bin/typescript-angular-petstore-all.sh - ./bin/typescript-inversify-petstore.sh
- ./bin/security/typescript-angular.sh - ./bin/security/typescript-angular2.sh - ./bin/security/typescript-inversify.sh
macjohnny
approved these changes
Dec 4, 2018
| public testCodeInjectEndRnNR(testCodeInjectEndRnNR?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<any>>; | ||
| public testCodeInjectEndRnNR(testCodeInjectEndRnNR?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<any>>; | ||
| public testCodeInjectEndRnNR(testCodeInjectEndRnNR?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> { | ||
| public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe?: 'body', reportProgress?: boolean): Observable<any>; |
There was a problem hiding this comment.
any idea why UNKNOWN_BASE_TYPE occurs here?
There was a problem hiding this comment.
./bin/security/typescript-angular.sh had warned:
[main] WARN o.o.codegen.DefaultCodegen - The following schema has undefined (null) baseType. It could be due to form parameter defined in OpenAPI v2 spec with incorrect consumes. A correct 'consumes' for form parameters should be 'application/x-www-form-urlencoded' or 'mul
tipart/form-data'
And I changed modules/openapi-generator/src/test/resources/2_0/petstore-security-test.yaml:
consumes:
- - application/json
- - "*/ ' \" =end -- \r\n \n \r"
+ - application/x-www-form-urlencodedBut invalid identifier was generated:
- public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe?: 'body', reportProgress?: boolean): Observable<any>;
- public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<any>>;
- public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<any>>;
- public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ public testCodeInjectEndRnNR(testCodeInject*#39;"=endRnNR?: string, observe?: 'body', reportProgress?: boolean): Observable<any>;
+ public testCodeInjectEndRnNR(testCodeInject*'"=endRnNR?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<any>>;
+ public testCodeInjectEndRnNR(testCodeInject*'"=endRnNR?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<any>>;
+ public testCodeInjectEndRnNR(testCodeInject*'"=endRnNR?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {There was a problem hiding this comment.
I think AbstractTypeScriptClientCodegen#toParamName is broken:
- name = sanitizeName(name, "\\W-[\\$]");
+ name = sanitizeName(name, "[^\\w$]");There was a problem hiding this comment.
@grktsh can you include this fix, too?
There was a problem hiding this comment.
@macjohnny Done. Could you review again?
There was a problem hiding this comment.
"*/ ' \" =end -- \r\n \n \r" is for detecting code injection (malicious input in consumes). I'll add it back with a separate PR.
grktsh
force-pushed
the
null-check-api-keys
branch
from
50dc4f2
to
28b06ff
Compare
macjohnny
approved these changes
Dec 5, 2018
|
@grktsh @macjohnny Do we need the similar fix for other TS generators? (this is not to say either one of you will need to submit the fix or own the issue. Just want to know if other TS generators have a similar bug) |
wing328
changed the title
|
@grktsh thanks for the contribution, which has been included in the 4.0.0-beta release: https://twitter.com/oas_generator/status/1079727020374806529. Happy New Year and looking forward to more collaboration and contributions in 2019! |
A-Joshi
pushed a commit
to ihsmarkitoss/openapi-generator
that referenced
this pull request
Feb 27, 2019
…#1611) * [typescript] Avoid strictNullChecks errors for apiKeys fix OpenAPITools#1607 * Run ./bin/{LANG}-petstore.sh - ./bin/typescript-angular-petstore-all.sh - ./bin/typescript-inversify-petstore.sh * Run ./bin/security/{LANG}-petstore.sh - ./bin/security/typescript-angular.sh - ./bin/security/typescript-angular2.sh - ./bin/security/typescript-inversify.sh * [typescript] Fix parameter name sanitization * Fix invalid consumes of petstore-security-test.yaml * Run ./bin/security/typescript-*.sh
This was referenced Jul 31, 2022
This was referenced Jul 31, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fix #1607
PR checklist
./bin/to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.shand./bin/security/{LANG}-petstore.shif updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\.master,. Default:3.4.x,4.0.xmaster.Description of the PR
I'd like to add
this.configuration.apiKeys &&to the following conditions to avoid strictNullChecks errors for apiKeys:from typescript-angular/api.service.mustache@master
from typescript-inversify/api.service.mustache@master
@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @nicokoenig (2018/09) @topce (2018/10)