Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !7894

[typescript-fetch] Allow to generate client without runtime checks

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/acote-coveo/feature/typescript-fetch-fix-union-types into master Nov 06, 2020
  • Overview 0
  • Commits 4
  • Pipelines 0
  • Changes 42

Created by: acote-coveo

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

I tried to use the typescript-fetch client with a spec that use union and saw that the types were good but the serialization/deserialization wasn't working pretty well.

The main problems are:

  • Lack of information about oneOf (it only contains a list of data types. A datatype can be OneType or Array<Type1 | Type2 | string | boolean>)
  • Difficulty to implement imports due to the nested levels of typing.

Example of what was badly generated

Below, we have a list of oneOf data types to map. Thus, to serialize them, we call dataType[ToJson]. We then end up with something like boolean | AdvancedGenerateQueryFieldParameter ToJson

export function ToIncludeParametersToJSON(value?: ToIncludeParameters | null): any {
    if (value === undefined) {
        return undefined;
    }
    if (value === null) {
        return null;
    }
    return {
        
        'fields': value.fields === undefined ? undefined : ((value.fields as Array<any>).map(string | AdvancedQueryFieldParametersToJSON)),
        'summary': boolean | AdvancedGeneratedQueryFieldParameterToJSON(value.summary),
        'excerpt': boolean | AdvancedGeneratedQueryFieldParameterToJSON(value.excerpt),
        'highlighting': HighlightingSettingsToJSON(value.highlighting),
    };
}

Simple solution

A bit like what has been done with the Axios client,I added a flag that allows to generate a client without any runtime checks.

So we simplify the client to only generate the interfaces and cast the input/output to these. For a small effort, we now are able to have a simple client that compiles.

On a subsequent pull request, I would like to address the problem of unions by also providing serialization/deserialization (runtime checks).

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/acote-coveo/feature/typescript-fetch-fix-union-types