dotnet/aspnetcore

Analyzers API1000 and API1001 should trigger on conditional returns

Open

#33,105 opened on May 28, 2021

View on GitHub
 (9 comments) (2 reactions) (0 assignees)C# (10,653 forks)batch import
analyzerarea-mvcfeature-openapigood first issuehelp wanted

Repository metrics

Stars
 (37,933 stars)
PR merge metrics
 (Avg merge 16d 9h) (258 merged PRs in 30d)

Description

Describe the solution you'd like

Analyzers API1000 and API1001 should trigger on returns (or expression-bodied methods) with conditional expressions.

Additional context

public ActionResult<object> OopsUndocumentedIf(int id)
{
    if (id == 0)
    {
        return NotFound(); // API1000
    }

    return Ok(new object());
}

public ActionResult<object> OopsUndocumentedConditional(int id)
{
    return id == 0 ? NotFound() : Ok(new object()); // No API1000
}

Contributor guide

Research direction
Locate the source files for analyzers API1000 and API1001 (likely in src/Analyzers). Examine how they currently detect 'return' statements and extend them to also flag conditional expressions such as ternary operators (? :) and inline if else. Write or update tests to cover these scenarios.
Tech stack
csharp
Domain
backend
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.
1-2 days
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#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70