use API docs to determine expected fields in API responses

Aberta
#526 0 comentários 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Pouca atividade
Stack de tecnologia
r
Domínio
api

Direção de pesquisa

Comece revisando os pull requests 513 e 509, especialmente a discussão sobre remover response-field e a verificação de tipos. Em seguida, inspecione como o cliente expõe a versão do Connect e como as respostas da API são retornadas atualmente. O trabalho estará concluído quando a especificação apropriada da API Connect, quando disponível, for usada para determinar os campos de resposta esperados sem restaurar uma verificação de tipos frágil.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

in https://github.com/posit-dev/connectapi/pull/513 we removed the brittle list of expected response fields and types. Enforcing these fields and types caused a maintenance headache when the Connect API changed (lots of issues like this).

We don't want to bother with the type enforcement that we used to do, but when working on https://github.com/posit-dev/connectapi/pull/513 we did discuss the possibility of determining the expected fields based on Connect's API spec docs. The Connect client surfaces the Connect version (if it's not hidden by the server) which can be used to find the right spec.

Using the spec to ensure we return the expected fields might allow us to return more useful outputs in cases like this.

Linguagem predominante
R
Estrelas
54
Forks
27
Merge médio
1d 21min
PRs com merge (30d)
4

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de posit-dev/connectapi

Todas as issues de posit-dev/connectapi

Issues semelhantes

Mais issues de R

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.