Restler icon indicating copy to clipboard operation
Restler copied to clipboard

@example not showing up in the Explorer

Open igorsantos07 opened this issue 9 years ago • 4 comments

I might have misunderstood what's said in the docs regarding @example, but it's not showing up in the Explorer anywhere. Shouldn't it be a "default" value for the sample format?

@param string $timestamp {@from body} Date in the ISO-8601 format {@example "2016-02-05T02:01:00-02:00"} screenshot_614

igorsantos07 avatar Feb 05 '16 14:02 igorsantos07

@example is not integrated with Explorer. The model you see is auto generated by Swagger

In the previous version swagger was not doing that and we could support @example

Arul- avatar Feb 06 '16 03:02 Arul-

Hmmm I can understand that. Maybe there could be a note in the docs stating @example was deprecated. On 6 Feb 2016 01:02, "Arul" [email protected] wrote:

@example is not integrated with Explorer. The model you see is auto generated by Swagger

In the previous version swagger was not doing that and we could support @example

— Reply to this email directly or view it on GitHub https://github.com/Luracast/Restler/issues/525#issuecomment-180664071.

igorsantos07 avatar Feb 07 '16 09:02 igorsantos07

Maybe there could be a note in the docs stating @example was deprecated.

We won't do that as Explorer is not final. We want to target swagger 2+ first ( There is a branch that attempts that)

Arul- avatar Feb 07 '16 09:02 Arul-

It makes sense, indeed. What about leaving the issue open, so it can easily be revisited later when the code is final?

igorsantos07 avatar Feb 12 '16 04:02 igorsantos07