Comments (6)
Hi @matoous, yes, but it needs a little more work before it's ready. The idea will be to allow users to select whether they want to use "tag" descriptions or "info" as the "index" page for categories. See #100 for details.
from docusaurus-openapi-docs.
@sserrata just gave it a try, exactly what we were looking for! Awesome, thanks a lot 🙏
from docusaurus-openapi-docs.
🎉 Thanks for opening your first issue here! Welcome to the community!
from docusaurus-openapi-docs.
Thanks for the FR @matoous! We can certainly take a look to see if this is possible and would definitely appreciate a contribution.
from docusaurus-openapi-docs.
@sserrata I see this new commit made it's way to main
: e17c515, is it related to this?
from docusaurus-openapi-docs.
Hi @matoous, the changes have been merged and can be tested using canary release 0.0.0-355. Be sure to also upgrade the theme.
Please see the README.md
for usage or just adapt this example:
petstore: {
specPath: "examples/petstore.yaml",
outputDir: "api/petstore",
sidebarOptions: {
groupPathsBy: "tags",
categoryLinkSource: "tag",
},
},
Interested in your feedback on the end result and usage. Thanks!
from docusaurus-openapi-docs.
Related Issues (20)
- Missing information in the API key value in the Authorization header in all the sample codes HOT 2
- Response example summary is broken in v3 HOT 4
- Fenced code blocks started with `~~~` are incorrectly cleaned in v3 HOT 2
- Huge swagger.json file is not being processed HOT 4
- Example & externalDocs attributes not displaying
- Custom item naming and path generation HOT 1
- Show description of 'oneOf' schema items HOT 4
- oneOf creates strange-looking schema
- Ignore unknown vendor extensions HOT 5
- oneOf at root of schema generates empty <SchemaTabs> resulting in <Tabs> error HOT 3
- Autogenerated docs sidebar shows the api spec item when it shouldn't HOT 1
- What are the variables in api.mustache template? HOT 4
- Schema $ref fails to combine allOf and properties for nested properties HOT 1
- Unable to install with rush/pnpm due to upstream dependency bug HOT 5
- Header parameter into code example HOT 2
- Incorrect rendering when referencing data from schema HOT 2
- Strip markdown syntax from frontmatter
- The sample code is wrong when using in query parameters with a list of values HOT 1
- Unclear whether the plugin CLI is required or optional HOT 1
- Can't resolve '@theme/Unlisted' after update to Docusaurus 3.5.0 HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docusaurus-openapi-docs.