swagger-api/swagger-ui

OpenAPI 3.1.0 support: add support for expandable OpenAPI.webhooks grouped by tags

Open

#8490 opened on Mar 20, 2023

View on GitHub
 (7 comments) (1 reaction) (0 assignees)JavaScript (25,447 stars) (8,801 forks)batch import
Good first issuetype: enhancementversion: 5.x

Description

The goal of this issue is to add support for expandable OpenAPI.webhooks grouped by tags. Basically the same as we currently do for OpenAPI.paths.

image

Contributor guide

Tech stack
javascriptreactrest api
Domain
apidocumentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Swagger UI codebaseJavaScriptReactOpenAPI specification
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review how OpenAPI.paths are currently displayed and grouped by tags in swagger ui. Look for the component that renders paths and adapt it for webhooks. Check for any existing webhooks support in the codebase. The issue comments may contain additional details.