RicoSuter/NSwag

Remove invalid characters in path segments when generating operation names

Open

#2,447 opened on Oct 5, 2019

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedtype: bug

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Some OpenApi paths include characters which are not valid in a C# identifier and should not be included in the generated operation name.

Here is an example:

"/path1/path2/>pathWithInvalidPrefixChar": {
      "get": {
        "description": "",
        "operationId": "pathWithInvalidPrefixChar",
...

In this example, the ">" character should not be included in the generated operation name.

Contributor guide

Research direction
Examine the code in NSwag that generates operation names from path segments and add sanitization to remove invalid characters for C# identifiers.
Tech stack
csharp
Domain
apitooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C#OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70