[Schema Inaccuracy] example seemingly used as a pseudo-discriminator
Mantenedores costumam responder em até 1 dia
@nickfloyd já está trabalhando nisso.
Desde 6/11/2025.
Avaliação
Esta issue ainda não foi avaliada.
Descrição
.components.schemas.environment.properties.protection_rules (and some other places I think) is defined as:
"anyOf": [
{
"type": "object",
"properties": {
"id": { "type": "integer", "example": 3515 },
"node_id": { "type": "string", "example": "MDQ6R2F0ZTM1MTU=" },
"type": { "type": "string", "example": "wait_timer" },
"wait_timer": { "$ref": "#/components/schemas/wait-timer" }
},
"required": [ "id", "node_id", "type" ]
},
{
"type": "object",
"properties": {
"id": { "type": "integer", "example": 3515 },
"node_id": { "type": "string", "example": "MDQ6R2F0ZTM1MTU=" },
"type": { "type": "string", "example": "required_reviewers" },
"reviewers": { ... }
},
"required": [ "id", "node_id", "type" ]
},
{
"type": "object",
"properties": {
"id": { "type": "integer", "example": 3515 },
"node_id": { "type": "string", "example": "MDQ6R2F0ZTM1MTU=" },
"type": { "type": "string", "example": "branch_policy" }
},
"required": [ "id", "node_id", "type" ]
}
The examples associated with the type property seem to be used as discriminator values (although without that being spelled out explicitely anywhere).
I understand OpenAPIv3 has a discriminator feature for exactly that use case.
- Linguagem predominante
- Sem dados de linguagem
- Estrelas
- 1.6k
- Forks
- 347
- Merge médio
- 2h 1min
- PRs com merge (30d)
- 80
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o 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 github/rest-api-description
-
feature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 62/100
github/rest-api-description#7286 ·
Mantenedores costumam responder em até 1 dia
-
feature
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
github/rest-api-description#7266 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
feature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
github/rest-api-description#7246 ·
Mantenedores costumam responder em até 1 dia
-
feature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
github/rest-api-description#7220 ·
Mantenedores costumam responder em até 1 dia
-
feature
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
github/rest-api-description#7201 ·
Mantenedores costumam responder em até 1 dia