search

Luracast / Restler

Simple and effective multi-format Web API Server to host your PHP API as Pragmatic REST and/or RESTful API
http://luracast.com/products/restler/
GNU Lesser General Public License v2.1
1.36k stars 316 forks source link

@example not showing up in the Explorer #525

Open igorsantos07 opened 8 years ago

igorsantos07 commented 8 years ago

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

Arul- commented 8 years ago

@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

igorsantos07 commented 8 years ago

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" notifications@github.com 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.

Arul- commented 8 years ago

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)

igorsantos07 commented 8 years ago

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