[typescript-fetch] Fix discriminator mapping name - #4340

Merged
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name
Nov 1, 2019
Merged

[typescript-fetch] Fix discriminator mapping name#4340
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name

Conversation

@eriktim

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

The typescript-fetch generator incorrectly using the modelName as the identifier for tagged unions (discriminators). This PR patches that by using the mappingName instead, as this may have been set to an arbitrary value.

cc @TiFu@taxpon@sebastianhaas@kenisteward@Vrolijkx@macjohnny@nicokoenig@topce@akehir

@auto-labeler

Copy link
Copy Markdown

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@eriktimeriktim added this to the 4.2.1 milestone Oct 31, 2019
@macjohnny

Copy link
Copy Markdown
Member

thanks for the PR. is mappingName always set? what is its value?

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@macjohnny Yes, in the discriminator.mappedModels it is always set. There are some other edge cases with discriminators that do not seem to work at the moment. I'll create new PRs once/if I run into them.

This fix is for the "Mapping Type Names" in https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

@Bessonov

Copy link
Copy Markdown

@eriktim I'm not sure that it's related, but I still get generated converters, which doesn't exists in models. Reproduction:
https://github.com/Bessonov/openapi-bug

git clone https://github.com/Bessonov/openapi-bug
cd openapi-bug
./test.sh

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Ahh I actually do not use oneOf in my spec file. My patch is only for the case where you don't.

But the union type that's being created in your case is great. It seems to lack proper ToJSON/FromJSON functions though. I'm gonna see if I can create another PR for that.

@eriktim
eriktim deleted the fix-typescript-discriminator-mapping-name branch November 3, 2019 07:12
@Bessonov

Copy link
Copy Markdown

@eriktim Thank you for your response! I've experimenting a little bit and come out with following content of modelOneOf.mustache:

{{#hasImports}}import{{{#imports}}{{{.}}},{{/imports}}}from'./';{{/hasImports}}{{#discriminator}}import{{{#discriminator.mappedModels}}{{modelName}}ToJSON,{{modelName}}FromJSONTyped,{{/discriminator.mappedModels}}}from'./';{{/discriminator}}/** * @type {{classname}}{{#description}} * {{{description}}}{{/description}} * @export */exporttype{{classname}}={{#oneOf}}{{{.}}}{{^-last}}|{{/-last}}{{/oneOf}};exportfunction{{classname}}FromJSON(json: any): {{classname}}{return{{classname}}FromJSONTyped(json, false);}exportfunction{{classname}}FromJSONTyped(json: any,ignoreDiscriminator: boolean): {{classname}}{{{#discriminator}}if(!ignoreDiscriminator){{{#discriminator.mappedModels}}if(json['{{discriminator.propertyName}}']==='{{mappingName}}'){return{{modelName}}FromJSONTyped(json, true);}{{/discriminator.mappedModels}}}{{/discriminator}}thrownewError('unknown discriminator');}exportfunction{{classname}}ToJSON(value?: {{classname}}|null): any {if(value ===undefined){returnundefined;}if(value ===null){
return null;}{{#discriminator}}{{#discriminator.mappedModels}}if(value.{{discriminator.propertyName}}==='{{mappingName}}'){return{{modelName}}ToJSON(value);}{{/discriminator.mappedModels}}{{/discriminator}}thrownewError('unknown discriminator');}

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Haha nice, I've come up something similar! Wanted to do a final check tomorrow.

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov if you want you can already make a PR. I'll probably add some small comments tomorrow. Otherwise I'll create one tomorrow.

@Bessonov

Copy link
Copy Markdown

@eriktim do that in most convenient way for you, I'm not blocked anymore 👍

jimschubert added a commit that referenced this pull request Nov 3, 2019
* 'master' of github.com:OpenAPITools/openapi-generator: (88 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit that referenced this pull request Nov 3, 2019
* master: (142 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Nov 3, 2019
* master: (141 commits)
smaller tests, better code format (OpenAPITools#4355)
csharp-netcore: Replace null literals with default (OpenAPITools#4345)
[core] consider polymorphism when computing unused schemas (OpenAPITools#4335)
Fix issue 4326 forward throws for delegate to main method (OpenAPITools#4327)
[kotlin][client] annotate api exceptions (OpenAPITools#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (OpenAPITools#4353)
Remove deprecated API use of ObjectFactory.property() (OpenAPITools#2613) (OpenAPITools#4352)
[python][metadata]: Adding license and author fields (OpenAPITools#4318)
[Python] Avoid pep8 violation (OpenAPITools#4316)
[JS] Update package.json (OpenAPITools#4261)
Add slash-arun to Python technical committee (OpenAPITools#4354)
[typescript-fetch] Fix discriminator mapping name (OpenAPITools#4340)
fix security alerts reported by github (OpenAPITools#4344)
fix cpp-restbed-server json field serialization OpenAPITools#4320 (OpenAPITools#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (OpenAPITools#4341)
fix(typescript-angular): do not call .toISOString() on a string (OpenAPITools#4330) (OpenAPITools#4337)
update samples (OpenAPITools#4334)
Prepare 4.2.0 release (OpenAPITools#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (OpenAPITools#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (OpenAPITools#4056)
...
@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov see #4387

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@eriktim@macjohnny@Bessonov
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

[typescript-fetch] Fix discriminator mapping name - #4340

Merged
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name
Nov 1, 2019
Merged

[typescript-fetch] Fix discriminator mapping name#4340
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name

Conversation

@eriktim

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

The typescript-fetch generator incorrectly using the modelName as the identifier for tagged unions (discriminators). This PR patches that by using the mappingName instead, as this may have been set to an arbitrary value.

cc @TiFu@taxpon@sebastianhaas@kenisteward@Vrolijkx@macjohnny@nicokoenig@topce@akehir

@auto-labeler

Copy link
Copy Markdown

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@eriktimeriktim added this to the 4.2.1 milestone Oct 31, 2019
@macjohnny

Copy link
Copy Markdown
Member

thanks for the PR. is mappingName always set? what is its value?

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@macjohnny Yes, in the discriminator.mappedModels it is always set. There are some other edge cases with discriminators that do not seem to work at the moment. I'll create new PRs once/if I run into them.

This fix is for the "Mapping Type Names" in https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

@Bessonov

Copy link
Copy Markdown

@eriktim I'm not sure that it's related, but I still get generated converters, which doesn't exists in models. Reproduction:
https://github.com/Bessonov/openapi-bug

git clone https://github.com/Bessonov/openapi-bug
cd openapi-bug
./test.sh

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Ahh I actually do not use oneOf in my spec file. My patch is only for the case where you don't.

But the union type that's being created in your case is great. It seems to lack proper ToJSON/FromJSON functions though. I'm gonna see if I can create another PR for that.

@eriktim
eriktim deleted the fix-typescript-discriminator-mapping-name branch November 3, 2019 07:12
@Bessonov

Copy link
Copy Markdown

@eriktim Thank you for your response! I've experimenting a little bit and come out with following content of modelOneOf.mustache:

{{#hasImports}}import{{{#imports}}{{{.}}},{{/imports}}}from'./';{{/hasImports}}{{#discriminator}}import{{{#discriminator.mappedModels}}{{modelName}}ToJSON,{{modelName}}FromJSONTyped,{{/discriminator.mappedModels}}}from'./';{{/discriminator}}/** * @type {{classname}}{{#description}} * {{{description}}}{{/description}} * @export */exporttype{{classname}}={{#oneOf}}{{{.}}}{{^-last}}|{{/-last}}{{/oneOf}};exportfunction{{classname}}FromJSON(json: any): {{classname}}{return{{classname}}FromJSONTyped(json, false);}exportfunction{{classname}}FromJSONTyped(json: any,ignoreDiscriminator: boolean): {{classname}}{{{#discriminator}}if(!ignoreDiscriminator){{{#discriminator.mappedModels}}if(json['{{discriminator.propertyName}}']==='{{mappingName}}'){return{{modelName}}FromJSONTyped(json, true);}{{/discriminator.mappedModels}}}{{/discriminator}}thrownewError('unknown discriminator');}exportfunction{{classname}}ToJSON(value?: {{classname}}|null): any {if(value ===undefined){returnundefined;}if(value ===null){
return null;}{{#discriminator}}{{#discriminator.mappedModels}}if(value.{{discriminator.propertyName}}==='{{mappingName}}'){return{{modelName}}ToJSON(value);}{{/discriminator.mappedModels}}{{/discriminator}}thrownewError('unknown discriminator');}

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Haha nice, I've come up something similar! Wanted to do a final check tomorrow.

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov if you want you can already make a PR. I'll probably add some small comments tomorrow. Otherwise I'll create one tomorrow.

@Bessonov

Copy link
Copy Markdown

@eriktim do that in most convenient way for you, I'm not blocked anymore 👍

jimschubert added a commit that referenced this pull request Nov 3, 2019
* 'master' of github.com:OpenAPITools/openapi-generator: (88 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit that referenced this pull request Nov 3, 2019
* master: (142 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Nov 3, 2019
* master: (141 commits)
smaller tests, better code format (OpenAPITools#4355)
csharp-netcore: Replace null literals with default (OpenAPITools#4345)
[core] consider polymorphism when computing unused schemas (OpenAPITools#4335)
Fix issue 4326 forward throws for delegate to main method (OpenAPITools#4327)
[kotlin][client] annotate api exceptions (OpenAPITools#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (OpenAPITools#4353)
Remove deprecated API use of ObjectFactory.property() (OpenAPITools#2613) (OpenAPITools#4352)
[python][metadata]: Adding license and author fields (OpenAPITools#4318)
[Python] Avoid pep8 violation (OpenAPITools#4316)
[JS] Update package.json (OpenAPITools#4261)
Add slash-arun to Python technical committee (OpenAPITools#4354)
[typescript-fetch] Fix discriminator mapping name (OpenAPITools#4340)
fix security alerts reported by github (OpenAPITools#4344)
fix cpp-restbed-server json field serialization OpenAPITools#4320 (OpenAPITools#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (OpenAPITools#4341)
fix(typescript-angular): do not call .toISOString() on a string (OpenAPITools#4330) (OpenAPITools#4337)
update samples (OpenAPITools#4334)
Prepare 4.2.0 release (OpenAPITools#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (OpenAPITools#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (OpenAPITools#4056)
...
@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov see #4387

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@eriktim@macjohnny@Bessonov
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[typescript-fetch] Fix discriminator mapping name - #4340

Merged
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name
Nov 1, 2019
Merged

[typescript-fetch] Fix discriminator mapping name#4340
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name

Conversation

@eriktim

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

The typescript-fetch generator incorrectly using the modelName as the identifier for tagged unions (discriminators). This PR patches that by using the mappingName instead, as this may have been set to an arbitrary value.

cc @TiFu@taxpon@sebastianhaas@kenisteward@Vrolijkx@macjohnny@nicokoenig@topce@akehir

@auto-labeler

Copy link
Copy Markdown

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@eriktimeriktim added this to the 4.2.1 milestone Oct 31, 2019
@macjohnny

Copy link
Copy Markdown
Member

thanks for the PR. is mappingName always set? what is its value?

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@macjohnny Yes, in the discriminator.mappedModels it is always set. There are some other edge cases with discriminators that do not seem to work at the moment. I'll create new PRs once/if I run into them.

This fix is for the "Mapping Type Names" in https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

@Bessonov

Copy link
Copy Markdown

@eriktim I'm not sure that it's related, but I still get generated converters, which doesn't exists in models. Reproduction:
https://github.com/Bessonov/openapi-bug

git clone https://github.com/Bessonov/openapi-bug
cd openapi-bug
./test.sh

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Ahh I actually do not use oneOf in my spec file. My patch is only for the case where you don't.

But the union type that's being created in your case is great. It seems to lack proper ToJSON/FromJSON functions though. I'm gonna see if I can create another PR for that.

@eriktim
eriktim deleted the fix-typescript-discriminator-mapping-name branch November 3, 2019 07:12
@Bessonov

Copy link
Copy Markdown

@eriktim Thank you for your response! I've experimenting a little bit and come out with following content of modelOneOf.mustache:

{{#hasImports}}import{{{#imports}}{{{.}}},{{/imports}}}from'./';{{/hasImports}}{{#discriminator}}import{{{#discriminator.mappedModels}}{{modelName}}ToJSON,{{modelName}}FromJSONTyped,{{/discriminator.mappedModels}}}from'./';{{/discriminator}}/** * @type {{classname}}{{#description}} * {{{description}}}{{/description}} * @export */exporttype{{classname}}={{#oneOf}}{{{.}}}{{^-last}}|{{/-last}}{{/oneOf}};exportfunction{{classname}}FromJSON(json: any): {{classname}}{return{{classname}}FromJSONTyped(json, false);}exportfunction{{classname}}FromJSONTyped(json: any,ignoreDiscriminator: boolean): {{classname}}{{{#discriminator}}if(!ignoreDiscriminator){{{#discriminator.mappedModels}}if(json['{{discriminator.propertyName}}']==='{{mappingName}}'){return{{modelName}}FromJSONTyped(json, true);}{{/discriminator.mappedModels}}}{{/discriminator}}thrownewError('unknown discriminator');}exportfunction{{classname}}ToJSON(value?: {{classname}}|null): any {if(value ===undefined){returnundefined;}if(value ===null){
return null;}{{#discriminator}}{{#discriminator.mappedModels}}if(value.{{discriminator.propertyName}}==='{{mappingName}}'){return{{modelName}}ToJSON(value);}{{/discriminator.mappedModels}}{{/discriminator}}thrownewError('unknown discriminator');}

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Haha nice, I've come up something similar! Wanted to do a final check tomorrow.

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov if you want you can already make a PR. I'll probably add some small comments tomorrow. Otherwise I'll create one tomorrow.

@Bessonov

Copy link
Copy Markdown

@eriktim do that in most convenient way for you, I'm not blocked anymore 👍

jimschubert added a commit that referenced this pull request Nov 3, 2019
* 'master' of github.com:OpenAPITools/openapi-generator: (88 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit that referenced this pull request Nov 3, 2019
* master: (142 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Nov 3, 2019
* master: (141 commits)
smaller tests, better code format (OpenAPITools#4355)
csharp-netcore: Replace null literals with default (OpenAPITools#4345)
[core] consider polymorphism when computing unused schemas (OpenAPITools#4335)
Fix issue 4326 forward throws for delegate to main method (OpenAPITools#4327)
[kotlin][client] annotate api exceptions (OpenAPITools#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (OpenAPITools#4353)
Remove deprecated API use of ObjectFactory.property() (OpenAPITools#2613) (OpenAPITools#4352)
[python][metadata]: Adding license and author fields (OpenAPITools#4318)
[Python] Avoid pep8 violation (OpenAPITools#4316)
[JS] Update package.json (OpenAPITools#4261)
Add slash-arun to Python technical committee (OpenAPITools#4354)
[typescript-fetch] Fix discriminator mapping name (OpenAPITools#4340)
fix security alerts reported by github (OpenAPITools#4344)
fix cpp-restbed-server json field serialization OpenAPITools#4320 (OpenAPITools#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (OpenAPITools#4341)
fix(typescript-angular): do not call .toISOString() on a string (OpenAPITools#4330) (OpenAPITools#4337)
update samples (OpenAPITools#4334)
Prepare 4.2.0 release (OpenAPITools#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (OpenAPITools#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (OpenAPITools#4056)
...
@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov see #4387

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@eriktim@macjohnny@Bessonov
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[typescript-fetch] Fix discriminator mapping name - #4340

Merged
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name
Nov 1, 2019
Merged

[typescript-fetch] Fix discriminator mapping name#4340
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name

Conversation

@eriktim

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

The typescript-fetch generator incorrectly using the modelName as the identifier for tagged unions (discriminators). This PR patches that by using the mappingName instead, as this may have been set to an arbitrary value.

cc @TiFu@taxpon@sebastianhaas@kenisteward@Vrolijkx@macjohnny@nicokoenig@topce@akehir

@auto-labeler

Copy link
Copy Markdown

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@eriktimeriktim added this to the 4.2.1 milestone Oct 31, 2019
@macjohnny

Copy link
Copy Markdown
Member

thanks for the PR. is mappingName always set? what is its value?

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@macjohnny Yes, in the discriminator.mappedModels it is always set. There are some other edge cases with discriminators that do not seem to work at the moment. I'll create new PRs once/if I run into them.

This fix is for the "Mapping Type Names" in https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

@Bessonov

Copy link
Copy Markdown

@eriktim I'm not sure that it's related, but I still get generated converters, which doesn't exists in models. Reproduction:
https://github.com/Bessonov/openapi-bug

git clone https://github.com/Bessonov/openapi-bug
cd openapi-bug
./test.sh

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Ahh I actually do not use oneOf in my spec file. My patch is only for the case where you don't.

But the union type that's being created in your case is great. It seems to lack proper ToJSON/FromJSON functions though. I'm gonna see if I can create another PR for that.

@eriktim
eriktim deleted the fix-typescript-discriminator-mapping-name branch November 3, 2019 07:12
@Bessonov

Copy link
Copy Markdown

@eriktim Thank you for your response! I've experimenting a little bit and come out with following content of modelOneOf.mustache:

{{#hasImports}}import{{{#imports}}{{{.}}},{{/imports}}}from'./';{{/hasImports}}{{#discriminator}}import{{{#discriminator.mappedModels}}{{modelName}}ToJSON,{{modelName}}FromJSONTyped,{{/discriminator.mappedModels}}}from'./';{{/discriminator}}/** * @type {{classname}}{{#description}} * {{{description}}}{{/description}} * @export */exporttype{{classname}}={{#oneOf}}{{{.}}}{{^-last}}|{{/-last}}{{/oneOf}};exportfunction{{classname}}FromJSON(json: any): {{classname}}{return{{classname}}FromJSONTyped(json, false);}exportfunction{{classname}}FromJSONTyped(json: any,ignoreDiscriminator: boolean): {{classname}}{{{#discriminator}}if(!ignoreDiscriminator){{{#discriminator.mappedModels}}if(json['{{discriminator.propertyName}}']==='{{mappingName}}'){return{{modelName}}FromJSONTyped(json, true);}{{/discriminator.mappedModels}}}{{/discriminator}}thrownewError('unknown discriminator');}exportfunction{{classname}}ToJSON(value?: {{classname}}|null): any {if(value ===undefined){returnundefined;}if(value ===null){
return null;}{{#discriminator}}{{#discriminator.mappedModels}}if(value.{{discriminator.propertyName}}==='{{mappingName}}'){return{{modelName}}ToJSON(value);}{{/discriminator.mappedModels}}{{/discriminator}}thrownewError('unknown discriminator');}

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Haha nice, I've come up something similar! Wanted to do a final check tomorrow.

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov if you want you can already make a PR. I'll probably add some small comments tomorrow. Otherwise I'll create one tomorrow.

@Bessonov

Copy link
Copy Markdown

@eriktim do that in most convenient way for you, I'm not blocked anymore 👍

jimschubert added a commit that referenced this pull request Nov 3, 2019
* 'master' of github.com:OpenAPITools/openapi-generator: (88 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit that referenced this pull request Nov 3, 2019
* master: (142 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Nov 3, 2019
* master: (141 commits)
smaller tests, better code format (OpenAPITools#4355)
csharp-netcore: Replace null literals with default (OpenAPITools#4345)
[core] consider polymorphism when computing unused schemas (OpenAPITools#4335)
Fix issue 4326 forward throws for delegate to main method (OpenAPITools#4327)
[kotlin][client] annotate api exceptions (OpenAPITools#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (OpenAPITools#4353)
Remove deprecated API use of ObjectFactory.property() (OpenAPITools#2613) (OpenAPITools#4352)
[python][metadata]: Adding license and author fields (OpenAPITools#4318)
[Python] Avoid pep8 violation (OpenAPITools#4316)
[JS] Update package.json (OpenAPITools#4261)
Add slash-arun to Python technical committee (OpenAPITools#4354)
[typescript-fetch] Fix discriminator mapping name (OpenAPITools#4340)
fix security alerts reported by github (OpenAPITools#4344)
fix cpp-restbed-server json field serialization OpenAPITools#4320 (OpenAPITools#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (OpenAPITools#4341)
fix(typescript-angular): do not call .toISOString() on a string (OpenAPITools#4330) (OpenAPITools#4337)
update samples (OpenAPITools#4334)
Prepare 4.2.0 release (OpenAPITools#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (OpenAPITools#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (OpenAPITools#4056)
...
@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov see #4387

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@eriktim@macjohnny@Bessonov
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

[typescript-fetch] Fix discriminator mapping name - #4340

Merged
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name
Nov 1, 2019
Merged

[typescript-fetch] Fix discriminator mapping name#4340
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name

Conversation

@eriktim

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

The typescript-fetch generator incorrectly using the modelName as the identifier for tagged unions (discriminators). This PR patches that by using the mappingName instead, as this may have been set to an arbitrary value.

cc @TiFu@taxpon@sebastianhaas@kenisteward@Vrolijkx@macjohnny@nicokoenig@topce@akehir

@auto-labeler

Copy link
Copy Markdown

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@eriktimeriktim added this to the 4.2.1 milestone Oct 31, 2019
@macjohnny

Copy link
Copy Markdown
Member

thanks for the PR. is mappingName always set? what is its value?

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@macjohnny Yes, in the discriminator.mappedModels it is always set. There are some other edge cases with discriminators that do not seem to work at the moment. I'll create new PRs once/if I run into them.

This fix is for the "Mapping Type Names" in https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

@Bessonov

Copy link
Copy Markdown

@eriktim I'm not sure that it's related, but I still get generated converters, which doesn't exists in models. Reproduction:
https://github.com/Bessonov/openapi-bug

git clone https://github.com/Bessonov/openapi-bug
cd openapi-bug
./test.sh

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Ahh I actually do not use oneOf in my spec file. My patch is only for the case where you don't.

But the union type that's being created in your case is great. It seems to lack proper ToJSON/FromJSON functions though. I'm gonna see if I can create another PR for that.

@eriktim
eriktim deleted the fix-typescript-discriminator-mapping-name branch November 3, 2019 07:12
@Bessonov

Copy link
Copy Markdown

@eriktim Thank you for your response! I've experimenting a little bit and come out with following content of modelOneOf.mustache:

{{#hasImports}}import{{{#imports}}{{{.}}},{{/imports}}}from'./';{{/hasImports}}{{#discriminator}}import{{{#discriminator.mappedModels}}{{modelName}}ToJSON,{{modelName}}FromJSONTyped,{{/discriminator.mappedModels}}}from'./';{{/discriminator}}/** * @type {{classname}}{{#description}} * {{{description}}}{{/description}} * @export */exporttype{{classname}}={{#oneOf}}{{{.}}}{{^-last}}|{{/-last}}{{/oneOf}};exportfunction{{classname}}FromJSON(json: any): {{classname}}{return{{classname}}FromJSONTyped(json, false);}exportfunction{{classname}}FromJSONTyped(json: any,ignoreDiscriminator: boolean): {{classname}}{{{#discriminator}}if(!ignoreDiscriminator){{{#discriminator.mappedModels}}if(json['{{discriminator.propertyName}}']==='{{mappingName}}'){return{{modelName}}FromJSONTyped(json, true);}{{/discriminator.mappedModels}}}{{/discriminator}}thrownewError('unknown discriminator');}exportfunction{{classname}}ToJSON(value?: {{classname}}|null): any {if(value ===undefined){returnundefined;}if(value ===null){
return null;}{{#discriminator}}{{#discriminator.mappedModels}}if(value.{{discriminator.propertyName}}==='{{mappingName}}'){return{{modelName}}ToJSON(value);}{{/discriminator.mappedModels}}{{/discriminator}}thrownewError('unknown discriminator');}

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Haha nice, I've come up something similar! Wanted to do a final check tomorrow.

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov if you want you can already make a PR. I'll probably add some small comments tomorrow. Otherwise I'll create one tomorrow.

@Bessonov

Copy link
Copy Markdown

@eriktim do that in most convenient way for you, I'm not blocked anymore 👍

jimschubert added a commit that referenced this pull request Nov 3, 2019
* 'master' of github.com:OpenAPITools/openapi-generator: (88 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit that referenced this pull request Nov 3, 2019
* master: (142 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Nov 3, 2019
* master: (141 commits)
smaller tests, better code format (OpenAPITools#4355)
csharp-netcore: Replace null literals with default (OpenAPITools#4345)
[core] consider polymorphism when computing unused schemas (OpenAPITools#4335)
Fix issue 4326 forward throws for delegate to main method (OpenAPITools#4327)
[kotlin][client] annotate api exceptions (OpenAPITools#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (OpenAPITools#4353)
Remove deprecated API use of ObjectFactory.property() (OpenAPITools#2613) (OpenAPITools#4352)
[python][metadata]: Adding license and author fields (OpenAPITools#4318)
[Python] Avoid pep8 violation (OpenAPITools#4316)
[JS] Update package.json (OpenAPITools#4261)
Add slash-arun to Python technical committee (OpenAPITools#4354)
[typescript-fetch] Fix discriminator mapping name (OpenAPITools#4340)
fix security alerts reported by github (OpenAPITools#4344)
fix cpp-restbed-server json field serialization OpenAPITools#4320 (OpenAPITools#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (OpenAPITools#4341)
fix(typescript-angular): do not call .toISOString() on a string (OpenAPITools#4330) (OpenAPITools#4337)
update samples (OpenAPITools#4334)
Prepare 4.2.0 release (OpenAPITools#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (OpenAPITools#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (OpenAPITools#4056)
...
@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov see #4387

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@eriktim@macjohnny@Bessonov
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[typescript-fetch] Fix discriminator mapping name - #4340

Merged
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name
Nov 1, 2019
Merged

[typescript-fetch] Fix discriminator mapping name#4340
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name

Conversation

@eriktim

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

The typescript-fetch generator incorrectly using the modelName as the identifier for tagged unions (discriminators). This PR patches that by using the mappingName instead, as this may have been set to an arbitrary value.

cc @TiFu@taxpon@sebastianhaas@kenisteward@Vrolijkx@macjohnny@nicokoenig@topce@akehir

@auto-labeler

Copy link
Copy Markdown

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@eriktimeriktim added this to the 4.2.1 milestone Oct 31, 2019
@macjohnny

Copy link
Copy Markdown
Member

thanks for the PR. is mappingName always set? what is its value?

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@macjohnny Yes, in the discriminator.mappedModels it is always set. There are some other edge cases with discriminators that do not seem to work at the moment. I'll create new PRs once/if I run into them.

This fix is for the "Mapping Type Names" in https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

@Bessonov

Copy link
Copy Markdown

@eriktim I'm not sure that it's related, but I still get generated converters, which doesn't exists in models. Reproduction:
https://github.com/Bessonov/openapi-bug

git clone https://github.com/Bessonov/openapi-bug
cd openapi-bug
./test.sh

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Ahh I actually do not use oneOf in my spec file. My patch is only for the case where you don't.

But the union type that's being created in your case is great. It seems to lack proper ToJSON/FromJSON functions though. I'm gonna see if I can create another PR for that.

@eriktim
eriktim deleted the fix-typescript-discriminator-mapping-name branch November 3, 2019 07:12
@Bessonov

Copy link
Copy Markdown

@eriktim Thank you for your response! I've experimenting a little bit and come out with following content of modelOneOf.mustache:

{{#hasImports}}import{{{#imports}}{{{.}}},{{/imports}}}from'./';{{/hasImports}}{{#discriminator}}import{{{#discriminator.mappedModels}}{{modelName}}ToJSON,{{modelName}}FromJSONTyped,{{/discriminator.mappedModels}}}from'./';{{/discriminator}}/** * @type {{classname}}{{#description}} * {{{description}}}{{/description}} * @export */exporttype{{classname}}={{#oneOf}}{{{.}}}{{^-last}}|{{/-last}}{{/oneOf}};exportfunction{{classname}}FromJSON(json: any): {{classname}}{return{{classname}}FromJSONTyped(json, false);}exportfunction{{classname}}FromJSONTyped(json: any,ignoreDiscriminator: boolean): {{classname}}{{{#discriminator}}if(!ignoreDiscriminator){{{#discriminator.mappedModels}}if(json['{{discriminator.propertyName}}']==='{{mappingName}}'){return{{modelName}}FromJSONTyped(json, true);}{{/discriminator.mappedModels}}}{{/discriminator}}thrownewError('unknown discriminator');}exportfunction{{classname}}ToJSON(value?: {{classname}}|null): any {if(value ===undefined){returnundefined;}if(value ===null){
return null;}{{#discriminator}}{{#discriminator.mappedModels}}if(value.{{discriminator.propertyName}}==='{{mappingName}}'){return{{modelName}}ToJSON(value);}{{/discriminator.mappedModels}}{{/discriminator}}thrownewError('unknown discriminator');}

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Haha nice, I've come up something similar! Wanted to do a final check tomorrow.

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov if you want you can already make a PR. I'll probably add some small comments tomorrow. Otherwise I'll create one tomorrow.

@Bessonov

Copy link
Copy Markdown

@eriktim do that in most convenient way for you, I'm not blocked anymore 👍

jimschubert added a commit that referenced this pull request Nov 3, 2019
* 'master' of github.com:OpenAPITools/openapi-generator: (88 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit that referenced this pull request Nov 3, 2019
* master: (142 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Nov 3, 2019
* master: (141 commits)
smaller tests, better code format (OpenAPITools#4355)
csharp-netcore: Replace null literals with default (OpenAPITools#4345)
[core] consider polymorphism when computing unused schemas (OpenAPITools#4335)
Fix issue 4326 forward throws for delegate to main method (OpenAPITools#4327)
[kotlin][client] annotate api exceptions (OpenAPITools#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (OpenAPITools#4353)
Remove deprecated API use of ObjectFactory.property() (OpenAPITools#2613) (OpenAPITools#4352)
[python][metadata]: Adding license and author fields (OpenAPITools#4318)
[Python] Avoid pep8 violation (OpenAPITools#4316)
[JS] Update package.json (OpenAPITools#4261)
Add slash-arun to Python technical committee (OpenAPITools#4354)
[typescript-fetch] Fix discriminator mapping name (OpenAPITools#4340)
fix security alerts reported by github (OpenAPITools#4344)
fix cpp-restbed-server json field serialization OpenAPITools#4320 (OpenAPITools#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (OpenAPITools#4341)
fix(typescript-angular): do not call .toISOString() on a string (OpenAPITools#4330) (OpenAPITools#4337)
update samples (OpenAPITools#4334)
Prepare 4.2.0 release (OpenAPITools#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (OpenAPITools#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (OpenAPITools#4056)
...
@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov see #4387

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@eriktim@macjohnny@Bessonov
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[typescript-fetch] Fix discriminator mapping name - #4340

Merged
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name
Nov 1, 2019
Merged

[typescript-fetch] Fix discriminator mapping name#4340
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name

Conversation

@eriktim

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

The typescript-fetch generator incorrectly using the modelName as the identifier for tagged unions (discriminators). This PR patches that by using the mappingName instead, as this may have been set to an arbitrary value.

cc @TiFu@taxpon@sebastianhaas@kenisteward@Vrolijkx@macjohnny@nicokoenig@topce@akehir

@auto-labeler

Copy link
Copy Markdown

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@eriktimeriktim added this to the 4.2.1 milestone Oct 31, 2019
@macjohnny

Copy link
Copy Markdown
Member

thanks for the PR. is mappingName always set? what is its value?

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@macjohnny Yes, in the discriminator.mappedModels it is always set. There are some other edge cases with discriminators that do not seem to work at the moment. I'll create new PRs once/if I run into them.

This fix is for the "Mapping Type Names" in https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

@Bessonov

Copy link
Copy Markdown

@eriktim I'm not sure that it's related, but I still get generated converters, which doesn't exists in models. Reproduction:
https://github.com/Bessonov/openapi-bug

git clone https://github.com/Bessonov/openapi-bug
cd openapi-bug
./test.sh

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Ahh I actually do not use oneOf in my spec file. My patch is only for the case where you don't.

But the union type that's being created in your case is great. It seems to lack proper ToJSON/FromJSON functions though. I'm gonna see if I can create another PR for that.

@eriktim
eriktim deleted the fix-typescript-discriminator-mapping-name branch November 3, 2019 07:12
@Bessonov

Copy link
Copy Markdown

@eriktim Thank you for your response! I've experimenting a little bit and come out with following content of modelOneOf.mustache:

{{#hasImports}}import{{{#imports}}{{{.}}},{{/imports}}}from'./';{{/hasImports}}{{#discriminator}}import{{{#discriminator.mappedModels}}{{modelName}}ToJSON,{{modelName}}FromJSONTyped,{{/discriminator.mappedModels}}}from'./';{{/discriminator}}/** * @type {{classname}}{{#description}} * {{{description}}}{{/description}} * @export */exporttype{{classname}}={{#oneOf}}{{{.}}}{{^-last}}|{{/-last}}{{/oneOf}};exportfunction{{classname}}FromJSON(json: any): {{classname}}{return{{classname}}FromJSONTyped(json, false);}exportfunction{{classname}}FromJSONTyped(json: any,ignoreDiscriminator: boolean): {{classname}}{{{#discriminator}}if(!ignoreDiscriminator){{{#discriminator.mappedModels}}if(json['{{discriminator.propertyName}}']==='{{mappingName}}'){return{{modelName}}FromJSONTyped(json, true);}{{/discriminator.mappedModels}}}{{/discriminator}}thrownewError('unknown discriminator');}exportfunction{{classname}}ToJSON(value?: {{classname}}|null): any {if(value ===undefined){returnundefined;}if(value ===null){
return null;}{{#discriminator}}{{#discriminator.mappedModels}}if(value.{{discriminator.propertyName}}==='{{mappingName}}'){return{{modelName}}ToJSON(value);}{{/discriminator.mappedModels}}{{/discriminator}}thrownewError('unknown discriminator');}

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Haha nice, I've come up something similar! Wanted to do a final check tomorrow.

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov if you want you can already make a PR. I'll probably add some small comments tomorrow. Otherwise I'll create one tomorrow.

@Bessonov

Copy link
Copy Markdown

@eriktim do that in most convenient way for you, I'm not blocked anymore 👍

jimschubert added a commit that referenced this pull request Nov 3, 2019
* 'master' of github.com:OpenAPITools/openapi-generator: (88 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit that referenced this pull request Nov 3, 2019
* master: (142 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Nov 3, 2019
* master: (141 commits)
smaller tests, better code format (OpenAPITools#4355)
csharp-netcore: Replace null literals with default (OpenAPITools#4345)
[core] consider polymorphism when computing unused schemas (OpenAPITools#4335)
Fix issue 4326 forward throws for delegate to main method (OpenAPITools#4327)
[kotlin][client] annotate api exceptions (OpenAPITools#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (OpenAPITools#4353)
Remove deprecated API use of ObjectFactory.property() (OpenAPITools#2613) (OpenAPITools#4352)
[python][metadata]: Adding license and author fields (OpenAPITools#4318)
[Python] Avoid pep8 violation (OpenAPITools#4316)
[JS] Update package.json (OpenAPITools#4261)
Add slash-arun to Python technical committee (OpenAPITools#4354)
[typescript-fetch] Fix discriminator mapping name (OpenAPITools#4340)
fix security alerts reported by github (OpenAPITools#4344)
fix cpp-restbed-server json field serialization OpenAPITools#4320 (OpenAPITools#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (OpenAPITools#4341)
fix(typescript-angular): do not call .toISOString() on a string (OpenAPITools#4330) (OpenAPITools#4337)
update samples (OpenAPITools#4334)
Prepare 4.2.0 release (OpenAPITools#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (OpenAPITools#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (OpenAPITools#4056)
...
@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov see #4387

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@eriktim@macjohnny@Bessonov
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

[typescript-fetch] Fix discriminator mapping name - #4340

Merged
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name
Nov 1, 2019
Merged

[typescript-fetch] Fix discriminator mapping name#4340
macjohnny merged 1 commit into
OpenAPITools:masterfrom
eriktim:fix-typescript-discriminator-mapping-name

Conversation

@eriktim

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

The typescript-fetch generator incorrectly using the modelName as the identifier for tagged unions (discriminators). This PR patches that by using the mappingName instead, as this may have been set to an arbitrary value.

cc @TiFu@taxpon@sebastianhaas@kenisteward@Vrolijkx@macjohnny@nicokoenig@topce@akehir

@auto-labeler

Copy link
Copy Markdown

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@eriktimeriktim added this to the 4.2.1 milestone Oct 31, 2019
@macjohnny

Copy link
Copy Markdown
Member

thanks for the PR. is mappingName always set? what is its value?

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@macjohnny Yes, in the discriminator.mappedModels it is always set. There are some other edge cases with discriminators that do not seem to work at the moment. I'll create new PRs once/if I run into them.

This fix is for the "Mapping Type Names" in https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/

@Bessonov

Copy link
Copy Markdown

@eriktim I'm not sure that it's related, but I still get generated converters, which doesn't exists in models. Reproduction:
https://github.com/Bessonov/openapi-bug

git clone https://github.com/Bessonov/openapi-bug
cd openapi-bug
./test.sh

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Ahh I actually do not use oneOf in my spec file. My patch is only for the case where you don't.

But the union type that's being created in your case is great. It seems to lack proper ToJSON/FromJSON functions though. I'm gonna see if I can create another PR for that.

@eriktim
eriktim deleted the fix-typescript-discriminator-mapping-name branch November 3, 2019 07:12
@Bessonov

Copy link
Copy Markdown

@eriktim Thank you for your response! I've experimenting a little bit and come out with following content of modelOneOf.mustache:

{{#hasImports}}import{{{#imports}}{{{.}}},{{/imports}}}from'./';{{/hasImports}}{{#discriminator}}import{{{#discriminator.mappedModels}}{{modelName}}ToJSON,{{modelName}}FromJSONTyped,{{/discriminator.mappedModels}}}from'./';{{/discriminator}}/** * @type {{classname}}{{#description}} * {{{description}}}{{/description}} * @export */exporttype{{classname}}={{#oneOf}}{{{.}}}{{^-last}}|{{/-last}}{{/oneOf}};exportfunction{{classname}}FromJSON(json: any): {{classname}}{return{{classname}}FromJSONTyped(json, false);}exportfunction{{classname}}FromJSONTyped(json: any,ignoreDiscriminator: boolean): {{classname}}{{{#discriminator}}if(!ignoreDiscriminator){{{#discriminator.mappedModels}}if(json['{{discriminator.propertyName}}']==='{{mappingName}}'){return{{modelName}}FromJSONTyped(json, true);}{{/discriminator.mappedModels}}}{{/discriminator}}thrownewError('unknown discriminator');}exportfunction{{classname}}ToJSON(value?: {{classname}}|null): any {if(value ===undefined){returnundefined;}if(value ===null){
return null;}{{#discriminator}}{{#discriminator.mappedModels}}if(value.{{discriminator.propertyName}}==='{{mappingName}}'){return{{modelName}}ToJSON(value);}{{/discriminator.mappedModels}}{{/discriminator}}thrownewError('unknown discriminator');}

@eriktim

Copy link
Copy Markdown
ContributorAuthor

Haha nice, I've come up something similar! Wanted to do a final check tomorrow.

@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov if you want you can already make a PR. I'll probably add some small comments tomorrow. Otherwise I'll create one tomorrow.

@Bessonov

Copy link
Copy Markdown

@eriktim do that in most convenient way for you, I'm not blocked anymore 👍

jimschubert added a commit that referenced this pull request Nov 3, 2019
* 'master' of github.com:OpenAPITools/openapi-generator: (88 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit that referenced this pull request Nov 3, 2019
* master: (142 commits)
smaller tests, better code format (#4355)
csharp-netcore: Replace null literals with default (#4345)
[core] consider polymorphism when computing unused schemas (#4335)
Fix issue 4326 forward throws for delegate to main method (#4327)
[kotlin][client] annotate api exceptions (#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (#4353)
Remove deprecated API use of ObjectFactory.property() (#2613) (#4352)
[python][metadata]: Adding license and author fields (#4318)
[Python] Avoid pep8 violation (#4316)
[JS] Update package.json (#4261)
Add slash-arun to Python technical committee (#4354)
[typescript-fetch] Fix discriminator mapping name (#4340)
fix security alerts reported by github (#4344)
fix cpp-restbed-server json field serialization #4320 (#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (#4341)
fix(typescript-angular): do not call .toISOString() on a string (#4330) (#4337)
update samples (#4334)
Prepare 4.2.0 release (#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (#4056)
...
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Nov 3, 2019
* master: (141 commits)
smaller tests, better code format (OpenAPITools#4355)
csharp-netcore: Replace null literals with default (OpenAPITools#4345)
[core] consider polymorphism when computing unused schemas (OpenAPITools#4335)
Fix issue 4326 forward throws for delegate to main method (OpenAPITools#4327)
[kotlin][client] annotate api exceptions (OpenAPITools#4339)
refactor java-vertx-web parameters and bugfix on non primitive parameter (OpenAPITools#4353)
Remove deprecated API use of ObjectFactory.property() (OpenAPITools#2613) (OpenAPITools#4352)
[python][metadata]: Adding license and author fields (OpenAPITools#4318)
[Python] Avoid pep8 violation (OpenAPITools#4316)
[JS] Update package.json (OpenAPITools#4261)
Add slash-arun to Python technical committee (OpenAPITools#4354)
[typescript-fetch] Fix discriminator mapping name (OpenAPITools#4340)
fix security alerts reported by github (OpenAPITools#4344)
fix cpp-restbed-server json field serialization OpenAPITools#4320 (OpenAPITools#4323)
typescript-angular: fix oneOf and anyOf generates incorrect model for primitive types (OpenAPITools#4341)
fix(typescript-angular): do not call .toISOString() on a string (OpenAPITools#4330) (OpenAPITools#4337)
update samples (OpenAPITools#4334)
Prepare 4.2.0 release (OpenAPITools#4333)
[FEATURE][Haskell] Haskell-Servant serves static files (OpenAPITools#4058)
[FEATURE][Haskell] Add Middleware support for the haskell servant generator (OpenAPITools#4056)
...
@eriktim

Copy link
Copy Markdown
ContributorAuthor

@Bessonov see #4387

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@eriktim@macjohnny@Bessonov