Sha256: affc743d202b77f2a2057f60617f4e2a1c73b770803bdcc2b377ce3eac50d427

Contents?: true

Size: 1.7 KB

Versions: 45

Compression:

Stored size: 1.7 KB

Contents

<%

api_title = "Positive Case - 3 - should set proper errors if the inputs are not correct"

api_input = <<-eos
Example:

Authorization: Token token="87b01adbba90824b57add8cc06ad8738"
PUT #{request.base_url}/api/v1/update_profile
{
  "name": "Name",
  "gender": "male",
  "date_of_birth": "10/10/1980",
  "email": "name@domain.com",
  "country_id": "1",
  "city_id": "2",
  "image": "<Uploaded File - Not Support. e.g: CSV>"
}

It update the user/profile entry in the system and will return its data including the user_id (also called profile_id)
Since the uploaded image is not of supported type, it is ignored and the profile data is updated.
eos

api_output = <<-eos
{
  "success": true,
  "alert": {
    "heading": "The Profile has been updated successfully",
    "message": "You may access the profile API with API token to get the profile details in future"
  },
  "errors": {
    "heading": "Saving user/profile image was failed",
    "message": "Make sure that the arguments are passed according to the API documentation. Please check the API Documentation for more details."
  },
  "data": {
    "id": 9,
    "name": "Nayan Tara",
    "gender": "female",
    "date_of_birth": "1984-10-27",
    "username": "d0dca578",
    "email": "nayan.tara@yopmail.com",
    "phone": null,
    "profile_picture": ""
  }
}
eos

%>

<%= render partial: "kuppayam/api/docs/example", locals: {
                                        negative_case: false,
                                        example_id: "pos_case_3",
                                        api_title: api_title,
                                        api_input: api_input,
                                        api_output: api_output 
                                      } %>

Version data entries

45 entries across 45 versions & 1 rubygems

Version Path
usman-0.4.10.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.9.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.8.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.7.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.6.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.5.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.4.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.3.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.2.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.1.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.4.0.pre.materialize app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.3.38 app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.3.37 app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.3.36 app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.3.35 app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.3.34 app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.3.33 app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.3.32 app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.3.31 app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb
usman-0.3.30 app/views/usman/api/v1/docs/update_profile/_pos_case_3.html.erb