zowe / zowe/api-layer

Easier debugging of swagger doc rendering

Open
#2,315 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement extender help-wanted Priority: High size/M
Dominant language
Java
Stars
92
Forks
81
Avg merge
1d 9h
Merged PRs (30d)
46

Description

Is your feature request related to a problem? Please describe.
I sometimes help debug why a swagger document doesn't render properly in the API Catalog. It is not easy, there is not good logging to show how the swagger doc is queried and transformed by the API Catalog server, and there is no information in the UI except for sometimes a very generic error that it could not be retrieved.

Describe the solution you'd like
Better logging server side, ideally without requiring debug mode (errors should be logged regardless).

I'd also like better information in the UI. Sometimes there is an error message in the UI, but it is usually not actually relevant and is always the same error message. Sometimes the substitute swagger is shown (e.g. if no swaggerUrl is present), but we should also indicate why the substitute was shown (error retrieving swagger vs no url given).

Describe alternatives you've considered

Additional context

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

Start by tracing how the API Catalog server retrieves and transforms Swagger documents, then inspect the UI paths for retrieval errors and substitute Swagger. Define the logging and user-facing distinctions for retrieval failures versus a missing swaggerUrl; done means both server-side diagnostics and specific UI explanations are present.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend, frontend, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.