swagger-api/swagger-codegen

Read-only Attributes in API client's models

Open

#3.210 aberto em 24 de jun. de 2016

Ver no GitHub
 (1 comment) (1 reaction) (0 assignees)HTML (5.474 forks)batch import
Enhancement: Generalhelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
O problema é uma decisão de design de 2016 que planejava adicionar setters aos atributos somente leitura nos modelos de cliente API em C#. Não houve discussão ou implementação posterior. Um contribuidor precisaria examinar os modelos atuais de geração de código C# (provavelmente em modules/swagger codegen/src/main/resources/Codegen/libraries/csharp/) para entender como as propriedades do modelo são geradas. A alteração envolveria garantir que todos os atributos tenham setters e ajustar as assinaturas dos construtores de acordo. Não há pull requests vinculados ou comentários recentes disponíveis para orientar o trabalho.
Pilha de tecnologia
None
Domain
backendapitooling
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Swagger/OpenAPI knowledgebasic knowledge of code generation
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60