zowe / zowe/api-layer

API Catalog shows schemas in API Docs with wrong styles

Open
#4,282 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug Priority: Low size/M
Dominant language
Java
Stars
92
Forks
81
Avg merge
1d 9h
Merged PRs (30d)
46

Description

Describe the bug

Schemas (bottom section) of the API Catalog API documentation is showing with wrong styles.
Apparently related to using Open API Specification 3.1. For example, it affects the API ML core components such as Gateway, Caching Service and API Catalog which are all OAS 3.1:

Image

But not services using OAS 3.0 or Swagger 2.0:

Image

Details

  • Version and build number: nightly v3 21.08.2025
  • z/OS

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

No source file or test is named. Reproduce the API Catalog documentation issue and compare schema rendering for its OpenAPI 3.1 definition with services using OpenAPI 3.0 or Swagger 2.0. Done means the schemas in the bottom section display with the expected styles on z/OS.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, documentation
Issue type
Bug
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.