{"action":"created","issue":{"url":"https://api.github.com/repos/json-api/json-api/issues/602","labels_url":"https://api.github.com/repos/json-api/json-api/issues/602/labels{/name}","comments_url":"https://api.github.com/repos/json-api/json-api/issues/602/comments","events_url":"https://api.github.com/repos/json-api/json-api/issues/602/events","html_url":"https://github.com/json-api/json-api/issues/602","id":74447119,"number":602,"title":"Defining Future Query Parameters","user":{"login":"ethanresnick","id":471894,"avatar_url":"https://avatars.githubusercontent.com/u/471894?v=3","gravatar_id":"","url":"https://api.github.com/users/ethanresnick","html_url":"https://github.com/ethanresnick","followers_url":"https://api.github.com/users/ethanresnick/followers","following_url":"https://api.github.com/users/ethanresnick/following{/other_user}","gists_url":"https://api.github.com/users/ethanresnick/gists{/gist_id}","starred_url":"https://api.github.com/users/ethanresnick/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ethanresnick/subscriptions","organizations_url":"https://api.github.com/users/ethanresnick/orgs","repos_url":"https://api.github.com/users/ethanresnick/repos","events_url":"https://api.github.com/users/ethanresnick/events{/privacy}","received_events_url":"https://api.github.com/users/ethanresnick/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/json-api/json-api/milestones/1","html_url":"https://github.com/json-api/json-api/milestones/1.0","labels_url":"https://api.github.com/repos/json-api/json-api/milestones/1/labels","id":597996,"number":1,"title":"1.0","description":"The first stable release of JSON API.","creator":{"login":"steveklabnik","id":27786,"avatar_url":"https://avatars.githubusercontent.com/u/27786?v=3","gravatar_id":"","url":"https://api.github.com/users/steveklabnik","html_url":"https://github.com/steveklabnik","followers_url":"https://api.github.com/users/steveklabnik/followers","following_url":"https://api.github.com/users/steveklabnik/following{/other_user}","gists_url":"https://api.github.com/users/steveklabnik/gists{/gist_id}","starred_url":"https://api.github.com/users/steveklabnik/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/steveklabnik/subscriptions","organizations_url":"https://api.github.com/users/steveklabnik/orgs","repos_url":"https://api.github.com/users/steveklabnik/repos","events_url":"https://api.github.com/users/steveklabnik/events{/privacy}","received_events_url":"https://api.github.com/users/steveklabnik/received_events","type":"User","site_admin":false},"open_issues":16,"closed_issues":43,"state":"open","created_at":"2014-03-14T17:28:46Z","updated_at":"2015-05-18T11:28:37Z","due_on":"2015-05-21T07:00:00Z","closed_at":null},"comments":2,"created_at":"2015-05-08T18:11:17Z","updated_at":"2015-05-18T11:29:20Z","closed_at":null,"body":"If the spec wants to assign special semantics to additional query parameters down the line, that will be impossible if JSON-API APIs are already using these parameters in different ways. Therefore, I propose either:\r\n\r\n1. Adding a list of query parameters to the spec that compliant APIs can’t use in their urls. Off the top of my head, that list—which I figure we should make pretty greedy—might include: `embed`, `match`, `version`, `search`, `action`, `links`, `signature`, `access`, `docs`,`profile`, `profiles` … anything else?\r\n\r\n2. <a name=\"prefix-option\"></a> Or, an alternate solution would be to have the user prefix any of _their_ query parameters (i.e. any they’re using that aren’t defined by the spec). This has a couple things going for it:\r\n  1. We can add any query parameter we want down the line, as long as it doesn’t start with the prefix character (which is fine, since we want to avoid prefixing spec keywords anyway)\r\n  2. It makes visible in the url which query parameters are standard and which are non-standard.\r\n\r\n  But maybe a downside is it makes the URLs of compliant APIs somewhat uglier (since the user parameters are prefixed)?\r\n\r\nThoughts?\r\n\r\n(As an aside: Extensibility questions like the above are what I was trying to raise, with @hhware, in #588. But I think our discussion was somewhat off topic there and perhaps unappreciated, so I apologize. Hopefully now we can discuss extensibility in proper, separate issues. I think this question of how to prepare the spec for the future is important, and while it’s something that the spec authors (@dgeb, @tkellen, @steveklabnik et al) may have discussed in private, it hasn’t basn’t been discussed explicitly on github much.)"},"comment":{"url":"https://api.github.com/repos/json-api/json-api/issues/comments/103024501","html_url":"https://github.com/json-api/json-api/issues/602#issuecomment-103024501","issue_url":"https://api.github.com/repos/json-api/json-api/issues/602","id":103024501,"user":{"login":"tkellen","id":1004324,"avatar_url":"https://avatars.githubusercontent.com/u/1004324?v=3","gravatar_id":"","url":"https://api.github.com/users/tkellen","html_url":"https://github.com/tkellen","followers_url":"https://api.github.com/users/tkellen/followers","following_url":"https://api.github.com/users/tkellen/following{/other_user}","gists_url":"https://api.github.com/users/tkellen/gists{/gist_id}","starred_url":"https://api.github.com/users/tkellen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tkellen/subscriptions","organizations_url":"https://api.github.com/users/tkellen/orgs","repos_url":"https://api.github.com/users/tkellen/repos","events_url":"https://api.github.com/users/tkellen/events{/privacy}","received_events_url":"https://api.github.com/users/tkellen/received_events","type":"User","site_admin":false},"created_at":"2015-05-18T11:29:20Z","updated_at":"2015-05-18T11:29:20Z","body":"Just a heads up: I flagged this for review before Thursday."}}