Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Experimental ] Add sidebarOptions with groupByTags support #53

Closed
wants to merge 12 commits into from

Conversation

sserrata
Copy link
Member

Description

This PR introduces the concept of sidebarOptions to the docusaurus-plugin-openapi plugin. The intent is that sidebarOptions can be used when greater flexibility is required when generating sidebars for OpenAPI docs. For example, with sidebarOptions, you can generate a sidebar.js slice with paths grouped by tag, which is a common use case in our environment.

Example usage:

[
  "@paloaltonetworks/docusaurus-plugin-openapi",
  {
    id: "petstore",
    path: "examples/petstore.json",
    outputDir: "api/petstore",
    sidebarOptions: { 
        groupPathsBy:  "tags" ,
        // sidebarCollapsible: true,  // Optional
        // sidebarCollapsed: true,  // Optional
    }
  },
],

Motivation and Context

Autogenerated sidebars doesn't have the ability to group OAS paths which limits our ability to organize large API specifications for easier reading.

How Has This Been Tested?

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@sserrata sserrata added enhancement New feature or request DO NOT MERGE labels Apr 19, 2022
@github-actions
Copy link

github-actions bot commented Apr 19, 2022

Size Change: -437 kB (-19%) 👏

Total Size: 1.88 MB

Filename Size Change
demo/.docusaurus/globalData.json 3.28 kB -4.85 kB (-60%) 🏆
demo/build/assets/css/styles.********.css 83.9 kB -2.12 kB (-2%)
demo/build/assets/js/0de0d9d3.********.js 0 B -11.4 kB (removed) 🏆
demo/build/assets/js/0e384e19.********.js 4.54 kB +2.15 kB (+90%) 🆘
demo/build/assets/js/0f5373df.********.js 0 B -9.78 kB (removed) 🏆
demo/build/assets/js/11cd04f0.********.js 0 B -15.8 kB (removed) 🏆
demo/build/assets/js/18927b64.********.js 0 B -20 kB (removed) 🏆
demo/build/assets/js/18c41134.********.js 16.9 kB +2.15 kB (+15%) ⚠️
demo/build/assets/js/1e4232ab.********.js 5.59 kB +2.15 kB (+62%) 🆘
demo/build/assets/js/1f41b3da.********.js 1.07 kB -8.49 kB (-89%) 🏆
demo/build/assets/js/2695.********.js 0 B -1.02 kB (removed) 🏆
demo/build/assets/js/3372.********.js 0 B -11.5 kB (removed) 🏆
demo/build/assets/js/393be207.********.js 3.07 kB +2.15 kB (+233%) 🆘
demo/build/assets/js/42c7b392.********.js 0 B -17.8 kB (removed) 🏆
demo/build/assets/js/4685.********.js 0 B -1.1 MB (removed) 🏆
demo/build/assets/js/46a8ec8c.********.js 0 B -20.4 kB (removed) 🏆
demo/build/assets/js/477c195c.********.js 0 B -4.75 kB (removed) 🏆
demo/build/assets/js/4a47cb6d.********.js 0 B -1.36 kB (removed) 🏆
demo/build/assets/js/4c9d5d90.********.js 0 B -19.5 kB (removed) 🏆
demo/build/assets/js/4e8c00d7.********.js 0 B -9.79 kB (removed) 🏆
demo/build/assets/js/533a09ca.********.js 4.94 kB +2.15 kB (+77%) 🆘
demo/build/assets/js/5456.********.js 0 B -10 kB (removed) 🏆
demo/build/assets/js/5c2e4ff8.********.js 0 B -17 kB (removed) 🏆
demo/build/assets/js/5c868d36.********.js 5.67 kB +2.15 kB (+61%) 🆘
demo/build/assets/js/6ab70d68.********.js 0 B -10.2 kB (removed) 🏆
demo/build/assets/js/6d9cbd66.********.js 0 B -20.6 kB (removed) 🏆
demo/build/assets/js/7608cde2.********.js 3.32 kB +2.15 kB (+185%) 🆘
demo/build/assets/js/8084356f.********.js 0 B -11 kB (removed) 🏆
demo/build/assets/js/822bd8ab.********.js 5.34 kB +2.15 kB (+67%) 🆘
demo/build/assets/js/846aa161.********.js 0 B -17.6 kB (removed) 🏆
demo/build/assets/js/888b62d9.********.js 3.55 kB +2.06 kB (+139%) 🆘
demo/build/assets/js/9719473f.********.js 3.32 kB +2.15 kB (+185%) 🆘
demo/build/assets/js/a9d8a64b.********.js 0 B -2.36 kB (removed) 🏆
demo/build/assets/js/b0e6d8b9.********.js 0 B -2.32 kB (removed) 🏆
demo/build/assets/js/bd766368.********.js 0 B -9.49 kB (removed) 🏆
demo/build/assets/js/c3d13055.********.js 0 B -8.63 kB (removed) 🏆
demo/build/assets/js/cc12b702.********.js 0 B -376 B (removed) 🏆
demo/build/assets/js/ce11f325.********.js 0 B -10.9 kB (removed) 🏆
demo/build/assets/js/common.********.js 0 B -125 kB (removed) 🏆
demo/build/assets/js/d03381af.********.js 0 B -22.2 kB (removed) 🏆
demo/build/assets/js/da717792.********.js 0 B -16.4 kB (removed) 🏆
demo/build/assets/js/dc10a35a.********.js 0 B -16.5 kB (removed) 🏆
demo/build/assets/js/dde745ce.********.js 0 B -15.2 kB (removed) 🏆
demo/build/assets/js/dff1c289.********.js 6.34 kB +2.15 kB (+51%) 🆘
demo/build/assets/js/e1362e6d.********.js 0 B -1.42 kB (removed) 🏆
demo/build/assets/js/e44a2883.********.js 7.6 kB +2.15 kB (+39%) 🚨
demo/build/assets/js/f55d3e7a.********.js 5.16 kB +2.15 kB (+71%) 🆘
demo/build/assets/js/main.********.js 376 kB -13.6 kB (-4%)
demo/build/assets/js/runtime~main.********.js 4.86 kB -1.39 kB (-22%) 🎉
demo/build/assets/js/372.********.js 11.5 kB +11.5 kB (new file) 🆕
demo/build/assets/js/611.********.js 12.2 kB +12.2 kB (new file) 🆕
demo/build/assets/js/685.********.js 1.1 MB +1.1 MB (new file) 🆕
demo/build/assets/js/695.********.js 1.02 kB +1.02 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
demo/build/assets/js/03d773ca.********.js 553 B +21 B (+4%)
demo/build/assets/js/14eb3368.********.js 8 kB -1 B (0%)
demo/build/assets/js/17896441.********.js 1.55 kB -1 B (0%)
demo/build/assets/js/1be78505.********.js 10.8 kB -2 B (0%)
demo/build/assets/js/1f391b9e.********.js 2.6 kB -2 B (0%)
demo/build/assets/js/4c5e977b.********.js 36.7 kB -1 B (0%)
demo/build/assets/js/935f2afb.********.js 3.54 kB 0 B
demo/build/assets/js/9e4087bc.********.js 1.61 kB -1 B (0%)
demo/build/assets/js/b2f554cd.********.js 120 B -1 B (-1%)
demo/build/assets/js/c4f5d8e4.********.js 72.3 kB -1 B (0%)
demo/build/index.html 72.6 kB 0 B

compressed-size-action

@github-actions
Copy link

github-actions bot commented Apr 19, 2022

Visit the preview URL for this PR (updated for commit b3f743d):

https://docusaurus-openapi-36b86--pr53-vxmqumwq.web.app

(expires Fri, 20 May 2022 00:04:07 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata sserrata closed this Apr 21, 2022
@sserrata sserrata deleted the add-sidebar-options branch April 29, 2022 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DO NOT MERGE enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants