How do I create a title for the apipie-rails gem?
I need to create an API with apipie-rails, but I want to create documentation for headers like this "X-User-Email" or "X-User-Token".
I have a description of this resource:
resource_description do
short 'Cars'
formats ['json']
param 'X-User-Email <X-User-Email>', String, :desc => "HEADER param: Email must correspond to TOKEN owner", :required => false
param 'X-User-Token <X-User-Token>', String, :desc => "HEADER param: Token must correspond to EMAIL owner", :required => false
error :code => 401, :desc => "Unauthorized - Returned when authentication can't be achieved via login or missing/expired api token"
end
But the argument param
doesn't help me in this case.
Is it possible?
+3
source to share