RicoSuter/NSwag

Improve GenerateOperationIds() method

Open

#836 opened on Jul 6, 2017

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

Repository metrics

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

Description

The current implementation of SwaggerDocument.GenerateOperationIds does a poor job of naming operations that are defined by the OData spec. Ideally there should be a way of providing a custom naming method with a more appropriate implementation.

(NB: this method already has a comment saying TODO: Improve this method so this is a known problem.

I imagine that the easiest way of achieving would be to make the method virtual so it can be overridden in a derived class.

Contributor guide

Research direction
Examine the SwaggerDocument class and change GenerateOperationIds from static to virtual, then provide an example override in a derived class that uses a custom naming strategy.
Tech stack
csharp
Domain
api
Issue type
Refactor
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.
Half day
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.
Clear
Prerequisites
C#OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60