rubyapirestgrape-api

How to define array of hashes in Grape?


I'm using Ember as my front-end and Grape API to serve my API.

The front-end send something like:

{
  "service"=>{
    "name"=>"Name",
    "duration"=>"30",
    "user"=>nil,
    "organization"=>"org",
    "category"=>nil,
    "description"=>"description",
    "disabled"=>true,
    "color"=>nil,
    "availabilities"=>[
      {
        "day"=>"Saturday",
        "enabled"=>false,
        "timeSlots"=>[
          {
            "startAt"=>"09:00 AM",
            "endAt"=>"05:00 PM"
          }
        ]
      },
      {
        "day"=>"Sunday",
        "enabled"=>false,
        "timeSlots"=>[
          {
            "startAt"=>"09:00 AM",
            "endAt"=>"05:00 PM"
          }
        ]
      },
      {
        "day"=>"Monday",
        "enabled"=>true,
        "timeSlots"=>[
          {
            "startAt"=>"09:00 AM",
            "endAt"=>"05:00 PM"
          },
          {
            "startAt"=>"05:00 AM",
            "endAt"=>"09:00 PM"
          },
          {
            "startAt"=>"05:00 AM",
            "endAt"=>"09:00 PM"
          }
        ]
      },
      {
        "day"=>"Tuesday",
        "enabled"=>true,
        "timeSlots"=>[
          {
            "startAt"=>"09:00 AM",
            "endAt"=>"05:00 PM"
          }
        ]
      },
      {
        "day"=>"Wednesday",
        "enabled"=>true,
        "timeSlots"=>[
          {
            "startAt"=>"09:00 AM",
            "endAt"=>"05:00 PM"
          }
        ]
      },
      {
        "day"=>"Thursday",
        "enabled"=>true,
        "timeSlots"=>[
          {
            "startAt"=>"09:00 AM",
            "endAt"=>"05:00 PM"
          }
        ]
      },
      {
        "day"=>"Friday",
        "enabled"=>true,
        "timeSlots"=>[
          {
            "startAt"=>"09:00 AM",
            "endAt"=>"05:00 PM"
          }
        ]
      }
    ]
  }
}

And I'm struggling to implement Grape api interface to receive the payload, I ended up with something like:

  resource :services do
    params do
      requires :service, type: Hash do
        requires :name, type: String
        requires :organization, type: String
        requires :duration, type: Integer
        requires :category, type: String
        optional :color, type: String
        optional :description, type: String
        optional :disabled, type: Boolean
        requires :availabilities, type: Array do
          requires :day, type: String
          optional :enabled, type: Boolean
          optional :timeSlots, type: Array do
            requires :startAt, type: Time
            requires :endtAt, type: Time
          end
        end
      end
    end
    post do
      puts params
    end
  end

But with no luck as I'm getting the following error:

ERROR -- service[availabilities][0][timeSlots][0][endtAt] is missing

Solution

  • You can try to use "group" to indicate the type of your array elements.

    Example (updated):

    params do
      group :services, type: Array, desc: "An array of services" do
        requires :name, type: String
        requires :organization, type: String
        requires :duration, type: Integer
        ...
      end
    end
    put '/test' do
      s = []
      params[:services].each do |service|
        s << service
      end
      return s
    end