Giter VIP home page Giter VIP logo

Comments (4)

LasneF avatar LasneF commented on September 24, 2024

this can be see as a corner case as the description 'The id of the user' is a description for the schema UserID
not for the parameter user_id
the parameter can have a different description
https://spec.openapis.org/oas/latest.html#fixed-fields-9

however looking on how redocly display such description, if both are defined it display the one of the parameter only , otherwise it is displaying the one of the schema

from vacuum.

stevenh avatar stevenh commented on September 24, 2024

Yer looks like an edge case, but definitely think it would be good to use the schema description if not overridden to avoid replicating strings unnecessarily, as duplicate strings also trigger lint warnings.

from vacuum.

daveshanley avatar daveshanley commented on September 24, 2024

This is accurate, the schema has a description, however the parameter does not. The parameter and the schema are two different entities and both need accurate descriptions. different parameters may re-use the same schema, but with different contexts, hence the need for descriptions on both.

from vacuum.

stevenh avatar stevenh commented on September 24, 2024

While they could require different descriptions, I would suggest its very common for them to not, hence resulting in unnecessary duplicates. Would it make sense to provide an option to allow fall though to avoid this?

from vacuum.

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.