RicoSuter/NSwag

Consider using JSON convertion for path and query parameters

Open

#675 opened on Mar 14, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedproject: NSwag.SwaggerGeneration.WebApitype: bug

Description

When an enum value is passed in the path or query, the EnumMemberAttribute is ignored because the value is serialized with ToString().

public enum Operation
{
    [EnumMember("set")]
    Set,
    [EnumMember("update")]
    Update,
}

public enum Value
{
    [EnumMember("one")]
    First,
    [EnumMember("two")]
    Second,
}

public async Task DoAsync(Operation operation, Value value)
{
    // path = {operation}
    // value is a query parameter
}

Called with DoAsync(Operation.Set, Value.First) will result in the Set?First URL instead of set?one.

It would be great if the JSON serializer was used to serialize values to path and query.

Contributor guide

Tech stack
csharptypescript
Domain
backendapideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C#NSwag basicsJSON serializationEnumMemberAttribute
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the NSwag source code to understand how path and query parameters are serialized currently. Focus on files that handle parameter conversion (e.g., in the NJsonSchema or NSwag core libraries). The issue indicates that EnumMemberAttribute is ignored; investigate why ToString() is used and how to integrate JSON serialization. Review the 5 comments for any additional context or suggested approaches.