dotnet/aspnetcore

description is missing when using with FromForm

Open

#59,042 opened on Nov 19, 2024

View on GitHub
 (6 comments) (3 reactions) (0 assignees)C# (10,653 forks)batch import
area-minimalfeature-openapihelp wanted

Repository metrics

Stars
 (37,933 stars)
PR merge metrics
 (Avg merge 14d 3h) (205 merged PRs in 30d)

Description

Is there an existing issue for this?

  • I have searched the existing issues

Describe the bug

description on the fromform is missing

Expected Behavior

the openapi field description with the value from Description

Steps To Reproduce

add Description to FromForm field

Exceptions (if any)

No response

.NET Version

9.0.100

Anything else?

the repo is https://github.com/cjdxhjj/openapi-demo.git Image Image

Contributor guide

Research direction
Investigate the OpenAPI metadata generation for form parameters in ASP.NET Core. Look at how `FromForm` attributes are processed and how the description property is mapped. Check the relevant source code in the OpenApi model binding or operation filters. The issue reporter provided a sample repo. Reproduce and identify where the description is lost.
Tech stack
csharprest api
Domain
backendapi
Issue type
Bug
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic knowledge of ASP.NET CoreFamiliarity with OpenAPI generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60