swagger-api/swagger-ui

Setting VALIDATOR_URL=null with Docker results in broken link

Aberta

#5.519 aberto em 5 de ago. de 2019

Ver no GitHubGuia do colaborador
 (2 comentários) (0 reação) (0 responsável)JavaScript (8.801 forks)batch import
Hacktoberfestcat: dockertype: bug

Métricas do repositório

Stars
 (25.447 estrelas)
Métricas de merge de PR
 (Mesclagem média 20h 34m) (14 fundiu PRs em 30d)

Description

Q&A (please complete the following information)

  • OS: Docker on Windows 10 with Linux containers
  • Browser: Chrome
  • Version: 76
  • Method of installation: Docker
  • Swagger-UI version: v3.23.4
  • Swagger/OpenAPI version: Swagger 2.0

Describe the bug you're encountering

When running the Docker container with -e VALIDATOR_URL=null, the validator badge is not disabled and instead shows up as a broken link. The documentation at https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#network says to use null to disable the validator badge. It appears that an empty string does disable the validator (i.e. -e VALIDATOR_URL=). I'm not sure which behavior was intended, but if an empty string was the intended way to disable the validator, the documentation should probably be more explicit.

To reproduce...

Steps to reproduce the behavior:

  1. Run Docker container with docker run -d -p 80:8080 -e URL=http://mySwaggerSpec -e VALIDATOR_URL=null swaggerapi/swagger-ui
  2. Browse to the local Swagger UI using something other than localhost (e.g. http://myComputerDnsName)
  3. The validator badge displays as a broken image with a broken link

Expected behavior

The validator badge should not show up at all.

Guia do colaborador

Direção de pesquisa
Inspecione o código que processa a variável de ambiente VALIDATOR URL, provavelmente no módulo de configuração. Descubra como ele compara o valor para desabilitar o selo do validador. Verifique também a documentação no guia de uso. Então proponha uma correção para fazer null funcionar ou atualizar a documentação.
Pilha de tecnologia
javascript
Domain
frontend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitDocker
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80