Incorrect validation occuring due to property using "enum" as a property name
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Bug
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- javascript
Direção de pesquisa
Comece reproduzindo o aviso com o openapi.yaml referenciado e o exemplo de PropertyPrototype, concentrando-se no caminho em que uma propriedade se chama "enum". Rastreie como o validator interpreta esse caminho e adicione um caso de regressão cobrindo o exemplo; considera-se concluído quando o documento não produzir mais o falso aviso de enum, enquanto a validação genuína de enum continuar funcionando.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Version: [email protected]
The validator comes back with a warning for the content of some of our example responses:
Message : Enum value "option1" must be "single_select".
Path : paths./tekton_pipelines/{pipeline_id}/properties.post.requestBody.content.application/json.examples.single_select_env_properties.value.enum.0
Line : 1119
This is arising in 9 places in our API yaml. The full yaml file can be seen here
This is one example:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PropertyPrototype'
examples:
single_select_env_properties:
value:
name: "enums"
type: "single_select"
enum: ["option1","option2","option3"]
value: "option1"
Schema for the enum:
enum:
description: Options for `single_select` property type
type: array
minItems: 0
maxItems: 1024
items:
$ref: '#/components/schemas/GeneralString'
It seems like the fact we are using the term enum for one of the properties in our API schema is confusing the validator
- Linguagem predominante
- JavaScript
- Estrelas
- 635
- Forks
- 98
- Merge médio
- 1d 5h
- PRs com merge (30d)
- 8
Preparar o ambiente
- Inclui um Dockerfile ou 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 IBM/openapi-validator
-
security
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 52/100
IBM/openapi-validator#875 · 1 comentário ·
-
`Provided ruleset is not an object` error after upgrading from 1.37.12 to 1.37.13Talvez livre de novo @diatrcz assumiu há 123 dias e não há nenhum pull request aberto. Aberta
IBM/openapi-validator#809 · 5 comentários · 2 reações · 1 responsável ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 45/100
IBM/openapi-validator#748 · 4 comentários ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 42/100
IBM/openapi-validator#747 · 2 comentários · 1 reação ·
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 32/100
IBM/openapi-validator#643 · 3 comentários ·
Todas as issues de IBM/openapi-validator
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
jonathanong/no-mistakes#3332 ·
Mantenedores costumam responder em até 1 dia
-
documentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
githubnext/gh-aw-workshop#5674 ·
Mantenedores costumam responder em até 1 dia
-
更新已收录主题套装为三主题及管理器兼容说明Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 62/100
awesome-dsh-plugin/awesome-dsh-plugin#14970 ·
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
swc-project/swc-ai-issues#653 ·