OpenAPITools / OpenAPITools/openapi-generator

[REQ][typescript-nestjs] Accept async function for fetching access token

Open
#18,048 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

Most access tokens are fetched with async/network requests which the current ConfigurationParameters doesn't support.

export interface ConfigurationParameters {
    apiKeys?: {[ key: string ]: string};
    username?: string;
    password?: string;
    accessToken?: string | (() => string);
    basePath?: string;
    withCredentials?: boolean;
}

Describe the solution you'd like

ConfigurationParameters.accessToken should start supporting the following signature

export interface ConfigurationParameters {
    ...
    accessToken?: string | Promise<string> | (() => string) | (() => Promise<string>);
    ...
}

Describe alternatives you've considered

None

Additional context

This issue is similar to https://github.com/OpenAPITools/openapi-generator/issues/7105

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 TypeScript NestJS ConfigurationParameters interface and the generated client code that consumes accessToken. Check how the current string and synchronous function forms are handled, then run the related generated-client tests if present. Done means accepting string, Promise, and synchronous or asynchronous functions for accessToken.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.