swagger-api/swagger-codegen

Read-only Attributes in API client's models

Open

#3210 aperta il 24 giu 2016

Vedi su GitHub
 (1 commento) (1 reazione) (0 assegnatari)HTML (5474 fork)batch import
Enhancement: Generalhelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Il problema è una decisione di progettazione del 2016 che prevedeva l'aggiunta di setter agli attributi di sola lettura nei modelli client API C#. Non ci sono state ulteriori discussioni o implementazioni. Un collaboratore dovrebbe esaminare gli attuali modelli di generazione del codice C# (probabilmente in modules/swagger codegen/src/main/resources/Codegen/libraries/csharp/) per capire come vengono generate le proprietà del modello. La modifica comporterebbe garantire che tutti gli attributi abbiano setter e adeguare di conseguenza le firme dei costruttori. Non sono disponibili pull request collegate o commenti recenti per guidare il lavoro.
Tech stack
Nessuno
Dominio
backendapitooling
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Swagger/OpenAPI knowledgebasic knowledge of code generation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60