Azure / Azure/azure-functions-openapi-extension

Feature request: support for readOnly fields

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

Description

Right now there is no direct support to mark a particular field as `readOnly`. While using the API first approach, we are right now using the same data model as an input and output of the API call, obviously to limit the duplication of definitions. We are using `readOnly` attribute to indicate the fields that are not meant to be set by the client application as the input fields, but we would like to have such fields present in the output (and set by the server app).

It would be nice to have support in this tool to mark a particular property of a class readonly, e.g. by using `System.ComponentModel.ReadOnlyAttribute` or similar (preferrably generic) way and use that to identify such field as `readOnly` in the output openapi schema.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.