Custom headers responses

[PanosCodes]

Why

To define custom response headers #706

How

Extend the Apipie::ResponseDescription::ResponseObject with a header method

Example

api :GET, "/pets/:id/with-extra-details", "Get a detailed pet record"
returns code: 200, desc: "Detailed info about the pet" do
  param_group :pet
  property :num_legs, Integer, :desc => "How many legs the pet has"
  header 'Link', String, 'Relative links'
  header 'Current-Page', Integer, 'The current page', required: true
end

def show
  render JSON({ :pet_name => "Barkie", :animal_type => "iguana", :legs => 4 })
end

[davidwessman]

Is there anyway to use array_of: DescriptionObject that uses the https://github.com/Apipie/apipie-rails?tab=readme-ov-file#embedded-response-descriptions inside the returns block?

[PanosCodes]

You can delete this line 😅

apipie-rails/lib/apipie/dsl_definition.rb

Line 436 in f300fcc

raise "cannot specify both block and param_group"

.

I'm not sure why it exists, there are no failing tests if it's removed 🤔

[davidwessman]

You can delete this line 😅

apipie-rails/lib/apipie/dsl_definition.rb

Line 436 in f300fcc

raise "cannot specify both block and param_group"

.
I'm not sure why it exists, there are no failing tests if it's removed 🤔

Hehe, that would be nice!

[davidwessman]

I like it! 🚀

[davidwessman]

@mathieujobin Any chance to get this merged?

[mathieujobin]

Sorry for the delay here

[davidwessman]

No worries, thank you!