Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1orgs~1{org}~1insights~1api~1subject-stats/get`

Aberta
  • Algo errado?
#5,593 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
52/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
openapi
Domínio
api

Direção de pesquisa

Comece pela definição OpenAPI de GET /orgs/{org}/insights/api/subject-stats e pelo exemplo referenciado em #/components/examples/api-insights-subject-stats/value. Compare o schema com o exemplo mostrado tanto no FPT quanto no GHEC e atualize a definição para que integration_id seja representado de forma consistente. Está concluído quando o schema e o exemplo estiverem sincronizados.

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

Descrição

feature

Schema Inaccuracy

This is the json ref for the example

#/components/examples/api-insights-subject-stats/value

The field integration_id doesn't exist in the schema, but exists in the example.

Here's a snippet

    1: [ {
    2:   "subject_type" : "installation",
    3:   "subject_id" : 954453,
    4:   "subject_name" : "GitHub Actions",
>   5:   "integration_id" : 124345,
    6:   "total_request_count" : 544665,
    7:   "rate_limited_request_count" : 13,
    8:   "last_request_timestamp" : "2024-09-18T15:43:03Z",
    9:   "last_rate_limited_timestamp" : "2024-09-18T06:30:09Z"

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
Linguagem predominante
Sem dados de linguagem
Estrelas
1.6k
Forks
347
Merge médio
2h 1min
PRs com merge (30d)
80

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 github/rest-api-description

Todas as issues de github/rest-api-description

Issues semelhantes

Mais issues de Backend & API Design

Receba novas issues na sua caixa de entrada

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