Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@example not showing up in the Explorer #525

Open
igorsantos07 opened this issue Feb 5, 2016 · 4 comments
Open

@example not showing up in the Explorer #525

igorsantos07 opened this issue Feb 5, 2016 · 4 comments

Comments

@igorsantos07
Copy link

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-
Copy link
Member

Arul- commented Feb 6, 2016

@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- Arul- closed this as completed Feb 6, 2016
@igorsantos07
Copy link
Author

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
#525 (comment).

@Arul-
Copy link
Member

Arul- commented Feb 7, 2016

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
Copy link
Author

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

@Arul- Arul- reopened this Feb 12, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants