Skip to content

Filter out empty API groups (or Tags) #4307

@erajkovic

Description

@erajkovic

Is there a way to filter content - empty API groups (or Tags) - when displaying content of a Swagger API document with Swagger UI 3 similar to what was done in Swagger UI 2

Q A
Bug or feature request? Not sure if this is a feature request or a support question
Which Swagger/OpenAPI version? Swagger 2.0
Which Swagger-UI version? Swagger UI 3.9.1
How did you install Swagger-UI? using the webjar project
Which browser & version? Chrome 64.0.3282.186
Which operating system? Mac OS-X 10.13.3

Demonstration API definition

Is there a way to filter out the empty APIs groups in Swagger UI 3, the same way it was done on the older version?

see the data we have now, with nothing to drill-down into

Calculate Shipping | Webhook for calculating shipping cost
External Pricing | This event is triggered at ‘add to cart’ page requesting validation of external pricing details for products with external prices
External Tax Calculation | This event is triggered at checkout page to get tax for cart from external service
...

Test links:
https://apicatalog.oraclecloud.com/ui/views/swaggerui3/oracle-public/commerce/17.4/webhooks?urls.primaryName=Webhooks
vs.
https://apicatalog.oraclecloud.com/ui/views/apicollection/oracle-public/commerce/17.4/webhooks

Expected Behavior

By default, it would be nice to hide empty content, so that we can focus on the part of the APIs that does have content.
An alternative option would be to add a configuration parameter if you like seeing empty content for some other use case.

Current Behavior

List all the Tags, even when they have no associated content.

Possible Solution

Context

Trying to migrate our API Catalog from using Swagger 2.0 to the latest version of OpenApi 3.0 / Swagger UI 3.x

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions