OpenAPITools / OpenAPITools/openapi-generator

[BUG][csharp] Bearer token not added when using AccessToken configuration

Open
#20,004 0 comments 0 reactions 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

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

Using either of these two configurations does not set the Authorization: Bearer <access_token> header.

var configuration = new Configuration
{
    AccessToken = accessToken
}
var configuration = new Configuration
{
    ApiKeyPrefix = new Dictionary<string, string>
    {
        { "Authorization", "Bearer" }
    },
    ApiKey = new Dictionary<string, string>
    {
        { "Authorization", accessToken }
    }
}

But using DefaultHeaders seems to work. This is counter intuitive - the AccessToken configuration property should either be fixed or removed.

// This works but it is ugly
var configuration = new Configuration
{
    DefaultHeaders = new Dictionary<string, string>
    {
         { "Authorization", $"Bearer {accessToken}" }
    }
}
openapi-generator version

openapitools/openapi-generator-cli:latest

OpenAPI declaration file content or url

https://api.signicat.com/info/lookup/swagger/v1/swagger.json

Generation Details
docker run --rm --volume "${PWD}:/generated" openapitools/openapi-generator-cli generate \
    -i https://api.signicat.com/info/lookup/swagger/v1/swagger.json \
    -g csharp \
    -o /generated \
    --additional-properties=targetFramework=net8.0

Steps to reproduce
  1. Run the docker command above
  2. Set the authorization token either with the AccessToken configuration property or by the ApiKeyPrefix + ApiKey configuration properties.
  3. Send a request
  4. Inspect the request headers
  5. See that Authorization: Bearer <access_token> is not present
Related issues/PRs
Suggest a fix

Remove the non-working configuration properties or fix them.

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

Reproduce the issue with the provided Docker generation command and the Signicat OpenAPI document, targeting csharp. Start at the generated Configuration entry point and the request authentication handling for AccessToken, ApiKeyPrefix, and ApiKey. Done means generated requests include the expected Authorization: Bearer <access_token> header, with regression coverage for the affected configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api, authentication
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.