Comments (6)
@DavidBiesack we have this "Models" feature in progress. We never implemented it as we display models inline but we had some requests like yours to be able to link to models externally.
We're working on it. ETA is hopefully ~4-5 weeks from now depending on the situation.
from developer-portal-starter.
@adamaltman I think we actually already resolved this issue, as upgrading to the later versions of the developer portal that included the updates to use Reference Docs 2.x did the trick for us. Now everything is working as it should. ππ»π
from developer-portal-starter.
@DavidBiesack The schemas are shown for responses, as well as for request bodies, as long as they are defined in the API reference doc. I believe this should also be the case for schemas/models that are linked using an external ref.
It looks like on the example, the Models section is created by defining it in the sidebars.yaml
with links to the tags in the openapi.yaml
.
Also, please bear in mind you are commenting on a closed issue, not to mention current events happening in Ukraine (where much of the Redocly team is based), so the Redocly folks may not respond here, or at least not right away.
πΊπ¦ β€οΈ #standwithukraine
from developer-portal-starter.
@AX-LLaidley happy to walk you through this. We do have support for polymorphism. Reach out to team at redocly dot com.
from developer-portal-starter.
Is there a demo or other example of this? https://redocly.github.io/redoc/ does not render a "Schemas" or "Models" section when I try it. Perhaps that is just the open source redoc tool, not the dev portal commercial product? I looked at some of the redoc.ly customer sites and don't see sections for Models. I'm considering redocly but it's crucial that I can link to anchors for the models -- we cite/link to the models that reside inside our API reference doc from other documents.
from developer-portal-starter.
ukraine heart #standwithukraine
Thank you @AX-LLaidley !
This component can be used to display schemas on pages: https://redoc.ly/docs/developer-portal/components/json-schema/
from developer-portal-starter.
Related Issues (20)
- How to access nested nav items? HOT 3
- Feature Request - Add CSS classes for styling HOT 8
- Components in nav allowed?
- OpenApiTryIt component shows "Incorrect definitionId" error HOT 5
- Unable to use UI components (OpenApiCodeSample) when using LandingLayout page template in .mdx file HOT 2
- How to access route changes? HOT 1
- Default logout functionality appends [object, object] to the end of the url causing 404 page on logout HOT 1
- bug: uninformative error messages
- Incorrect error messages: existing files "Could not find" HOT 5
- Cannot find module '@redocly/ui' HOT 5
- i18n HOT 1
- `yarn start` throws error on `\node_modules\yoga-layout-prebuilt\yoga-layout\build\Release\nbind.js:53` HOT 1
- Feature Request: Customize toc HOT 2
- Error parsing assets folder: Unexpected token < in JSON HOT 3
- The build command fails with zero information on errors HOT 1
- creating running via dockerfile HOT 1
- Can we add more syntax highlighting options? HOT 3
- Doubt remove first page HOT 2
- Doubt change nav gradient color theme HOT 1
- Deploying developer-portal-starter to Redocly HOT 5
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 developer-portal-starter.