Document POST body example

[wulftone]

After a bunch of experimentation, I figured out that you can use a POJO as a POST body, but I couldn't find it anywhere in the documentation. e.g. You can do

public interface Boop {
    @RequestLine("POST /boop/{someParam}")
    @Headers({
        "Accept: application/json",
        "Content-Type: application/json"
    })
    BoopResponse createBoopUsingPOST(Boop boop, @Param("someParam") String someParam);

    class Boop {
        public String value;
    }
}

But the tricky part is that the POJO param (boop, in the example), must come first in the parameter list of the method. That was difficult to find out!

[kdavisk6]

@wulftone

Thanks for this example. It is missing from the documentation. You can define the body of the request two ways:

• annotating the parameter with @Body
• the first method parameter without an annotation is assumed to be the Body

We should update the documentation to explain this and add you example.

[eiselems]

@wulftone @kdavisk6 is this like you had it in mind?

[wulftone]

Pretty much, I commented on the pr: #986 (comment)

[eiselems]

@wulftone is it really failing for you when you put the boop parameter in any other position?
I updated the github-example in the repository and it seems to work in all positions.

[wulftone]

Yes, let me verify exactly why and get back to you... It is interesting that you found it doesn't matter in the example

[sleroy]

Indeed I lost 10 minutes to find an Example. Could not guess it easily from the readme...

[eiselems]

@sleroy hoped the example would be sufficient

  @RequestLine("POST /repos/{owner}/{repo}/issues")
  void createIssue(Issue issue, @Param("owner") String owner, @Param("repo") String repo);

How should we improve it?