Re: how to override datatype of a queryparam

2016-11-18 Thread Mikko Koivunalho
I have the same problem. 1) I need @ApiImplicitParam to replace the default definition of a @QueryParam annotation. 2) I need to use @ApiImplicitParam to define another data type. @QueryParam sees a string, I need a JSON (string), i.e. a link to model. I believe it would not be very difficult to

Replace a @{Query/Path/Body}Param with a @ApiImplicitParam

2016-11-18 Thread Mikko Koivunalho
I think we should have an extra field in @ApiImplicitParam annotation to tell Swagger which parameter - if any - it should replace. Example: @ApiOperation(value = "Test pet as json string in query", response = Pet.class) @GET @Path("/test") @Produces("application/json") @ApiImplicitParams({

@ApiImplicitParam to replace a @QueryParam

2016-11-18 Thread Mikko Koivunalho
The @ApiImplicitParam annotation does not replace the definition done by @QueryParam (Jersey). I am thinking, could we program this? Example: @ApiImplicitParam(name="JSONquery", replace = "query") Complete example: @GET @ApiImplicitParam(name = "query", value = "A query in the form of JSON s

Re: Use Swagger UI as only a documentation tool

2016-11-18 Thread tony tam
Try opening up the browser console and sharing the error message that you get. > On Nov 18, 2016, at 6:29 AM, Jasmine wrote: > > More info: I am using Swagger 2.0. I tested out the format of the JSON in the > Swagger Editor and it displayed correctly, however the same JSON caused a > CORS erro

Re: How to define string-encoded JSON objects passed as parameters to POST apis?

2016-11-18 Thread tony tam
For now, that’s not a limitation of the tool but the spec. For the 3.0 specification, support for this has been / is being added. Not much longer now… > On Nov 18, 2016, at 6:25 AM, Scott Schafer wrote: > > We have APIs that take multiple parameters, some of which are string-encoded > JSON o

Re: Use Swagger UI as only a documentation tool

2016-11-18 Thread Jasmine
More info: I am using Swagger 2.0. I tested out the format of the JSON in the Swagger Editor and it displayed correctly, however the same JSON caused a CORS error with Swagger UI, so I believe it is not a format issue. I know swagger doesn't support web sockets, but I just want to use the nice

Use Swagger UI as only a documentation tool

2016-11-18 Thread Jasmine
I would like to use swagger UI for documenting my websockets. However, I get a "Can't read from server. It may not have the appropriate access-control-origin settings." error when loading. I used the same format in my JSON as I did for my rest api, which worked fine. If I don't care about the t

How to define string-encoded JSON objects passed as parameters to POST apis?

2016-11-18 Thread Scott Schafer
We have APIs that take multiple parameters, some of which are string-encoded JSON objects that are passed in the form data. I've had to resort to writing descriptions like: "string-encoded map of field names to booleans, example: {status: true, selectedProposal: true, notes: true, oppDataEnt