{"action":"created","issue":{"url":"https://api.github.com/repos/json-schema/json-schema/issues/104","labels_url":"https://api.github.com/repos/json-schema/json-schema/issues/104/labels{/name}","comments_url":"https://api.github.com/repos/json-schema/json-schema/issues/104/comments","events_url":"https://api.github.com/repos/json-schema/json-schema/issues/104/events","html_url":"https://github.com/json-schema/json-schema/issues/104","id":18737244,"number":104,"title":"suggestion: `example` keywords","user":{"login":"geemus","id":4138,"avatar_url":"https://avatars.githubusercontent.com/u/4138?v=3","gravatar_id":"","url":"https://api.github.com/users/geemus","html_url":"https://github.com/geemus","followers_url":"https://api.github.com/users/geemus/followers","following_url":"https://api.github.com/users/geemus/following{/other_user}","gists_url":"https://api.github.com/users/geemus/gists{/gist_id}","starred_url":"https://api.github.com/users/geemus/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/geemus/subscriptions","organizations_url":"https://api.github.com/users/geemus/orgs","repos_url":"https://api.github.com/users/geemus/repos","events_url":"https://api.github.com/users/geemus/events{/privacy}","received_events_url":"https://api.github.com/users/geemus/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":12,"created_at":"2013-08-29T15:21:05Z","updated_at":"2015-12-14T19:49:45Z","closed_at":null,"body":"It can be very useful/informative to include an `example` value along with given attributes. I've been using it and have found it pretty helpful (especially when generating documentation from the schema)."},"comment":{"url":"https://api.github.com/repos/json-schema/json-schema/issues/comments/164540199","html_url":"https://github.com/json-schema/json-schema/issues/104#issuecomment-164540199","issue_url":"https://api.github.com/repos/json-schema/json-schema/issues/104","id":164540199,"user":{"login":"howardroark","id":292642,"avatar_url":"https://avatars.githubusercontent.com/u/292642?v=3","gravatar_id":"","url":"https://api.github.com/users/howardroark","html_url":"https://github.com/howardroark","followers_url":"https://api.github.com/users/howardroark/followers","following_url":"https://api.github.com/users/howardroark/following{/other_user}","gists_url":"https://api.github.com/users/howardroark/gists{/gist_id}","starred_url":"https://api.github.com/users/howardroark/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/howardroark/subscriptions","organizations_url":"https://api.github.com/users/howardroark/orgs","repos_url":"https://api.github.com/users/howardroark/repos","events_url":"https://api.github.com/users/howardroark/events{/privacy}","received_events_url":"https://api.github.com/users/howardroark/received_events","type":"User","site_admin":false},"created_at":"2015-12-14T19:49:45Z","updated_at":"2015-12-14T19:49:45Z","body":"@geemus 100% agree.  It is just a very human way to communicate context, as we can infer so much from a good example.  I wouldn't look at it in terms of what a machine will do with the value, but more so someone looking to learn about the application through the schema.  As you said It would be really handy for generating a good human centric documentation example.  \r\n\r\nDesigners, developers and strategists alike can benefit from that.  I plan to incorporate \"example\" into my schema design and then use it to output a designer friendly visualization of the schema in a sort of reference doc.  That way the entire team can reference those docs and always be on the same page about the data available to work with in the app.  If a strategist can look at the schema and decide if their direction can be accomplished without changing data, you can really help out the process.  Plus, it puts the schema front and centre and exposes it to more conversation, be it pragmatic or philosophical. \r\n\r\nI'd love to see it as an official part of the schema :)\r\n\r\n"}}