API - send/receive API version as header
Mantenedores costumam responder em até 7 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 25/100
- Tipo de issue
- Funcionalidade
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Domínio
- api, backend-api-design
Direção de pesquisa
Comece lendo o changelog de versões em docs/CALENDAR_API.md. Esclareça se as requisições e respostas usam versões major, qual código de status se aplica a versões não suportadas e se o servidor usa a versão mais recente por padrão. Considera-se concluído quando o comportamento acordado de negociação de versões estiver documentado e implementado com uma prova de conceito para v1 e v2.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
The API should include the version number as a header in responses, e.g.
API-Version: 3
(Major version number only?)
Clients would also be encouraged (though not required) to include the version they're using in requests. If the client doesn't specify, the server would assume the latest version. In the future we may rev the version and introduce breaking changes, so clients should send the version they're expecting to ensure a predictable response.
As a proof of concept for handling different versions, we could check for v1 or v2 requests and reject those. (There should be no real requests for those versions, because those version numbers were defined post-hoc well after we were already on v3.) Error status code could be 400, or possibly 406 (Not Acceptable).
- Linguagem predominante
- JavaScript
- Estrelas
- 30
- Forks
- 26
- Merge médio
- 6d 24min
- PRs com merge (30d)
- 6
Preparar o ambiente
- Inclui um Dockerfile ou arquivo Docker Compose
- Sem modelo de pull request
- Sem guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de shift-org/shift-docs
-
Export links and the webcal feed 404 under npm run devTalvez já em andamento @dduugg assumiu há 1 dia. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 83/100
shift-org/shift-docs#1121 ·
Mantenedores costumam responder em até 7 dias
-
Unknown --db values report a TypeError instead of the intended errorTalvez já em andamento @gangster assumiu há 73 dias. Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
shift-org/shift-docs#1091 ·
Mantenedores costumam responder em até 7 dias
-
validateRideLength accepts any Object.prototype key as a ride lengthTalvez já em andamento @gangster assumiu há 73 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
shift-org/shift-docs#1089 ·
Mantenedores costumam responder em até 7 dias
-
Favorites page fetches every favorite because getDaily's guard is invertedTalvez já em andamento @gangster assumiu há 73 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
shift-org/shift-docs#1087 ·
Mantenedores costumam responder em até 7 dias
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
shift-org/shift-docs#1126 ·
Mantenedores costumam responder em até 7 dias
Todas as issues de shift-org/shift-docs
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
bigskysoftware/htmx#4147 ·
Mantenedores costumam responder em até 5 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
vshymanskyy/StandWithUkraine#316 ·
-
bug/1-unconfirmed kind/bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 74/100
521xueweihan/HelloGitHub#4010 · 2 comentários ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100