Giter VIP home page Giter VIP logo

Comments (6)

RomanHotsiy avatar RomanHotsiy commented on August 26, 2024 2

@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.

AX-LLaidley avatar AX-LLaidley commented on August 26, 2024 1

@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.

AX-LLaidley avatar AX-LLaidley commented on August 26, 2024 1

@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.

adamaltman avatar adamaltman commented on August 26, 2024

@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.

DavidBiesack avatar DavidBiesack commented on August 26, 2024

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.

adamaltman avatar adamaltman commented on August 26, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.