swagger-api/swagger-codegen

Read-only Attributes in API client's models

Open

#3,210 opened on Jun 24, 2016

View on GitHub
 (1 comment) (1 reaction) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Enhancement: Generalhelp wanted

Description

DESCRIPTION

As discussed with @fehguy, we'll not do anything special for read-only attributes in API clients' models.

IMPACT

  • some model constructors (method signature) will be changed as the read-only attributes will have a setter (which means the attribute value can be changed in the API client while the server should ignore the change when receiving the request)
  • read-only attributes will have setters
  • the change only impact some languages (e.g. C# API client) as read-only attributes without setters are only implemented for a small number of API clients

WHEN

We'll make the change on Jul 1st, 2016.

QUESTION

If you've any question or feedback, please reply to let us know.

Contributor guide

Tech stack
csharprest api
Domain
api
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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Swagger/OpenAPIFamiliarity with C# code generation templatesBasic knowledge of API client models
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
The issue is a design decision from 2016 that planned to add setters to read only attributes in C# API client models. No further discussion or implementation occurred. A contributor would need to examine the current C# code generation templates (likely in modules/swagger codegen/src/main/resources/Codegen/libraries/csharp/) to understand how model properties are generated. The change would involve ensuring all attributes have setters and adjusting constructor signatures accordingly. No linked pull requests or recent comments are available to guide the work.