swagger-api/swagger-codegen

Read-only Attributes in API client's models

Open

#3,210 opened on 2016年6月24日

GitHub で見る
 (1 comment) (1 reaction) (0 assignees)HTML (5,474 forks)batch import
Enhancement: Generalhelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

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.

コントリビューターガイド

調査方針
この問題は、2016年にC# APIクライアントモデルの読み取り専用属性にセッターを追加する計画として行われた設計上の決定です。その後、さらなる議論や実装は行われていません。貢献者は、現在のC#コード生成テンプレート（おそらくmodules/swagger codegen/src/main/resources/Codegen/libraries/csharp/内）を調べて、モデルプロパティの生成方法を理解する必要があります。変更には、すべての属性にセッターを確実に含め、それに応じてコンストラクターのシグネチャを調整することが含まれます。この作業を導くための関連するプルリクエストや最近のコメントはありません。
技術スタック
なし
領域
backendapitooling
Issue 種別
リファクタリング
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Swagger/OpenAPI knowledgebasic knowledge of code generation
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60