swagger-api/swagger-codegen

Read-only Attributes in API client's models

Open

#3 210 ouverte le 24 juin 2016

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)HTML (5 474 forks)batch import
Enhancement: Generalhelp wanted

Métriques du dépôt

Stars
 (12 701 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Le problème est une décision de conception de 2016 qui prévoyait d'ajouter des setters aux attributs en lecture seule dans les modèles de client API C#. Aucune discussion ou implémentation ultérieure n'a eu lieu. Un contributeur devrait examiner les modèles actuels de génération de code C# (probablement dans modules/swagger codegen/src/main/resources/Codegen/libraries/csharp/) pour comprendre comment les propriétés du modèle sont générées. La modification impliquerait de s'assurer que tous les attributs ont des setters et d'ajuster en conséquence les signatures des constructeurs. Aucune pull request liée ou commentaire récent n'est disponible pour guider le travail.
Stack technique
Aucun
Domaine
backendapitooling
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Swagger/OpenAPI knowledgebasic knowledge of code generation
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60