feat: implement x-tagGroup feature#737
Conversation
|
Visit the preview URL for this PR (updated for commit 54399a2): https://docusaurus-openapi-36b86--pr737-q2pj4lr5.web.app (expires Thu, 11 Apr 2024 14:46:57 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
|
Hi @bencagri, looks like there are a few linter errors and some new merge conflicts. Let me know if I can assist with resolving these issues, thanks! |
2fc327a to
5290ec3
Compare
|
hi @sserrata, conflicts were resolved and also linter errors fixed. |
|
@bencagri, any plans/thoughts on supporting generated category index pages, similar to how non-x-tag-groups are handled? |
hi Steven, actually this should be document writer's choice -from my point of view-. The generator should act as proof of concept, not to generate the docs that are not given. if you think this is a must, then to provide such a feature, we might generate docs under something uncategorized even if category has not been configured. But again, this wouldn't be a part of its job. What is your thought? |
|
Makes sense to me. I was speaking more about the tag groups that are generated, i.e. whether or not you think they should link to index pages when they are clicked. |
|
hmm. i missed this point. correct, i dont think we should provide index pages, as they are already a category, no? |
|
Sorry, it took me a minute to remember the name of the option: docs: https://docusaurus-openapi.tryingpan.dev/#sidebaroptions reference: |
|
hi @sserrata, i think we should point that |
* impement redoc's x-tagGroup feature * merge main * update documentation * fix filtered tags by group * remove tracked .idea files * add option to readme * merge main * fix lint * revert yarn.lock and linter
* feat: implement x-tagGroup feature (#737) * impement redoc's x-tagGroup feature * merge main * update documentation * fix filtered tags by group * remove tracked .idea files * add option to readme * merge main * fix lint * revert yarn.lock and linter * cleanup missing types, dup imports and add restaurant example * fix: Guard only undefined and empty strings (#725) * Conditional display of header Request (#719) Co-authored-by: Christian A. Mathiesen <christian@zaveit.no> * update lock file * feat: Implement schema pages behind a config option `showSchemas` (#736) * feat: Implement schema pages behind a config option `showSchemas` * Add `showSchemas` to petstore demo * address linter errors * enable schemas for petstore * update lock file * add missing heading import * address linter errors --------- Co-authored-by: Çağrı S <bencagri@users.noreply.github.com> Co-authored-by: Florian Garcia <garcia.florian.perso@gmail.com> Co-authored-by: chranmat <cam@mathix.net> Co-authored-by: Christian A. Mathiesen <christian@zaveit.no> Co-authored-by: Marc L <littlemarc2020@gmail.com>
|
@sserrata it shows introduction in every dropdown/tagGroup and contains same info please have a look the become active all when clicking on any one |
Description
Docusaurus should support nested sidebar which already implemented in ReDocly as x-tagGroups.
Motivation and Context
Most of the complex Apis need nested resources in one openapi spec. This feature aims to solve this problem within one resource instead of having multiple openapi resources.
How Has This Been Tested?
jest tests added for valid openapi files.
Screenshots (if appropriate)
Types of changes
Checklist