swagger-api / swagger-api/swagger-ui

URL with invalid urls.primaryName loads default page without error notification

Open
#10,671 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Swagger UI does not notify user when URL refers to an invalid API name eg
https://demo.caspio.com/integrations/rest/swagger/index.html?urls.primaryName=Caspio+REST+API+v3+NotExist
load the default API page and does not notify the user about the problem

Image
  • OS: Windows 11
  • Browser: Chrome
  • Version: 143
  • Method of installation:
  • Swagger-UI version: 5.11
  • Swagger/OpenAPI version: 3.0
Content & configuration

Navigate to the invalid link
https://demo.caspio.com/integrations/rest/swagger/index.html?urls.primaryName=Caspio+REST+API+v3+NotExist
and notice that no error feedback is provided to the user.

Describe the bug you're encountering

No error feedback to user when URL / query param is invalid

Steps to reproduce the behavior:

In the browser, open the invalid link
https://demo.caspio.com/integrations/rest/swagger/index.html?urls.primaryName=Caspio+REST+API+v3+NotExist
and notice that no error feedback is provided to the user.

Expected behavior

An error or popup indicating that the part of the URL that is invalid

Screenshots

See above

Additional context or thoughts

None

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue by opening the provided Swagger UI URL with an invalid urls.primaryName query parameter. Trace where that parameter is handled and how the default API page is selected. Done means an invalid API name produces visible error feedback instead of silently loading the default page; verify the behavior in Chrome with the supplied URL.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.