Giter Club home page Giter Club logo

Comments (3)

qvfh83 avatar qvfh83 commented on June 15, 2024 1

Not to increase scope too much, but adding a minimum/maximum (with inclusive/exclusive boundary) for numerical values would also be useful. Some other properties at https://swagger.io/docs/specification/data-models/data-types/#range) may be good to consider.

from oatpp-swagger.

Inujel avatar Inujel commented on June 15, 2024 1

Adding the possibility to document minimum and maximum values would be really interesting.

The range is currently included in the OpenAPI json and is displayed by some tools. The default value does not look great:
image

from oatpp-swagger.

lganzzzo avatar lganzzzo commented on June 15, 2024

Hey @yeefan ,

  • To add examples for an endpoint - see the description in this PR - #36
  • Default values - are auto documented based on the default values set in the DTO
    class MyDto {
      ...
      DTO_FIELD(String, myField) = "default value"; // <---the default value will be documented
    };

The Required property is a good point. We should think about how to add it

from oatpp-swagger.

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.