Giter Club home page Giter Club logo

Comments (6)

ldnunes avatar ldnunes commented on September 16, 2024

@bennettl : It's on the README. Have a look:

https://github.com/richhollis/swagger-docs#drying-up-common-documentation

from swagger-docs.

richhollis avatar richhollis commented on September 16, 2024

Hi Bennett

If you want to add a header and I've read the spec correctly then in theory you should be able to use the regular param with :header type (not tested):

swagger_api :index do
param :header, :some_header, :integer, :optional, "Some header"
end

Let me know if this works.

from swagger-docs.

bennettl avatar bennettl commented on September 16, 2024

I want to populate the header with a default value, but this doesn't seem to work:

param :header, :some_header, :integer, :optional, "Some header", "Default Value"

from swagger-docs.

richhollis avatar richhollis commented on September 16, 2024

What about this (untested):

param :header, :some_header, :integer, :optional, "Some header", {"defaultValue" => "some default"}

from swagger-docs.

richhollis avatar richhollis commented on September 16, 2024

@bennettl Did that work?

from swagger-docs.

bennettl avatar bennettl commented on September 16, 2024

Yes that did the trick. Thank you so much!

from swagger-docs.

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.