Azure / Azure/azure-functions-openapi-extension

Allow passing JsonSerializerSettings to OpenApiExampleResolver

Open
#473 4 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
C#
Stars
388
Forks
202
PR merge metrics
No merged PRs in 30d

Description

Currently, we can pass naming strategy to the Resolve() methods, but I have additional settings (e.g. custom converters) I would like to use for generating examples.

I feel it would be handy to pass serializer settings to resolve, or use JsonConvert.DefaultSettings to get the default settings, which we can set in startup.

Contributor guide

Open the contributing guide

Research direction

Start with OpenApiExampleResolver and its Resolve() methods, then inspect how the naming strategy is passed. Done means callers can provide JsonSerializerSettings for example generation, including custom converters, or the resolver uses JsonConvert.DefaultSettings as described, while existing behavior remains intact.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.