{"action":"created","comment":{"url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/comments/39671039","id":39671039,"diff_hunk":"@@ -1 +1,165 @@\n-# Rule Metadata Profile { #rule-metadata-profile }\n\\ No newline at end of file\n+# Rule Metadata Profile { #rule-metadata-profile }\n+\n+## General\n+\n+It is sometimes useful for an issue management system to provide information to the end user\n+about the rules that were violated by the issues in a log file.\n+For example, the user might want to know whether the issue is a potential security risk,\n+or where to find additional documentation for the issue.\n+We refer to this information as rule metadata.\n+\n+It is possible for an issue management system to have built-in knowledge of\n+the metadata for the rules defined by a set of well-known static analysis tools.\n+It is also possible for the system to provide a means for end users to upload\n+metadata for rules defined by specialized tools used in their organizations.\n+But some tools enable end users to define their own rules by means of a plug-in\n+mechanism.\n+In this case, it is useful if the metadata for these rules can be included\n+in the log file itself.\n+\n+The Rule Metadata Profile defines additional optional elements of the SARIF format\n+that are intended for use in this scenario.\n+\n+## `runLog` object { #rule-metadata-profile-runLog }\n+\n+### General { #rule-metadata-profile-runLog-general }\n+\n+The Rule Metadata Profile defines one additional property in the `runLog` object (&sect;[#runLog]).\n+\n+### `ruleInfo` property { #ruleInfo }\n+\n+A `runLog` object (&sect;[#runLog]) may contain a property named `ruleInfo`\n+whose value is an array of `ruleDescriptor` (&sect;[#ruleDescriptor]) objects.\n+\n+## `ruleDescriptor` object { #ruleDescriptor }\n+\n+### General { #ruleDescriptor-General }\n+\n+A `ruleDescriptor` object describes a discrete, potentially configurable,\n+unit of analysis as implemented by an individual tool.\n+\n+### `id` property { #ruleDescriptor-id }\n+\n+A `ruleDescriptor` object shall contain a property named `id` whose value is a string containing\n+a stable, opaque identifier for the rule.\n+\n+~ IsoExample\n+`\"CA2101\"`\n+~\n+\n+### `name` property { #ruleDescriptor-name }\n+\n+A `ruleDescriptor` object may contain a property named `name` whose value is a string containing\n+a readable rule identifier. A rule name is suitable for use as a key to other data or to\n+otherwise identify a rule (e.g., within an in-source suppression) but is not guaranteed to\n+be stable. In cases where the readable rule `name` contains implementation details that are\n+invalidated over time, for example, a tool might alter a rule's readable name (while leaving\n+the stable `id` property unchanged).\n+\n+~ IsoExample\n+`\"SpecifyMarshalingForPInvokeStringArguments\"`\n+~\n+\n+### `abstract` property { #ruleDescriptor-abstract }\n+\n+A `ruleDescriptor` object may contain a property named `abstract` whose value is a string containing\n+a concise description of the rule. The `abstract` property should be a single sentence that is understandable\n+when displayed in user interface contexts where the available space is limited to a single line of text.\n+\n+~ IsoExample\n+`\"Specify marshaling for P/Invoke string arguments\"`\n+~\n+\n+### `description` property { #ruleDescriptor-description}\n+\n+An `ruleDescriptor` object should contain a property named `description` whose value is a string that describes the rule.\n+\n+The `description` property should, as far as possible, provide details sufficient to enable resolution of issues. \n+\n+The first sentence of the `description` property should provide a concise description of the rule,\n+suitable for display in cases where UI is limited.\n+Tools that construct `description` in this way need not provide a value for the `abstract` property.\n+Tools that do not construct `abstract` in this way should provide a value for the `abstract` property,\n+because otherwise, the initial portion of `description` that a viewer displays where UI space is limited\n+might not be understandable.\n+\n+### `options` property { #ruleDescriptor-options }\n+\n+A `ruleDescriptor` object may contain a property named `options`, whose value is a JSON object\n+consisting of an arbitrary set of string/value pairs.\n+When present, the `options` objects shall describe the set of configurable options supported by the rule.\n+\n+The value within each string-value pair shall be a string, which may be the empty string.\n+The value shall not be a JSON array or sub-object.\n+\n+### `formatSpecifiers` property { #ruleDescriptor-formatSpecifiers }\n+\n+A `ruleDescriptor` object may contain a property named `formatSpecifiers`, whose value is a JSON object\n+consisting of an arbitrary set of string/value pairs.\n+When present, the `formatSpecifiers` object shall describe a set of message formatting strings","path":"document/RuleMetadataProfile.mdk","position":101,"original_position":101,"commit_id":"47e9f895cd35464cd673c70c074010c3c67c6f01","original_commit_id":"47e9f895cd35464cd673c70c074010c3c67c6f01","user":{"login":"michaelcfanning","id":13526455,"avatar_url":"https://avatars.githubusercontent.com/u/13526455?v=3","gravatar_id":"","url":"https://api.github.com/users/michaelcfanning","html_url":"https://github.com/michaelcfanning","followers_url":"https://api.github.com/users/michaelcfanning/followers","following_url":"https://api.github.com/users/michaelcfanning/following{/other_user}","gists_url":"https://api.github.com/users/michaelcfanning/gists{/gist_id}","starred_url":"https://api.github.com/users/michaelcfanning/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/michaelcfanning/subscriptions","organizations_url":"https://api.github.com/users/michaelcfanning/orgs","repos_url":"https://api.github.com/users/michaelcfanning/repos","events_url":"https://api.github.com/users/michaelcfanning/events{/privacy}","received_events_url":"https://api.github.com/users/michaelcfanning/received_events","type":"User","site_admin":false},"body":"yes","created_at":"2015-09-16T18:58:58Z","updated_at":"2015-09-16T18:58:58Z","html_url":"https://github.com/sarif-standard/sarif-spec/pull/31#discussion_r39671039","pull_request_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/31","_links":{"self":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/comments/39671039"},"html":{"href":"https://github.com/sarif-standard/sarif-spec/pull/31#discussion_r39671039"},"pull_request":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/31"}}},"pull_request":{"url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/31","id":44730222,"html_url":"https://github.com/sarif-standard/sarif-spec/pull/31","diff_url":"https://github.com/sarif-standard/sarif-spec/pull/31.diff","patch_url":"https://github.com/sarif-standard/sarif-spec/pull/31.patch","issue_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/31","number":31,"state":"open","locked":false,"title":"First draft of Rule Metadata Profile from @michaelcfanning","user":{"login":"lgolding","id":11762653,"avatar_url":"https://avatars.githubusercontent.com/u/11762653?v=3","gravatar_id":"","url":"https://api.github.com/users/lgolding","html_url":"https://github.com/lgolding","followers_url":"https://api.github.com/users/lgolding/followers","following_url":"https://api.github.com/users/lgolding/following{/other_user}","gists_url":"https://api.github.com/users/lgolding/gists{/gist_id}","starred_url":"https://api.github.com/users/lgolding/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lgolding/subscriptions","organizations_url":"https://api.github.com/users/lgolding/orgs","repos_url":"https://api.github.com/users/lgolding/repos","events_url":"https://api.github.com/users/lgolding/events{/privacy}","received_events_url":"https://api.github.com/users/lgolding/received_events","type":"User","site_admin":false},"body":"","created_at":"2015-09-10T23:05:00Z","updated_at":"2015-09-16T18:58:58Z","closed_at":null,"merged_at":null,"merge_commit_sha":"d23dce6cb070140158d012adf52b8ab2812ebf51","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/31/commits","review_comments_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/31/comments","review_comment_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/comments{/number}","comments_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/31/comments","statuses_url":"https://api.github.com/repos/sarif-standard/sarif-spec/statuses/47e9f895cd35464cd673c70c074010c3c67c6f01","head":{"label":"sarif-standard:rule-metadata-profile","ref":"rule-metadata-profile","sha":"47e9f895cd35464cd673c70c074010c3c67c6f01","user":{"login":"sarif-standard","id":13755421,"avatar_url":"https://avatars.githubusercontent.com/u/13755421?v=3","gravatar_id":"","url":"https://api.github.com/users/sarif-standard","html_url":"https://github.com/sarif-standard","followers_url":"https://api.github.com/users/sarif-standard/followers","following_url":"https://api.github.com/users/sarif-standard/following{/other_user}","gists_url":"https://api.github.com/users/sarif-standard/gists{/gist_id}","starred_url":"https://api.github.com/users/sarif-standard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sarif-standard/subscriptions","organizations_url":"https://api.github.com/users/sarif-standard/orgs","repos_url":"https://api.github.com/users/sarif-standard/repos","events_url":"https://api.github.com/users/sarif-standard/events{/privacy}","received_events_url":"https://api.github.com/users/sarif-standard/received_events","type":"Organization","site_admin":false},"repo":{"id":40567795,"name":"sarif-spec","full_name":"sarif-standard/sarif-spec","owner":{"login":"sarif-standard","id":13755421,"avatar_url":"https://avatars.githubusercontent.com/u/13755421?v=3","gravatar_id":"","url":"https://api.github.com/users/sarif-standard","html_url":"https://github.com/sarif-standard","followers_url":"https://api.github.com/users/sarif-standard/followers","following_url":"https://api.github.com/users/sarif-standard/following{/other_user}","gists_url":"https://api.github.com/users/sarif-standard/gists{/gist_id}","starred_url":"https://api.github.com/users/sarif-standard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sarif-standard/subscriptions","organizations_url":"https://api.github.com/users/sarif-standard/orgs","repos_url":"https://api.github.com/users/sarif-standard/repos","events_url":"https://api.github.com/users/sarif-standard/events{/privacy}","received_events_url":"https://api.github.com/users/sarif-standard/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/sarif-standard/sarif-spec","description":"The specification document for the Static Analysis Results Interchange Format (SARIF)","fork":false,"url":"https://api.github.com/repos/sarif-standard/sarif-spec","forks_url":"https://api.github.com/repos/sarif-standard/sarif-spec/forks","keys_url":"https://api.github.com/repos/sarif-standard/sarif-spec/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sarif-standard/sarif-spec/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sarif-standard/sarif-spec/teams","hooks_url":"https://api.github.com/repos/sarif-standard/sarif-spec/hooks","issue_events_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/events{/number}","events_url":"https://api.github.com/repos/sarif-standard/sarif-spec/events","assignees_url":"https://api.github.com/repos/sarif-standard/sarif-spec/assignees{/user}","branches_url":"https://api.github.com/repos/sarif-standard/sarif-spec/branches{/branch}","tags_url":"https://api.github.com/repos/sarif-standard/sarif-spec/tags","blobs_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/refs{/sha}","trees_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sarif-standard/sarif-spec/statuses/{sha}","languages_url":"https://api.github.com/repos/sarif-standard/sarif-spec/languages","stargazers_url":"https://api.github.com/repos/sarif-standard/sarif-spec/stargazers","contributors_url":"https://api.github.com/repos/sarif-standard/sarif-spec/contributors","subscribers_url":"https://api.github.com/repos/sarif-standard/sarif-spec/subscribers","subscription_url":"https://api.github.com/repos/sarif-standard/sarif-spec/subscription","commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/commits{/sha}","git_commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/commits{/sha}","comments_url":"https://api.github.com/repos/sarif-standard/sarif-spec/comments{/number}","issue_comment_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/comments{/number}","contents_url":"https://api.github.com/repos/sarif-standard/sarif-spec/contents/{+path}","compare_url":"https://api.github.com/repos/sarif-standard/sarif-spec/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sarif-standard/sarif-spec/merges","archive_url":"https://api.github.com/repos/sarif-standard/sarif-spec/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sarif-standard/sarif-spec/downloads","issues_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues{/number}","pulls_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls{/number}","milestones_url":"https://api.github.com/repos/sarif-standard/sarif-spec/milestones{/number}","notifications_url":"https://api.github.com/repos/sarif-standard/sarif-spec/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sarif-standard/sarif-spec/labels{/name}","releases_url":"https://api.github.com/repos/sarif-standard/sarif-spec/releases{/id}","created_at":"2015-08-11T22:14:51Z","updated_at":"2015-08-15T00:02:28Z","pushed_at":"2015-09-10T23:05:00Z","git_url":"git://github.com/sarif-standard/sarif-spec.git","ssh_url":"git@github.com:sarif-standard/sarif-spec.git","clone_url":"https://github.com/sarif-standard/sarif-spec.git","svn_url":"https://github.com/sarif-standard/sarif-spec","homepage":null,"size":376,"stargazers_count":0,"watchers_count":0,"language":"HTML","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":25,"forks":0,"open_issues":25,"watchers":0,"default_branch":"master"}},"base":{"label":"sarif-standard:master","ref":"master","sha":"14afb43d3c8dacbaf8aa6544bd17a0974aaf29e6","user":{"login":"sarif-standard","id":13755421,"avatar_url":"https://avatars.githubusercontent.com/u/13755421?v=3","gravatar_id":"","url":"https://api.github.com/users/sarif-standard","html_url":"https://github.com/sarif-standard","followers_url":"https://api.github.com/users/sarif-standard/followers","following_url":"https://api.github.com/users/sarif-standard/following{/other_user}","gists_url":"https://api.github.com/users/sarif-standard/gists{/gist_id}","starred_url":"https://api.github.com/users/sarif-standard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sarif-standard/subscriptions","organizations_url":"https://api.github.com/users/sarif-standard/orgs","repos_url":"https://api.github.com/users/sarif-standard/repos","events_url":"https://api.github.com/users/sarif-standard/events{/privacy}","received_events_url":"https://api.github.com/users/sarif-standard/received_events","type":"Organization","site_admin":false},"repo":{"id":40567795,"name":"sarif-spec","full_name":"sarif-standard/sarif-spec","owner":{"login":"sarif-standard","id":13755421,"avatar_url":"https://avatars.githubusercontent.com/u/13755421?v=3","gravatar_id":"","url":"https://api.github.com/users/sarif-standard","html_url":"https://github.com/sarif-standard","followers_url":"https://api.github.com/users/sarif-standard/followers","following_url":"https://api.github.com/users/sarif-standard/following{/other_user}","gists_url":"https://api.github.com/users/sarif-standard/gists{/gist_id}","starred_url":"https://api.github.com/users/sarif-standard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sarif-standard/subscriptions","organizations_url":"https://api.github.com/users/sarif-standard/orgs","repos_url":"https://api.github.com/users/sarif-standard/repos","events_url":"https://api.github.com/users/sarif-standard/events{/privacy}","received_events_url":"https://api.github.com/users/sarif-standard/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/sarif-standard/sarif-spec","description":"The specification document for the Static Analysis Results Interchange Format (SARIF)","fork":false,"url":"https://api.github.com/repos/sarif-standard/sarif-spec","forks_url":"https://api.github.com/repos/sarif-standard/sarif-spec/forks","keys_url":"https://api.github.com/repos/sarif-standard/sarif-spec/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sarif-standard/sarif-spec/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sarif-standard/sarif-spec/teams","hooks_url":"https://api.github.com/repos/sarif-standard/sarif-spec/hooks","issue_events_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/events{/number}","events_url":"https://api.github.com/repos/sarif-standard/sarif-spec/events","assignees_url":"https://api.github.com/repos/sarif-standard/sarif-spec/assignees{/user}","branches_url":"https://api.github.com/repos/sarif-standard/sarif-spec/branches{/branch}","tags_url":"https://api.github.com/repos/sarif-standard/sarif-spec/tags","blobs_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/refs{/sha}","trees_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sarif-standard/sarif-spec/statuses/{sha}","languages_url":"https://api.github.com/repos/sarif-standard/sarif-spec/languages","stargazers_url":"https://api.github.com/repos/sarif-standard/sarif-spec/stargazers","contributors_url":"https://api.github.com/repos/sarif-standard/sarif-spec/contributors","subscribers_url":"https://api.github.com/repos/sarif-standard/sarif-spec/subscribers","subscription_url":"https://api.github.com/repos/sarif-standard/sarif-spec/subscription","commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/commits{/sha}","git_commits_url":"https://api.github.com/repos/sarif-standard/sarif-spec/git/commits{/sha}","comments_url":"https://api.github.com/repos/sarif-standard/sarif-spec/comments{/number}","issue_comment_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/comments{/number}","contents_url":"https://api.github.com/repos/sarif-standard/sarif-spec/contents/{+path}","compare_url":"https://api.github.com/repos/sarif-standard/sarif-spec/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sarif-standard/sarif-spec/merges","archive_url":"https://api.github.com/repos/sarif-standard/sarif-spec/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sarif-standard/sarif-spec/downloads","issues_url":"https://api.github.com/repos/sarif-standard/sarif-spec/issues{/number}","pulls_url":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls{/number}","milestones_url":"https://api.github.com/repos/sarif-standard/sarif-spec/milestones{/number}","notifications_url":"https://api.github.com/repos/sarif-standard/sarif-spec/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sarif-standard/sarif-spec/labels{/name}","releases_url":"https://api.github.com/repos/sarif-standard/sarif-spec/releases{/id}","created_at":"2015-08-11T22:14:51Z","updated_at":"2015-08-15T00:02:28Z","pushed_at":"2015-09-10T23:05:00Z","git_url":"git://github.com/sarif-standard/sarif-spec.git","ssh_url":"git@github.com:sarif-standard/sarif-spec.git","clone_url":"https://github.com/sarif-standard/sarif-spec.git","svn_url":"https://github.com/sarif-standard/sarif-spec","homepage":null,"size":376,"stargazers_count":0,"watchers_count":0,"language":"HTML","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":25,"forks":0,"open_issues":25,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/31"},"html":{"href":"https://github.com/sarif-standard/sarif-spec/pull/31"},"issue":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/31"},"comments":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/issues/31/comments"},"review_comments":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/31/comments"},"review_comment":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/pulls/31/commits"},"statuses":{"href":"https://api.github.com/repos/sarif-standard/sarif-spec/statuses/47e9f895cd35464cd673c70c074010c3c67c6f01"}}}}