{"action":"created","comment":{"url":"https://api.github.com/repos/jrperritt/rack/pulls/comments/32340933","id":32340933,"diff_hunk":"@@ -0,0 +1,56 @@\n+# Rack CLI Design Document\n+\n+This document will attempt to outline the design for the Rackspace Global Command Line Interface. It will not exhaustively define each interface; rather, it will focus on the philosophy and representative examples that should be used to inform the successive specifications for the specific service implementations.\n+\n+As such, there are 4 core tenets we're using to define the design, in order of priority:\n+\n+1. Correctness\n+2. Consistency\n+3. Completeness\n+4. Terseness\n+\n+## Correctness\n+\n+As a top level objective, the CLI must operate correctly. It's unacceptable to deliver a non-functional tool, nor one that behaves contrary to the documented expectations. The key here is to document the expected behavior, and then ensure that the delivered tool matches those expectations.\n+\n+## Consistency\n+\n+Our ambition for consistency is to provide a model that is used throughout the command line interface. All calls take the following format:\n+\n+```\n+rack <service> [--options] <model> <action> [--flags]","path":"design.md","position":21,"original_position":21,"commit_id":"eda198d0a208030ba4d646b5620d13d66b3c485a","original_commit_id":"6ff66472d39328481a16951fe32b0145ba5df8bc","user":{"login":"kenperkins","id":730664,"avatar_url":"https://avatars.githubusercontent.com/u/730664?v=3","gravatar_id":"","url":"https://api.github.com/users/kenperkins","html_url":"https://github.com/kenperkins","followers_url":"https://api.github.com/users/kenperkins/followers","following_url":"https://api.github.com/users/kenperkins/following{/other_user}","gists_url":"https://api.github.com/users/kenperkins/gists{/gist_id}","starred_url":"https://api.github.com/users/kenperkins/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kenperkins/subscriptions","organizations_url":"https://api.github.com/users/kenperkins/orgs","repos_url":"https://api.github.com/users/kenperkins/repos","events_url":"https://api.github.com/users/kenperkins/events{/privacy}","received_events_url":"https://api.github.com/users/kenperkins/received_events","type":"User","site_admin":false},"body":"Thanks for the clarification.","created_at":"2015-06-12T18:20:14Z","updated_at":"2015-06-12T18:20:14Z","html_url":"https://github.com/jrperritt/rack/pull/43#discussion_r32340933","pull_request_url":"https://api.github.com/repos/jrperritt/rack/pulls/43","_links":{"self":{"href":"https://api.github.com/repos/jrperritt/rack/pulls/comments/32340933"},"html":{"href":"https://github.com/jrperritt/rack/pull/43#discussion_r32340933"},"pull_request":{"href":"https://api.github.com/repos/jrperritt/rack/pulls/43"}}},"pull_request":{"url":"https://api.github.com/repos/jrperritt/rack/pulls/43","id":37585217,"html_url":"https://github.com/jrperritt/rack/pull/43","diff_url":"https://github.com/jrperritt/rack/pull/43.diff","patch_url":"https://github.com/jrperritt/rack/pull/43.patch","issue_url":"https://api.github.com/repos/jrperritt/rack/issues/43","number":43,"state":"open","locked":false,"title":"[WIP] Design Document & Philosophy for rack","user":{"login":"kenperkins","id":730664,"avatar_url":"https://avatars.githubusercontent.com/u/730664?v=3","gravatar_id":"","url":"https://api.github.com/users/kenperkins","html_url":"https://github.com/kenperkins","followers_url":"https://api.github.com/users/kenperkins/followers","following_url":"https://api.github.com/users/kenperkins/following{/other_user}","gists_url":"https://api.github.com/users/kenperkins/gists{/gist_id}","starred_url":"https://api.github.com/users/kenperkins/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kenperkins/subscriptions","organizations_url":"https://api.github.com/users/kenperkins/orgs","repos_url":"https://api.github.com/users/kenperkins/repos","events_url":"https://api.github.com/users/kenperkins/events{/privacy}","received_events_url":"https://api.github.com/users/kenperkins/received_events","type":"User","site_admin":false},"body":"This is a work in progress to define the philosophy based on @jrperritt's start in #17. This further expands on the language, and provides some representative examples on interpretation.\r\n\r\nI'd love for this to be collaborative and not prescriptive. \r\n\r\nFeedback requested!\r\n\r\n","created_at":"2015-06-12T17:17:04Z","updated_at":"2015-06-12T18:20:14Z","closed_at":null,"merged_at":null,"merge_commit_sha":"78a2fbcf736b729f78c2ddcf79f9675e5ed6e4ae","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/jrperritt/rack/pulls/43/commits","review_comments_url":"https://api.github.com/repos/jrperritt/rack/pulls/43/comments","review_comment_url":"https://api.github.com/repos/jrperritt/rack/pulls/comments{/number}","comments_url":"https://api.github.com/repos/jrperritt/rack/issues/43/comments","statuses_url":"https://api.github.com/repos/jrperritt/rack/statuses/eda198d0a208030ba4d646b5620d13d66b3c485a","head":{"label":"kenperkins:design","ref":"design","sha":"eda198d0a208030ba4d646b5620d13d66b3c485a","user":{"login":"kenperkins","id":730664,"avatar_url":"https://avatars.githubusercontent.com/u/730664?v=3","gravatar_id":"","url":"https://api.github.com/users/kenperkins","html_url":"https://github.com/kenperkins","followers_url":"https://api.github.com/users/kenperkins/followers","following_url":"https://api.github.com/users/kenperkins/following{/other_user}","gists_url":"https://api.github.com/users/kenperkins/gists{/gist_id}","starred_url":"https://api.github.com/users/kenperkins/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kenperkins/subscriptions","organizations_url":"https://api.github.com/users/kenperkins/orgs","repos_url":"https://api.github.com/users/kenperkins/repos","events_url":"https://api.github.com/users/kenperkins/events{/privacy}","received_events_url":"https://api.github.com/users/kenperkins/received_events","type":"User","site_admin":false},"repo":{"id":37224751,"name":"rack","full_name":"kenperkins/rack","owner":{"login":"kenperkins","id":730664,"avatar_url":"https://avatars.githubusercontent.com/u/730664?v=3","gravatar_id":"","url":"https://api.github.com/users/kenperkins","html_url":"https://github.com/kenperkins","followers_url":"https://api.github.com/users/kenperkins/followers","following_url":"https://api.github.com/users/kenperkins/following{/other_user}","gists_url":"https://api.github.com/users/kenperkins/gists{/gist_id}","starred_url":"https://api.github.com/users/kenperkins/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kenperkins/subscriptions","organizations_url":"https://api.github.com/users/kenperkins/orgs","repos_url":"https://api.github.com/users/kenperkins/repos","events_url":"https://api.github.com/users/kenperkins/events{/privacy}","received_events_url":"https://api.github.com/users/kenperkins/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/kenperkins/rack","description":"A CLI for OpenStack-based clouds using Gophercloud","fork":true,"url":"https://api.github.com/repos/kenperkins/rack","forks_url":"https://api.github.com/repos/kenperkins/rack/forks","keys_url":"https://api.github.com/repos/kenperkins/rack/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kenperkins/rack/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kenperkins/rack/teams","hooks_url":"https://api.github.com/repos/kenperkins/rack/hooks","issue_events_url":"https://api.github.com/repos/kenperkins/rack/issues/events{/number}","events_url":"https://api.github.com/repos/kenperkins/rack/events","assignees_url":"https://api.github.com/repos/kenperkins/rack/assignees{/user}","branches_url":"https://api.github.com/repos/kenperkins/rack/branches{/branch}","tags_url":"https://api.github.com/repos/kenperkins/rack/tags","blobs_url":"https://api.github.com/repos/kenperkins/rack/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kenperkins/rack/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kenperkins/rack/git/refs{/sha}","trees_url":"https://api.github.com/repos/kenperkins/rack/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kenperkins/rack/statuses/{sha}","languages_url":"https://api.github.com/repos/kenperkins/rack/languages","stargazers_url":"https://api.github.com/repos/kenperkins/rack/stargazers","contributors_url":"https://api.github.com/repos/kenperkins/rack/contributors","subscribers_url":"https://api.github.com/repos/kenperkins/rack/subscribers","subscription_url":"https://api.github.com/repos/kenperkins/rack/subscription","commits_url":"https://api.github.com/repos/kenperkins/rack/commits{/sha}","git_commits_url":"https://api.github.com/repos/kenperkins/rack/git/commits{/sha}","comments_url":"https://api.github.com/repos/kenperkins/rack/comments{/number}","issue_comment_url":"https://api.github.com/repos/kenperkins/rack/issues/comments{/number}","contents_url":"https://api.github.com/repos/kenperkins/rack/contents/{+path}","compare_url":"https://api.github.com/repos/kenperkins/rack/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kenperkins/rack/merges","archive_url":"https://api.github.com/repos/kenperkins/rack/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kenperkins/rack/downloads","issues_url":"https://api.github.com/repos/kenperkins/rack/issues{/number}","pulls_url":"https://api.github.com/repos/kenperkins/rack/pulls{/number}","milestones_url":"https://api.github.com/repos/kenperkins/rack/milestones{/number}","notifications_url":"https://api.github.com/repos/kenperkins/rack/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kenperkins/rack/labels{/name}","releases_url":"https://api.github.com/repos/kenperkins/rack/releases{/id}","created_at":"2015-06-10T21:55:44Z","updated_at":"2015-06-10T21:55:44Z","pushed_at":"2015-06-12T17:58:15Z","git_url":"git://github.com/kenperkins/rack.git","ssh_url":"git@github.com:kenperkins/rack.git","clone_url":"https://github.com/kenperkins/rack.git","svn_url":"https://github.com/kenperkins/rack","homepage":null,"size":178,"stargazers_count":0,"watchers_count":0,"language":"Go","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"jrperritt:master","ref":"master","sha":"cbec19fd0d1ab16a0e64945d8022cb3409c09dd2","user":{"login":"jrperritt","id":1733222,"avatar_url":"https://avatars.githubusercontent.com/u/1733222?v=3","gravatar_id":"","url":"https://api.github.com/users/jrperritt","html_url":"https://github.com/jrperritt","followers_url":"https://api.github.com/users/jrperritt/followers","following_url":"https://api.github.com/users/jrperritt/following{/other_user}","gists_url":"https://api.github.com/users/jrperritt/gists{/gist_id}","starred_url":"https://api.github.com/users/jrperritt/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jrperritt/subscriptions","organizations_url":"https://api.github.com/users/jrperritt/orgs","repos_url":"https://api.github.com/users/jrperritt/repos","events_url":"https://api.github.com/users/jrperritt/events{/privacy}","received_events_url":"https://api.github.com/users/jrperritt/received_events","type":"User","site_admin":false},"repo":{"id":33959631,"name":"rack","full_name":"jrperritt/rack","owner":{"login":"jrperritt","id":1733222,"avatar_url":"https://avatars.githubusercontent.com/u/1733222?v=3","gravatar_id":"","url":"https://api.github.com/users/jrperritt","html_url":"https://github.com/jrperritt","followers_url":"https://api.github.com/users/jrperritt/followers","following_url":"https://api.github.com/users/jrperritt/following{/other_user}","gists_url":"https://api.github.com/users/jrperritt/gists{/gist_id}","starred_url":"https://api.github.com/users/jrperritt/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jrperritt/subscriptions","organizations_url":"https://api.github.com/users/jrperritt/orgs","repos_url":"https://api.github.com/users/jrperritt/repos","events_url":"https://api.github.com/users/jrperritt/events{/privacy}","received_events_url":"https://api.github.com/users/jrperritt/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/jrperritt/rack","description":"A CLI for OpenStack-based clouds using Gophercloud","fork":false,"url":"https://api.github.com/repos/jrperritt/rack","forks_url":"https://api.github.com/repos/jrperritt/rack/forks","keys_url":"https://api.github.com/repos/jrperritt/rack/keys{/key_id}","collaborators_url":"https://api.github.com/repos/jrperritt/rack/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/jrperritt/rack/teams","hooks_url":"https://api.github.com/repos/jrperritt/rack/hooks","issue_events_url":"https://api.github.com/repos/jrperritt/rack/issues/events{/number}","events_url":"https://api.github.com/repos/jrperritt/rack/events","assignees_url":"https://api.github.com/repos/jrperritt/rack/assignees{/user}","branches_url":"https://api.github.com/repos/jrperritt/rack/branches{/branch}","tags_url":"https://api.github.com/repos/jrperritt/rack/tags","blobs_url":"https://api.github.com/repos/jrperritt/rack/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/jrperritt/rack/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/jrperritt/rack/git/refs{/sha}","trees_url":"https://api.github.com/repos/jrperritt/rack/git/trees{/sha}","statuses_url":"https://api.github.com/repos/jrperritt/rack/statuses/{sha}","languages_url":"https://api.github.com/repos/jrperritt/rack/languages","stargazers_url":"https://api.github.com/repos/jrperritt/rack/stargazers","contributors_url":"https://api.github.com/repos/jrperritt/rack/contributors","subscribers_url":"https://api.github.com/repos/jrperritt/rack/subscribers","subscription_url":"https://api.github.com/repos/jrperritt/rack/subscription","commits_url":"https://api.github.com/repos/jrperritt/rack/commits{/sha}","git_commits_url":"https://api.github.com/repos/jrperritt/rack/git/commits{/sha}","comments_url":"https://api.github.com/repos/jrperritt/rack/comments{/number}","issue_comment_url":"https://api.github.com/repos/jrperritt/rack/issues/comments{/number}","contents_url":"https://api.github.com/repos/jrperritt/rack/contents/{+path}","compare_url":"https://api.github.com/repos/jrperritt/rack/compare/{base}...{head}","merges_url":"https://api.github.com/repos/jrperritt/rack/merges","archive_url":"https://api.github.com/repos/jrperritt/rack/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/jrperritt/rack/downloads","issues_url":"https://api.github.com/repos/jrperritt/rack/issues{/number}","pulls_url":"https://api.github.com/repos/jrperritt/rack/pulls{/number}","milestones_url":"https://api.github.com/repos/jrperritt/rack/milestones{/number}","notifications_url":"https://api.github.com/repos/jrperritt/rack/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/jrperritt/rack/labels{/name}","releases_url":"https://api.github.com/repos/jrperritt/rack/releases{/id}","created_at":"2015-04-14T22:08:59Z","updated_at":"2015-06-12T00:22:01Z","pushed_at":"2015-06-12T17:58:16Z","git_url":"git://github.com/jrperritt/rack.git","ssh_url":"git@github.com:jrperritt/rack.git","clone_url":"https://github.com/jrperritt/rack.git","svn_url":"https://github.com/jrperritt/rack","homepage":null,"size":727,"stargazers_count":4,"watchers_count":4,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"open_issues_count":22,"forks":3,"open_issues":22,"watchers":4,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/jrperritt/rack/pulls/43"},"html":{"href":"https://github.com/jrperritt/rack/pull/43"},"issue":{"href":"https://api.github.com/repos/jrperritt/rack/issues/43"},"comments":{"href":"https://api.github.com/repos/jrperritt/rack/issues/43/comments"},"review_comments":{"href":"https://api.github.com/repos/jrperritt/rack/pulls/43/comments"},"review_comment":{"href":"https://api.github.com/repos/jrperritt/rack/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/jrperritt/rack/pulls/43/commits"},"statuses":{"href":"https://api.github.com/repos/jrperritt/rack/statuses/eda198d0a208030ba4d646b5620d13d66b3c485a"}}}}