Sha256: ccaf2b7c4fe666efb42c330f4525456cbdfc89dc71bb5e5db7409f3247f3386a

Contents?: true

Size: 1.81 KB

Versions: 19

Compression:

Stored size: 1.81 KB

Contents

<%

api_title = "Positive Case - 3 - should register and reuse an existing registration & device information"

api_input = <<-eos
Example:

POST #{request.base_url}/api/v1/register
{
  "country_id": "1",
  "city_id": "2",
  "dialing_prefix": "+91",
  "mobile_number": "<ALREADY REGISTERED MOBILE NUMBER>",
  "uuid": "<ALREADY REGISTERED UUID>",
  "device_token": "<ALREADY REGISTERED TOKEN>",
  "device_name": "Apple iPhone",
  "device_type": "iPhone 7 Plus",
  "operating_system": "iOS",
  "software_version": "iOS 11.2.2"
}
eos

api_output = <<-eos
{
  "success": true,
  "alert": {
    "heading": "An OTP has been sent to you",
    "message": "Check your mobile for new message from us."
  },
  "data": {
    "registration": {
      "id": 5,
      "user_id": null,
      "country_id": 1,
      "city_id": null,
      "dialing_prefix": "+91",
      "mobile_number": "501370321",
      "status": "verified"
    },
    "device": {
      "id": 6,
      "user_id": null,
      "registration_id": 5,
      "uuid": "jh01u2g01h301h21h232",
      "device_token": "0182y3b28107b31",
      "device_name": "Apple iPhone",
      "device_type": "iPhone 7 Plus",
      "operating_system": "iOS",
      "software_version": "iOS 11.2.2",
      "api_token": "257720f0d84c233d49b2490b240e0b10",
      "status": "verified",
      "otp_verified_at": null
    }
  },
  "errors": {
    "heading": null,
    "message": null,
    "details": {}
  }
}
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

19 entries across 19 versions & 1 rubygems

Version Path
usman-0.3.19 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.18 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.17 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.16 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.15 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.14 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.13 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.12 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.11 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.10 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.9 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.8 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.7 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.6 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.5 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.4 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.3 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.2 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb
usman-0.3.1 app/views/usman/api/v1/docs/register/_pos_case_3.html.erb