How to specify default json value in swagger php documentation?

Question

I want to specify a default json value in swagger docs for POST. I am getting T_CLOSE_PARENTHESIS error. I have also tried escaping the ".

/**
     * @SWG\Api(path="/api/users",
     *   @SWG\Operation(
     *     method="POST",
     *     summary="Register a user",
     *     notes="Send a POST request along with required form parameters to add a new user",
     *     type="string",
     *     nickname="post-users",
     *     authorizations={},
     *     @SWG\Parameter(
     *       name="email",
     *       description="The email",
     *       required=true,
     *       type="json",
     *       paramType="body",
     *       allowMultiple=false,
     *       defaultValue = "{
  "email":"pradeep****@gmail.com",
  "first_name":"Pradeep",
  "last_name":"Kumar",
  "group":"subscriber",
  "password":"password"
}",
     *     ),
     *     
     *     @SWG\ResponseMessage(code=200,message="Success"),
     *     @SWG\ResponseMessage(code=400,message="Bad Request")
     *   )
     * )
     */

Sweet mother of god.

Jimbo
– Jimbo

2015-03-25 16:37:02 +00:00
Commented Mar 25, 2015 at 16:37 — Jimbo
– Jimbo, Commented Mar 25, 2015 at 16:37

Bob Fanger · Accepted Answer · 2015-04-17 09:46:04Z

12

To escape a " in a doctrine/annotation use ""

defaultValue="{""email"":""p****@gmail.com"",""first_name"":""Pradeep""}"

answered Apr 17, 2015 at 9:46

Bob Fanger

30k7 gold badges68 silver badges83 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Matthijs Over a year ago

Perfect, just the answer I was looking for, this should be the accepted answer!

fehguy · Accepted Answer · 2014-12-27 21:06:31Z

1

I'm guessing you should convert the defaultValue into a single line, and escape the quotes with a forward slash.

answered Dec 27, 2014 at 21:06

fehguy

6,82427 silver badges23 bronze badges

3 Comments

prady00 Over a year ago

Fehguy, I have tried it and also mentioned in my question.

prady00 Over a year ago

I have done this - defaultValue = "{\"email\":\"pradeep****@gmail.com\",\"first_name\":\"Pradeep\",\"last_name\":\"Kumar\",\"group\":\"subscriber\",\"password\":\"password\"}"

fehguy Over a year ago

Hi, I think you'll need to open an issue in the swagger-php repository: github.com/zircote/swagger-php

Collectives™ on Stack Overflow

How to specify default json value in swagger php documentation?

2 Answers 2

1 Comment

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related