Redocly/redoc

Possibility to add menu items to external sites

Open

#181 ouverte le 11 janv. 2017

Voir sur GitHub
 (5 commentaires) (4 réactions) (0 assignés)TypeScript (21 877 stars) (2 272 forks)batch import
Type: Enhancementhelp wanted

Description

Add the possibility to add menu items that points to external sites from swagger extensions or in javascript to the redoc object.

Should support nested menus.

Guide contributeur

Stack technique
typescriptreactrest api
Domaine
frontenddocumentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
React knowledgeTypeScript knowledgeRedoc architectureOpenAPI extensions
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30
Direction de recherche
Investigate how Redoc currently renders menu items from the OpenAPI spec (likely in src/components/SideMenu or similar). Review comments in the issue for proposed designs. Consider implementing support for an OpenAPI extension (e.g., x external menu) or a JavaScript config object that defines external links with nested structure. Ensure nested menus are supported by modifying the menu data structure.