swagger-api/swagger-ui

Swagger UI doesn't know how to deal when URLS is empty array

Open

#5,663 opened on Oct 16, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (8,801 forks)batch import
HacktoberfestP2cat: user experiencetype: bug

Repository metrics

Stars
 (25,447 stars)
PR merge metrics
 (Avg merge 20h 34m) (14 merged PRs in 30d)

Description

Q&A (please complete the following information)

  • OS: linux (Ubuntu 18.04)
  • Browser: google Chrome
  • Version: 78.0.3904.50
  • Method of installation: webjars Clasic
  • Swagger-UI version: 3.23.8
  • Swagger/OpenAPI version: OpenAPI 3.0

Content & configuration

Swagger-UI configuration options:

SwaggerUI({
 urls: [ ]
})

Describe the bug you're encountering

Swagger UI doesn't know hot to render when URLS parameter is an empty array ("[]"). It reports an error

To reproduce...

Steps to reproduce the behavior:

  1. open swaggerUI
  2. extend address with "?urls=[]" OR change inital swaggerUI configuration inside index.html to something like:
SwaggerUI({
 urls: [ ]
})

Expected behavior

I expect that topbar will be with empty selector.

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.