{"action":"created","comment":{"url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/comments/165739096","pull_request_review_id":93732275,"id":165739096,"diff_hunk":"@@ -2,85 +2,279 @@\n \n ## General Structure\n \n-GIBS-in-the-Cloud uses a common format for all inputs and outputs from Tasks consisting of a JSON object which holds all necessary information about the task execution and AWS environment. Tasks return objects identical in format to their input with the exception of a task-specific `\"payload\"` field. Tasks may also augment their execution metadata.\n+Cumulus uses a common format for all inputs and outputs from workflow steps consisting of a JSON object which holds all necessary information about the task execution and AWS environment. Tasks return objects identical in format to their input with the exception of a task-specific `\"payload\"` field. Tasks may also augment their execution metadata.\n \n-## Data Sources\n+## Input Format\n+\n+Below is the input format, annotated inline:\n+\n+    {\n+      \"cumulus_meta\": {          // External resources accessible to the Task. Tasks should generally \n+                                 // prefer to be passed resources explicitly in their configuration rather \n+                                 // than looking up paths here. The paths being present here, however allows \n+                                 // configuration to parameterize values that are not known until the stack \n+                                 // is created.  For instance, a configuration field have the value \n+                                 // \"{cumulus_meta.buckets.private}\", which instructs the Task to look up the \n+                                 // private bucket while allowing the Task to remain ignorant of what buckets \n+                                 // are available.\n+      \n+        \"stack\": \"<string>\",     // The name of the Task's CloudFormation Task, useful as a prefix\n+        \"buckets\": {             // Names of S3 buckets available to the app \n+          \"internal\": \"<string>\",   // The name of the bucket holding configuration and deployment data\n+          \"private\": \"<string>\",    // The name of the bucket which holds internal platform data\n+          \"protected\": \"<string>\",  // The name of the bucket which holds protected data\n+          \"public\": \"<string>\"      // The name of the bucket which holds data to be served publicly   \n+        },\n+        \"state_machine\": \"<string>\",    // (Step-Function only) The ARN of the state machine being run\n+        \"execution_name\": \"<string>\",   // (Step-Function only) The name of the execution being run\n+        \"workflow_name\": \"<string>\",    // (Step-Function only) The name of the workflow being run\n+        \"message_source\": \"<string>\",   // A string describing the source that caused ingest to start,\n+                                        // set to sfn, stdin or local\n+      },\n+      \"meta\": {                  // Metadata taken from the collection configuration and other configuration ","path":"docs/input_output.md","position":35,"original_position":35,"commit_id":"4b5fa0d4a00312527a927147b36336fa4ec3958f","original_commit_id":"4b5fa0d4a00312527a927147b36336fa4ec3958f","user":{"login":"jennyhliu","id":34660846,"avatar_url":"https://avatars2.githubusercontent.com/u/34660846?v=4","gravatar_id":"","url":"https://api.github.com/users/jennyhliu","html_url":"https://github.com/jennyhliu","followers_url":"https://api.github.com/users/jennyhliu/followers","following_url":"https://api.github.com/users/jennyhliu/following{/other_user}","gists_url":"https://api.github.com/users/jennyhliu/gists{/gist_id}","starred_url":"https://api.github.com/users/jennyhliu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jennyhliu/subscriptions","organizations_url":"https://api.github.com/users/jennyhliu/orgs","repos_url":"https://api.github.com/users/jennyhliu/repos","events_url":"https://api.github.com/users/jennyhliu/events{/privacy}","received_events_url":"https://api.github.com/users/jennyhliu/received_events","type":"User","site_admin":false},"body":"\"required\": [\r\n        \"provider\",\r\n        \"collection\",\r\n        \"queues\"\r\n      ]\r\ncmr is optional, the other three are required as in the schema.","created_at":"2018-02-02T19:35:41Z","updated_at":"2018-02-02T19:35:41Z","html_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io/pull/41#discussion_r165739096","pull_request_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/41","author_association":"NONE","_links":{"self":{"href":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/comments/165739096"},"html":{"href":"https://github.com/cumulus-nasa/cumulus-nasa.github.io/pull/41#discussion_r165739096"},"pull_request":{"href":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/41"}},"in_reply_to_id":165715140},"pull_request":{"url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/41","id":166827177,"html_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io/pull/41","diff_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io/pull/41.diff","patch_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io/pull/41.patch","issue_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues/41","number":41,"state":"open","locked":false,"title":"CUMULUS-152 update cumulus message schema and task input/output message","user":{"login":"jennyhliu","id":34660846,"avatar_url":"https://avatars2.githubusercontent.com/u/34660846?v=4","gravatar_id":"","url":"https://api.github.com/users/jennyhliu","html_url":"https://github.com/jennyhliu","followers_url":"https://api.github.com/users/jennyhliu/followers","following_url":"https://api.github.com/users/jennyhliu/following{/other_user}","gists_url":"https://api.github.com/users/jennyhliu/gists{/gist_id}","starred_url":"https://api.github.com/users/jennyhliu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jennyhliu/subscriptions","organizations_url":"https://api.github.com/users/jennyhliu/orgs","repos_url":"https://api.github.com/users/jennyhliu/repos","events_url":"https://api.github.com/users/jennyhliu/events{/privacy}","received_events_url":"https://api.github.com/users/jennyhliu/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-02-02T15:16:44Z","updated_at":"2018-02-02T19:35:41Z","closed_at":null,"merged_at":null,"merge_commit_sha":"79149beeab661a9c2390ea865634e9969720635a","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"milestone":null,"commits_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/41/commits","review_comments_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/41/comments","review_comment_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/comments{/number}","comments_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues/41/comments","statuses_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/statuses/4b5fa0d4a00312527a927147b36336fa4ec3958f","head":{"label":"cumulus-nasa:jl_message","ref":"jl_message","sha":"4b5fa0d4a00312527a927147b36336fa4ec3958f","user":{"login":"cumulus-nasa","id":20669771,"avatar_url":"https://avatars3.githubusercontent.com/u/20669771?v=4","gravatar_id":"","url":"https://api.github.com/users/cumulus-nasa","html_url":"https://github.com/cumulus-nasa","followers_url":"https://api.github.com/users/cumulus-nasa/followers","following_url":"https://api.github.com/users/cumulus-nasa/following{/other_user}","gists_url":"https://api.github.com/users/cumulus-nasa/gists{/gist_id}","starred_url":"https://api.github.com/users/cumulus-nasa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cumulus-nasa/subscriptions","organizations_url":"https://api.github.com/users/cumulus-nasa/orgs","repos_url":"https://api.github.com/users/cumulus-nasa/repos","events_url":"https://api.github.com/users/cumulus-nasa/events{/privacy}","received_events_url":"https://api.github.com/users/cumulus-nasa/received_events","type":"Organization","site_admin":false},"repo":{"id":68245253,"name":"cumulus-nasa.github.io","full_name":"cumulus-nasa/cumulus-nasa.github.io","owner":{"login":"cumulus-nasa","id":20669771,"avatar_url":"https://avatars3.githubusercontent.com/u/20669771?v=4","gravatar_id":"","url":"https://api.github.com/users/cumulus-nasa","html_url":"https://github.com/cumulus-nasa","followers_url":"https://api.github.com/users/cumulus-nasa/followers","following_url":"https://api.github.com/users/cumulus-nasa/following{/other_user}","gists_url":"https://api.github.com/users/cumulus-nasa/gists{/gist_id}","starred_url":"https://api.github.com/users/cumulus-nasa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cumulus-nasa/subscriptions","organizations_url":"https://api.github.com/users/cumulus-nasa/orgs","repos_url":"https://api.github.com/users/cumulus-nasa/repos","events_url":"https://api.github.com/users/cumulus-nasa/events{/privacy}","received_events_url":"https://api.github.com/users/cumulus-nasa/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io","description":"Documentation on setting up, maintaining, and expanding Cumulus","fork":false,"url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io","forks_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/forks","keys_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/teams","hooks_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/hooks","issue_events_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues/events{/number}","events_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/events","assignees_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/assignees{/user}","branches_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/branches{/branch}","tags_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/tags","blobs_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/refs{/sha}","trees_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/statuses/{sha}","languages_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/languages","stargazers_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/stargazers","contributors_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/contributors","subscribers_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/subscribers","subscription_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/subscription","commits_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/commits{/sha}","git_commits_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/commits{/sha}","comments_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/comments{/number}","issue_comment_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues/comments{/number}","contents_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/contents/{+path}","compare_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/merges","archive_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/downloads","issues_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues{/number}","pulls_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls{/number}","milestones_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/milestones{/number}","notifications_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/labels{/name}","releases_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/releases{/id}","deployments_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/deployments","created_at":"2016-09-14T21:35:02Z","updated_at":"2018-01-17T18:02:57Z","pushed_at":"2018-02-02T19:19:56Z","git_url":"git://github.com/cumulus-nasa/cumulus-nasa.github.io.git","ssh_url":"git@github.com:cumulus-nasa/cumulus-nasa.github.io.git","clone_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io.git","svn_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io","homepage":"https://cumulus-nasa.github.io/","size":1900,"stargazers_count":1,"watchers_count":1,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":2,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":0,"open_issues":2,"watchers":1,"default_branch":"develop"}},"base":{"label":"cumulus-nasa:develop","ref":"develop","sha":"2ba0dc496ae145fb89aa642c3de9fab8fdabc2e7","user":{"login":"cumulus-nasa","id":20669771,"avatar_url":"https://avatars3.githubusercontent.com/u/20669771?v=4","gravatar_id":"","url":"https://api.github.com/users/cumulus-nasa","html_url":"https://github.com/cumulus-nasa","followers_url":"https://api.github.com/users/cumulus-nasa/followers","following_url":"https://api.github.com/users/cumulus-nasa/following{/other_user}","gists_url":"https://api.github.com/users/cumulus-nasa/gists{/gist_id}","starred_url":"https://api.github.com/users/cumulus-nasa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cumulus-nasa/subscriptions","organizations_url":"https://api.github.com/users/cumulus-nasa/orgs","repos_url":"https://api.github.com/users/cumulus-nasa/repos","events_url":"https://api.github.com/users/cumulus-nasa/events{/privacy}","received_events_url":"https://api.github.com/users/cumulus-nasa/received_events","type":"Organization","site_admin":false},"repo":{"id":68245253,"name":"cumulus-nasa.github.io","full_name":"cumulus-nasa/cumulus-nasa.github.io","owner":{"login":"cumulus-nasa","id":20669771,"avatar_url":"https://avatars3.githubusercontent.com/u/20669771?v=4","gravatar_id":"","url":"https://api.github.com/users/cumulus-nasa","html_url":"https://github.com/cumulus-nasa","followers_url":"https://api.github.com/users/cumulus-nasa/followers","following_url":"https://api.github.com/users/cumulus-nasa/following{/other_user}","gists_url":"https://api.github.com/users/cumulus-nasa/gists{/gist_id}","starred_url":"https://api.github.com/users/cumulus-nasa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cumulus-nasa/subscriptions","organizations_url":"https://api.github.com/users/cumulus-nasa/orgs","repos_url":"https://api.github.com/users/cumulus-nasa/repos","events_url":"https://api.github.com/users/cumulus-nasa/events{/privacy}","received_events_url":"https://api.github.com/users/cumulus-nasa/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io","description":"Documentation on setting up, maintaining, and expanding Cumulus","fork":false,"url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io","forks_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/forks","keys_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/teams","hooks_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/hooks","issue_events_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues/events{/number}","events_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/events","assignees_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/assignees{/user}","branches_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/branches{/branch}","tags_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/tags","blobs_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/refs{/sha}","trees_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/statuses/{sha}","languages_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/languages","stargazers_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/stargazers","contributors_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/contributors","subscribers_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/subscribers","subscription_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/subscription","commits_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/commits{/sha}","git_commits_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/git/commits{/sha}","comments_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/comments{/number}","issue_comment_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues/comments{/number}","contents_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/contents/{+path}","compare_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/merges","archive_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/downloads","issues_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues{/number}","pulls_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls{/number}","milestones_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/milestones{/number}","notifications_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/labels{/name}","releases_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/releases{/id}","deployments_url":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/deployments","created_at":"2016-09-14T21:35:02Z","updated_at":"2018-01-17T18:02:57Z","pushed_at":"2018-02-02T19:19:56Z","git_url":"git://github.com/cumulus-nasa/cumulus-nasa.github.io.git","ssh_url":"git@github.com:cumulus-nasa/cumulus-nasa.github.io.git","clone_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io.git","svn_url":"https://github.com/cumulus-nasa/cumulus-nasa.github.io","homepage":"https://cumulus-nasa.github.io/","size":1900,"stargazers_count":1,"watchers_count":1,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":2,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":0,"open_issues":2,"watchers":1,"default_branch":"develop"}},"_links":{"self":{"href":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/41"},"html":{"href":"https://github.com/cumulus-nasa/cumulus-nasa.github.io/pull/41"},"issue":{"href":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues/41"},"comments":{"href":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/issues/41/comments"},"review_comments":{"href":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/41/comments"},"review_comment":{"href":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/pulls/41/commits"},"statuses":{"href":"https://api.github.com/repos/cumulus-nasa/cumulus-nasa.github.io/statuses/4b5fa0d4a00312527a927147b36336fa4ec3958f"}},"author_association":"NONE"}}
{"actor":{"display_login":"jennyhliu"}}