[Schema Inaccuracy] Example and schema mismatch at patch-schema

Aberta Para iniciantes
#4,470 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
65/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Estagnada
Stack de tecnologia
json, openapi
Domínio
api

Direção de pesquisa

Abra descriptions-next/ghes-3.13/ghes-3.13.json e inspecione o schema e os locais dos exemplos indicados no relatório. Compare a definição do valor da patch operation com o exemplo de addMembers, atualize um dos lados para que sejam consistentes e verifique se o exemplo pode ser analisado pelo schema.

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

Descrição

documentation

Schema Inaccuracy

The schema at this location is

#/components/schemas/patch-schema/properties/Operations/items/properties/value

                "value": {
                  "type": "string",
                  "description": "Corresponding 'value' of that field specified by 'path'"
                }

The example at is

#/paths/~1scim~1v2~1enterprises~1{enterprise}~1Groups~1{scim_group_id}/patch/requestBody/content/application~1json/examples/addMembers/value

          {
            "Operations" : [ {
              "op" : "add",
              "path" : "members",
              "value" : [ {
                "value" : "879db59-3bdf-4490-ad68-ab880a2694745"
              }, {
                "value" : "0db508eb-91e2-46e4-809c-30dcbda0c685"
              } ]
            } ],
            "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ]
          }

The value cannot be parsed.

Expected

Either the example or schema is updated to match the other.

Reproduction Steps

This has been observed on

https://github.com/github/rest-api-description/raw/main/descriptions-next/ghes-3.13/ghes-3.13.json

I've checked for this in 3.10, 3.11, 3.12, 3.13, 3.14.

Linguagem predominante
Sem dados de linguagem
Estrelas
1.6k
Forks
342
Merge médio
3h 33min
PRs com merge (30d)
51

Guia de contribuição

Abrir o guia de contribuição

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.