swagger-api/swagger-codegen

Read-only Attributes in API client's models

Open

#3.210 geöffnet am 24. Juni 2016

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Enhancement: Generalhelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Das Problem ist eine Designentscheidung aus dem Jahr 2016, die vorsah, Setter zu schreibgeschützten Attributen in C# API Client Modellen hinzuzufügen. Es gab keine weiteren Diskussionen oder Implementierungen. Ein Mitwirkender müsste die aktuellen C# Codegenerierungsvorlagen (wahrscheinlich in modules/swagger codegen/src/main/resources/Codegen/libraries/csharp/) untersuchen, um zu verstehen, wie Modelleigenschaften generiert werden. Die Änderung würde beinhalten, sicherzustellen, dass alle Attribute Setter haben, und die Konstruktorsignaturen entsprechend anzupassen. Es gibt keine verknüpften Pull Requests oder aktuelle Kommentare, die die Arbeit leiten könnten.
Tech Stack
Keine
Domain
backendapitooling
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Swagger/OpenAPI knowledgebasic knowledge of code generation
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60