Azure / Azure/azure-functions-openapi-extension

Add schema definition for implementation of interface

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

Description

If the response returns an interface, how can I mark classes implementing this interface as schema's (so the consumer can read possible outcome)
I've tried adding an example to the OpenApiResponseWithBody and this shows the right possibilities at 'example value' but not 'schema'

Contributor guide

Open the contributing guide

Research direction

Start by inspecting OpenApiResponseWithBody and how an interface response is converted into an OpenAPI schema. Compare the generated schema with the example value behavior described in the issue, then determine how implementing classes should appear as possible outcomes. Done means consumers can see those implementations in the schema, not only in the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, openapi
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.