OpenAPITools / OpenAPITools/openapi-generator

[BUG] [javascript] useAbstractionForFiles for javascript client

Open
#12,032 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Currently, I'm creating an API client library in Javascript to communicate between API's and this library is super useful for this.

I just struggle with the use of files, because after generating a swagger file with File/Binary type when the openapi-generator
use the File Type in the returnType, this is causing problems when I try to use it inside another API that is built in Nodejs because this class only exists in WebAPI.

Reading the documentation I saw that in the Java generator there's a property you can enable to use the raw data (bytes). Could be possible to have something like this in the javascript generator?

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the JavaScript generator code that maps File/Binary schemas to returnType values, then compare it with the Java generator's raw-data or bytes option. Done means a configurable JavaScript-generator behavior avoids the WebAPI-only File type when generating Node.js clients.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, javascript
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.