{"action":"created","comment":{"url":"https://api.github.com/repos/refractproject/rfcs/pulls/comments/36735537","id":36735537,"diff_hunk":"@@ -0,0 +1,59 @@\n+- Start Date: 2015-08-10\n+- RFC PR: (leave this empty)\n+- Refract Issue: (leave this empty)\n+\n+# Summary\n+Clarify API description namespace and Iron out issues which rose during API Blueprint serialization to API description namespace.\n+\n+# Motivation\n+The purpose of this document is to clear inconsistencies in the format and make it easier to build tools around it.\n+\n+# Detailed design\n+\n+## HREF Variables\n+We need to clarify about the value of the `content` in the `hrefVariables` element.\n+\n+## Data Structure\n+We don't need a `Data Structure` because an element which is an `object`, `extend` or `array` can be considered as a data structure element.\n+\n+*(The current spec is a lot confusing. What is the `Data Structure Element`? Why is `Data Structure` inheriting from it?)*\n+\n+## Resource\n+Since `hrefVariables` is an element, we should move it to be under `content` rather than leave it under `attributes`.\n+\n+## Transition\n+Similarily to the Resource, we need to move `hrefVariables` to be under `content`. `Data Structure` in Resource is under `content`, but it is under `attributes` in Transition. To resolve this inconsistency, we need to move `Data Structure` to be under `content`. Another reason for it is that `Data Structure` is an element.\n+\n+## Transition Example\n+Value of `content` should be changed to `[]` instead of `null`.\n+\n+## Category\n+We need to clarify what `transitions` category is about. If it is being reserved for future use, we need to add reserved keyword.\n+\n+## Copy\n+We need to clarify what the relation between copy elements in `content` and `description` in `attributes` is. Is `description` just an aggregator of all `copy` elements? Why does some examples contain `description` without any `copy` elements and some examples contain `copy` elements but doesn't contain `description`. Since `copy` element is superior, why do we need `description` if we can use `copy` elements everywhere?\n+\n+## HTTP Transaction Example\n+Value of `content` should be changed to `[]` instead of `null`.\n+\n+## HTTP Headers\n+We need to change the base type from `Array Type` to `Element`. We also need to correct the `content` to be an `array[Member Element]`.","path":"text/0000-clarify-api-namespace.md","position":40,"original_position":40,"commit_id":"a1ec1343359a23f77fe24e2304581df54b362503","original_commit_id":"a1ec1343359a23f77fe24e2304581df54b362503","user":{"login":"pksunkara","id":174703,"avatar_url":"https://avatars.githubusercontent.com/u/174703?v=3","gravatar_id":"","url":"https://api.github.com/users/pksunkara","html_url":"https://github.com/pksunkara","followers_url":"https://api.github.com/users/pksunkara/followers","following_url":"https://api.github.com/users/pksunkara/following{/other_user}","gists_url":"https://api.github.com/users/pksunkara/gists{/gist_id}","starred_url":"https://api.github.com/users/pksunkara/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pksunkara/subscriptions","organizations_url":"https://api.github.com/users/pksunkara/orgs","repos_url":"https://api.github.com/users/pksunkara/repos","events_url":"https://api.github.com/users/pksunkara/events{/privacy}","received_events_url":"https://api.github.com/users/pksunkara/received_events","type":"User","site_admin":false},"body":"Sorry, I got confused. `Array Type` is okay with me. But we really do need to change the description of `content`. Maybe make it similar to how `HREF Variables` was defined.","created_at":"2015-08-11T11:39:37Z","updated_at":"2015-08-11T11:39:37Z","html_url":"https://github.com/refractproject/rfcs/pull/10#discussion_r36735537","pull_request_url":"https://api.github.com/repos/refractproject/rfcs/pulls/10","_links":{"self":{"href":"https://api.github.com/repos/refractproject/rfcs/pulls/comments/36735537"},"html":{"href":"https://github.com/refractproject/rfcs/pull/10#discussion_r36735537"},"pull_request":{"href":"https://api.github.com/repos/refractproject/rfcs/pulls/10"}}},"pull_request":{"url":"https://api.github.com/repos/refractproject/rfcs/pulls/10","id":42098549,"html_url":"https://github.com/refractproject/rfcs/pull/10","diff_url":"https://github.com/refractproject/rfcs/pull/10.diff","patch_url":"https://github.com/refractproject/rfcs/pull/10.patch","issue_url":"https://api.github.com/repos/refractproject/rfcs/issues/10","number":10,"state":"open","locked":false,"title":"Add RFC about API namespace clarification","user":{"login":"pksunkara","id":174703,"avatar_url":"https://avatars.githubusercontent.com/u/174703?v=3","gravatar_id":"","url":"https://api.github.com/users/pksunkara","html_url":"https://github.com/pksunkara","followers_url":"https://api.github.com/users/pksunkara/followers","following_url":"https://api.github.com/users/pksunkara/following{/other_user}","gists_url":"https://api.github.com/users/pksunkara/gists{/gist_id}","starred_url":"https://api.github.com/users/pksunkara/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pksunkara/subscriptions","organizations_url":"https://api.github.com/users/pksunkara/orgs","repos_url":"https://api.github.com/users/pksunkara/repos","events_url":"https://api.github.com/users/pksunkara/events{/privacy}","received_events_url":"https://api.github.com/users/pksunkara/received_events","type":"User","site_admin":false},"body":"These are the issues and inconsistencies I found while working on API Blueprint to Refract conversion.","created_at":"2015-08-11T07:05:09Z","updated_at":"2015-08-11T11:39:37Z","closed_at":null,"merged_at":null,"merge_commit_sha":"7e10ea32041d758fb4a053cee25b0e2d98bc9b0a","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/refractproject/rfcs/pulls/10/commits","review_comments_url":"https://api.github.com/repos/refractproject/rfcs/pulls/10/comments","review_comment_url":"https://api.github.com/repos/refractproject/rfcs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/refractproject/rfcs/issues/10/comments","statuses_url":"https://api.github.com/repos/refractproject/rfcs/statuses/a1ec1343359a23f77fe24e2304581df54b362503","head":{"label":"refractproject:pksunkara/api-desc","ref":"pksunkara/api-desc","sha":"a1ec1343359a23f77fe24e2304581df54b362503","user":{"login":"refractproject","id":10877387,"avatar_url":"https://avatars.githubusercontent.com/u/10877387?v=3","gravatar_id":"","url":"https://api.github.com/users/refractproject","html_url":"https://github.com/refractproject","followers_url":"https://api.github.com/users/refractproject/followers","following_url":"https://api.github.com/users/refractproject/following{/other_user}","gists_url":"https://api.github.com/users/refractproject/gists{/gist_id}","starred_url":"https://api.github.com/users/refractproject/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/refractproject/subscriptions","organizations_url":"https://api.github.com/users/refractproject/orgs","repos_url":"https://api.github.com/users/refractproject/repos","events_url":"https://api.github.com/users/refractproject/events{/privacy}","received_events_url":"https://api.github.com/users/refractproject/received_events","type":"Organization","site_admin":false},"repo":{"id":37661759,"name":"rfcs","full_name":"refractproject/rfcs","owner":{"login":"refractproject","id":10877387,"avatar_url":"https://avatars.githubusercontent.com/u/10877387?v=3","gravatar_id":"","url":"https://api.github.com/users/refractproject","html_url":"https://github.com/refractproject","followers_url":"https://api.github.com/users/refractproject/followers","following_url":"https://api.github.com/users/refractproject/following{/other_user}","gists_url":"https://api.github.com/users/refractproject/gists{/gist_id}","starred_url":"https://api.github.com/users/refractproject/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/refractproject/subscriptions","organizations_url":"https://api.github.com/users/refractproject/orgs","repos_url":"https://api.github.com/users/refractproject/repos","events_url":"https://api.github.com/users/refractproject/events{/privacy}","received_events_url":"https://api.github.com/users/refractproject/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/refractproject/rfcs","description":"RFCs for Changes to Refract and Refract Namespaces","fork":false,"url":"https://api.github.com/repos/refractproject/rfcs","forks_url":"https://api.github.com/repos/refractproject/rfcs/forks","keys_url":"https://api.github.com/repos/refractproject/rfcs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/refractproject/rfcs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/refractproject/rfcs/teams","hooks_url":"https://api.github.com/repos/refractproject/rfcs/hooks","issue_events_url":"https://api.github.com/repos/refractproject/rfcs/issues/events{/number}","events_url":"https://api.github.com/repos/refractproject/rfcs/events","assignees_url":"https://api.github.com/repos/refractproject/rfcs/assignees{/user}","branches_url":"https://api.github.com/repos/refractproject/rfcs/branches{/branch}","tags_url":"https://api.github.com/repos/refractproject/rfcs/tags","blobs_url":"https://api.github.com/repos/refractproject/rfcs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/refractproject/rfcs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/refractproject/rfcs/git/refs{/sha}","trees_url":"https://api.github.com/repos/refractproject/rfcs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/refractproject/rfcs/statuses/{sha}","languages_url":"https://api.github.com/repos/refractproject/rfcs/languages","stargazers_url":"https://api.github.com/repos/refractproject/rfcs/stargazers","contributors_url":"https://api.github.com/repos/refractproject/rfcs/contributors","subscribers_url":"https://api.github.com/repos/refractproject/rfcs/subscribers","subscription_url":"https://api.github.com/repos/refractproject/rfcs/subscription","commits_url":"https://api.github.com/repos/refractproject/rfcs/commits{/sha}","git_commits_url":"https://api.github.com/repos/refractproject/rfcs/git/commits{/sha}","comments_url":"https://api.github.com/repos/refractproject/rfcs/comments{/number}","issue_comment_url":"https://api.github.com/repos/refractproject/rfcs/issues/comments{/number}","contents_url":"https://api.github.com/repos/refractproject/rfcs/contents/{+path}","compare_url":"https://api.github.com/repos/refractproject/rfcs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/refractproject/rfcs/merges","archive_url":"https://api.github.com/repos/refractproject/rfcs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/refractproject/rfcs/downloads","issues_url":"https://api.github.com/repos/refractproject/rfcs/issues{/number}","pulls_url":"https://api.github.com/repos/refractproject/rfcs/pulls{/number}","milestones_url":"https://api.github.com/repos/refractproject/rfcs/milestones{/number}","notifications_url":"https://api.github.com/repos/refractproject/rfcs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/refractproject/rfcs/labels{/name}","releases_url":"https://api.github.com/repos/refractproject/rfcs/releases{/id}","created_at":"2015-06-18T13:41:44Z","updated_at":"2015-06-18T13:41:44Z","pushed_at":"2015-08-11T07:05:09Z","git_url":"git://github.com/refractproject/rfcs.git","ssh_url":"git@github.com:refractproject/rfcs.git","clone_url":"https://github.com/refractproject/rfcs.git","svn_url":"https://github.com/refractproject/rfcs","homepage":null,"size":209,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":1,"forks":1,"open_issues":1,"watchers":0,"default_branch":"master"}},"base":{"label":"refractproject:master","ref":"master","sha":"e37ec2fb04363f4bf4a033d1f5878dbfbd492f91","user":{"login":"refractproject","id":10877387,"avatar_url":"https://avatars.githubusercontent.com/u/10877387?v=3","gravatar_id":"","url":"https://api.github.com/users/refractproject","html_url":"https://github.com/refractproject","followers_url":"https://api.github.com/users/refractproject/followers","following_url":"https://api.github.com/users/refractproject/following{/other_user}","gists_url":"https://api.github.com/users/refractproject/gists{/gist_id}","starred_url":"https://api.github.com/users/refractproject/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/refractproject/subscriptions","organizations_url":"https://api.github.com/users/refractproject/orgs","repos_url":"https://api.github.com/users/refractproject/repos","events_url":"https://api.github.com/users/refractproject/events{/privacy}","received_events_url":"https://api.github.com/users/refractproject/received_events","type":"Organization","site_admin":false},"repo":{"id":37661759,"name":"rfcs","full_name":"refractproject/rfcs","owner":{"login":"refractproject","id":10877387,"avatar_url":"https://avatars.githubusercontent.com/u/10877387?v=3","gravatar_id":"","url":"https://api.github.com/users/refractproject","html_url":"https://github.com/refractproject","followers_url":"https://api.github.com/users/refractproject/followers","following_url":"https://api.github.com/users/refractproject/following{/other_user}","gists_url":"https://api.github.com/users/refractproject/gists{/gist_id}","starred_url":"https://api.github.com/users/refractproject/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/refractproject/subscriptions","organizations_url":"https://api.github.com/users/refractproject/orgs","repos_url":"https://api.github.com/users/refractproject/repos","events_url":"https://api.github.com/users/refractproject/events{/privacy}","received_events_url":"https://api.github.com/users/refractproject/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/refractproject/rfcs","description":"RFCs for Changes to Refract and Refract Namespaces","fork":false,"url":"https://api.github.com/repos/refractproject/rfcs","forks_url":"https://api.github.com/repos/refractproject/rfcs/forks","keys_url":"https://api.github.com/repos/refractproject/rfcs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/refractproject/rfcs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/refractproject/rfcs/teams","hooks_url":"https://api.github.com/repos/refractproject/rfcs/hooks","issue_events_url":"https://api.github.com/repos/refractproject/rfcs/issues/events{/number}","events_url":"https://api.github.com/repos/refractproject/rfcs/events","assignees_url":"https://api.github.com/repos/refractproject/rfcs/assignees{/user}","branches_url":"https://api.github.com/repos/refractproject/rfcs/branches{/branch}","tags_url":"https://api.github.com/repos/refractproject/rfcs/tags","blobs_url":"https://api.github.com/repos/refractproject/rfcs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/refractproject/rfcs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/refractproject/rfcs/git/refs{/sha}","trees_url":"https://api.github.com/repos/refractproject/rfcs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/refractproject/rfcs/statuses/{sha}","languages_url":"https://api.github.com/repos/refractproject/rfcs/languages","stargazers_url":"https://api.github.com/repos/refractproject/rfcs/stargazers","contributors_url":"https://api.github.com/repos/refractproject/rfcs/contributors","subscribers_url":"https://api.github.com/repos/refractproject/rfcs/subscribers","subscription_url":"https://api.github.com/repos/refractproject/rfcs/subscription","commits_url":"https://api.github.com/repos/refractproject/rfcs/commits{/sha}","git_commits_url":"https://api.github.com/repos/refractproject/rfcs/git/commits{/sha}","comments_url":"https://api.github.com/repos/refractproject/rfcs/comments{/number}","issue_comment_url":"https://api.github.com/repos/refractproject/rfcs/issues/comments{/number}","contents_url":"https://api.github.com/repos/refractproject/rfcs/contents/{+path}","compare_url":"https://api.github.com/repos/refractproject/rfcs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/refractproject/rfcs/merges","archive_url":"https://api.github.com/repos/refractproject/rfcs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/refractproject/rfcs/downloads","issues_url":"https://api.github.com/repos/refractproject/rfcs/issues{/number}","pulls_url":"https://api.github.com/repos/refractproject/rfcs/pulls{/number}","milestones_url":"https://api.github.com/repos/refractproject/rfcs/milestones{/number}","notifications_url":"https://api.github.com/repos/refractproject/rfcs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/refractproject/rfcs/labels{/name}","releases_url":"https://api.github.com/repos/refractproject/rfcs/releases{/id}","created_at":"2015-06-18T13:41:44Z","updated_at":"2015-06-18T13:41:44Z","pushed_at":"2015-08-11T07:05:09Z","git_url":"git://github.com/refractproject/rfcs.git","ssh_url":"git@github.com:refractproject/rfcs.git","clone_url":"https://github.com/refractproject/rfcs.git","svn_url":"https://github.com/refractproject/rfcs","homepage":null,"size":209,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":1,"forks":1,"open_issues":1,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/refractproject/rfcs/pulls/10"},"html":{"href":"https://github.com/refractproject/rfcs/pull/10"},"issue":{"href":"https://api.github.com/repos/refractproject/rfcs/issues/10"},"comments":{"href":"https://api.github.com/repos/refractproject/rfcs/issues/10/comments"},"review_comments":{"href":"https://api.github.com/repos/refractproject/rfcs/pulls/10/comments"},"review_comment":{"href":"https://api.github.com/repos/refractproject/rfcs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/refractproject/rfcs/pulls/10/commits"},"statuses":{"href":"https://api.github.com/repos/refractproject/rfcs/statuses/a1ec1343359a23f77fe24e2304581df54b362503"}}}}