From 70aa23a16b36b49a040980ba1061123b88ee0a2c Mon Sep 17 00:00:00 2001 From: Laurent Laville Date: Mon, 20 Dec 2021 11:51:30 +0000 Subject: [PATCH] fix markdownlint warnings --- CHANGELOG.md | 1 + README.md | 2 ++ docs/index.md | 1 + docs/reference/address.md | 1 + docs/reference/artifact.md | 1 + docs/reference/artifactChange.md | 1 + docs/reference/artifactContent.md | 1 + docs/reference/attachment.md | 1 + docs/reference/codeFlow.md | 1 + docs/reference/configurationOverride.md | 1 + docs/reference/conversion.md | 1 + docs/reference/edge.md | 1 + docs/reference/edgeTraversal.md | 1 + docs/reference/exception.md | 1 + docs/reference/externalProperties.md | 1 + docs/reference/externalPropertyFileReference.md | 1 + docs/reference/externalPropertyFileReferences.md | 1 + docs/reference/fix.md | 1 + docs/reference/graph.md | 1 + docs/reference/graphTraversal.md | 1 + docs/reference/invocation.md | 1 + docs/reference/locationRelationship.md | 1 + docs/reference/logicalLocation.md | 1 + docs/reference/message.md | 1 + docs/reference/node.md | 1 + docs/reference/notification.md | 1 + docs/reference/physicalLocation.md | 1 + docs/reference/rectangle.md | 1 + docs/reference/replacement.md | 1 + docs/reference/reportingConfiguration.md | 1 + docs/reference/reportingDescriptor.md | 1 + docs/reference/reportingDescriptorReference.md | 1 + docs/reference/reportingDescriptorRelationship.md | 1 + docs/reference/result.md | 1 + docs/reference/resultProvenance.md | 1 + docs/reference/run.md | 1 + docs/reference/runAutomationDetails.md | 1 + docs/reference/sarifLog.md | 1 + docs/reference/specialLocations.md | 1 + docs/reference/stack.md | 1 + docs/reference/stackFrame.md | 1 + docs/reference/suppression.md | 1 + docs/reference/threadFlow.md | 1 + docs/reference/threadFlowLocation.md | 1 + docs/reference/tool.md | 1 + docs/reference/toolComponentReference.md | 1 + docs/reference/translationMetadata..md | 1 + docs/reference/versionControlDetails.md | 1 + docs/reference/webRequest.md | 1 + docs/reference/webResponse.md | 1 + 50 files changed, 51 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 161c1a0..1f36784 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,4 @@ + # Changelog All notable changes to this project will be documented in this file. diff --git a/README.md b/README.md index 2e58529..40619a3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # SARIF PHP SDK | Stable | @@ -30,4 +31,5 @@ generated from the [docs](https://github.com/llaville/sarif-php-sdk/tree/master/ - API [Reference](docs/reference/) describes all SARIF objects with examples. And also + - [Study the tutorials](https://github.com/microsoft/sarif-tutorials) from GitHub's Microsoft account. diff --git a/docs/index.md b/docs/index.md index 2688488..231089c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,4 @@ + # About This PHP SDK produces the SARIF output, which is a JSON file formatted diff --git a/docs/reference/address.md b/docs/reference/address.md index 38156ee..323a9fb 100644 --- a/docs/reference/address.md +++ b/docs/reference/address.md @@ -1,3 +1,4 @@ + # address object An `address` object describes a physical or virtual address, diff --git a/docs/reference/artifact.md b/docs/reference/artifact.md index 07abee1..b8f27fa 100644 --- a/docs/reference/artifact.md +++ b/docs/reference/artifact.md @@ -1,3 +1,4 @@ + # artifact object An `artifact` object represents a single artifact. diff --git a/docs/reference/artifactChange.md b/docs/reference/artifactChange.md index a4823c6..50e724e 100644 --- a/docs/reference/artifactChange.md +++ b/docs/reference/artifactChange.md @@ -1,3 +1,4 @@ + # artifactChange object An `artifactChange` object represents a change to a single artifact. diff --git a/docs/reference/artifactContent.md b/docs/reference/artifactContent.md index 652f0a1..6c8336c 100644 --- a/docs/reference/artifactContent.md +++ b/docs/reference/artifactContent.md @@ -1,3 +1,4 @@ + # artifactContent object Certain properties in this document represent the contents of portions of artifacts external to the log file, diff --git a/docs/reference/attachment.md b/docs/reference/attachment.md index 376e8d0..d703ae6 100644 --- a/docs/reference/attachment.md +++ b/docs/reference/attachment.md @@ -1,3 +1,4 @@ + # attachment object An `attachment` object describes an artifact relevant to the detection of a result. diff --git a/docs/reference/codeFlow.md b/docs/reference/codeFlow.md index 82f09c7..973c45f 100644 --- a/docs/reference/codeFlow.md +++ b/docs/reference/codeFlow.md @@ -1,3 +1,4 @@ + # codeFlow object A `codeFlow` object describes the progress of one or more programs through one or more thread flows, diff --git a/docs/reference/configurationOverride.md b/docs/reference/configurationOverride.md index 460b0e9..ecd5219 100644 --- a/docs/reference/configurationOverride.md +++ b/docs/reference/configurationOverride.md @@ -1,3 +1,4 @@ + # configurationOverride object A `configurationOverride` object modifies the effective runtime configuration of a specified `reportingDescriptor` object, diff --git a/docs/reference/conversion.md b/docs/reference/conversion.md index 6b89cf1..ab533fe 100644 --- a/docs/reference/conversion.md +++ b/docs/reference/conversion.md @@ -1,3 +1,4 @@ + # conversion object A `conversion` object describes how a converter transformed the output of an analysis tool diff --git a/docs/reference/edge.md b/docs/reference/edge.md index 8f33acc..d9bf10b 100644 --- a/docs/reference/edge.md +++ b/docs/reference/edge.md @@ -1,3 +1,4 @@ + # edge object A `edge` object represents a directed edge in the graph represented by theGraph. diff --git a/docs/reference/edgeTraversal.md b/docs/reference/edgeTraversal.md index a2ee25f..801a137 100644 --- a/docs/reference/edgeTraversal.md +++ b/docs/reference/edgeTraversal.md @@ -1,3 +1,4 @@ + # edgeTraversal object An `edgeTraversal` object represents the traversal of a single edge during a graph traversal. diff --git a/docs/reference/exception.md b/docs/reference/exception.md index 1cd1458..a127671 100644 --- a/docs/reference/exception.md +++ b/docs/reference/exception.md @@ -1,3 +1,4 @@ + # exception object An `exception` object describes a runtime exception encountered during the execution of an analysis tool. diff --git a/docs/reference/externalProperties.md b/docs/reference/externalProperties.md index 65316c3..248022a 100644 --- a/docs/reference/externalProperties.md +++ b/docs/reference/externalProperties.md @@ -1,3 +1,4 @@ + # externalProperties object The top-level element of an external property file SHALL be an object which we refer to as an `externalProperties` object. diff --git a/docs/reference/externalPropertyFileReference.md b/docs/reference/externalPropertyFileReference.md index 6226301..2494ff5 100644 --- a/docs/reference/externalPropertyFileReference.md +++ b/docs/reference/externalPropertyFileReference.md @@ -1,3 +1,4 @@ + # externalPropertyFileReference object An `externalPropertyFileReference` object contains information that enables a SARIF consumer diff --git a/docs/reference/externalPropertyFileReferences.md b/docs/reference/externalPropertyFileReferences.md index 209c592..e5161ad 100644 --- a/docs/reference/externalPropertyFileReferences.md +++ b/docs/reference/externalPropertyFileReferences.md @@ -1,3 +1,4 @@ + # externalPropertyFileReferences object An `externalPropertyFileReferences` object contains information that enables a SARIF consumer diff --git a/docs/reference/fix.md b/docs/reference/fix.md index 948ea43..7f8709d 100644 --- a/docs/reference/fix.md +++ b/docs/reference/fix.md @@ -1,3 +1,4 @@ + # fix object A `fix` object represents a proposed fix for the problem indicated by theResult. It specifies a set of artifacts to modify. diff --git a/docs/reference/graph.md b/docs/reference/graph.md index 7f4ddf3..47dbe89 100644 --- a/docs/reference/graph.md +++ b/docs/reference/graph.md @@ -1,3 +1,4 @@ + # graph object A `graph` object represents a directed graph, a network of nodes and directed edges diff --git a/docs/reference/graphTraversal.md b/docs/reference/graphTraversal.md index a28fd63..3c19205 100644 --- a/docs/reference/graphTraversal.md +++ b/docs/reference/graphTraversal.md @@ -1,3 +1,4 @@ + # graphTraversal object A `graphTraversal` object represents a "graph traversal", that is, a path through diff --git a/docs/reference/invocation.md b/docs/reference/invocation.md index ac2f85f..ea185a5 100644 --- a/docs/reference/invocation.md +++ b/docs/reference/invocation.md @@ -1,3 +1,4 @@ + # invocation object An `invocation` object describes the invocation of the analysis tool that was run. diff --git a/docs/reference/locationRelationship.md b/docs/reference/locationRelationship.md index 0f50447..f561531 100644 --- a/docs/reference/locationRelationship.md +++ b/docs/reference/locationRelationship.md @@ -1,3 +1,4 @@ + # locationRelationship object A `locationRelationship` object specifies one or more directed relationships from one location object, diff --git a/docs/reference/logicalLocation.md b/docs/reference/logicalLocation.md index 07cff1b..236e8fa 100644 --- a/docs/reference/logicalLocation.md +++ b/docs/reference/logicalLocation.md @@ -1,3 +1,4 @@ + # logicalLocation object A `logicalLocation` object describes a logical location. diff --git a/docs/reference/message.md b/docs/reference/message.md index 2ddc014..ffd2207 100644 --- a/docs/reference/message.md +++ b/docs/reference/message.md @@ -1,3 +1,4 @@ + # message object Certain objects in this document define messages intended to be viewed by a user. diff --git a/docs/reference/node.md b/docs/reference/node.md index 84546d5..486336a 100644 --- a/docs/reference/node.md +++ b/docs/reference/node.md @@ -1,3 +1,4 @@ + # node object A `node` object represents a node in the graph represented by the containing graph object, which we refer to as theGraph. diff --git a/docs/reference/notification.md b/docs/reference/notification.md index 49b4849..b1c38e8 100644 --- a/docs/reference/notification.md +++ b/docs/reference/notification.md @@ -1,3 +1,4 @@ + # notification object A `notification` object describes a condition encountered during the execution of an analysis tool diff --git a/docs/reference/physicalLocation.md b/docs/reference/physicalLocation.md index 00a6c87..b43b51e 100644 --- a/docs/reference/physicalLocation.md +++ b/docs/reference/physicalLocation.md @@ -1,3 +1,4 @@ + # physicalLocation object A `physicalLocation` object represents the physical location where a result was detected. diff --git a/docs/reference/rectangle.md b/docs/reference/rectangle.md index 2036607..5368776 100644 --- a/docs/reference/rectangle.md +++ b/docs/reference/rectangle.md @@ -1,3 +1,4 @@ + # rectangle object A `rectangle` object specifies a rectangular area within an image. diff --git a/docs/reference/replacement.md b/docs/reference/replacement.md index e827b3d..474c7eb 100644 --- a/docs/reference/replacement.md +++ b/docs/reference/replacement.md @@ -1,3 +1,4 @@ + # replacement object A `replacement` object represents the replacement of a single region of an artifact. diff --git a/docs/reference/reportingConfiguration.md b/docs/reference/reportingConfiguration.md index b47a4b9..0f7156a 100644 --- a/docs/reference/reportingConfiguration.md +++ b/docs/reference/reportingConfiguration.md @@ -1,3 +1,4 @@ + # reportingConfiguration object A `reportingConfiguration` object contains the information in a `reportingDescriptor` that a SARIF producer can modify diff --git a/docs/reference/reportingDescriptor.md b/docs/reference/reportingDescriptor.md index 1ab34df..9a41b92 100644 --- a/docs/reference/reportingDescriptor.md +++ b/docs/reference/reportingDescriptor.md @@ -1,3 +1,4 @@ + # reportingDescriptor object A `reportingDescriptor` object contains information that describes a "reporting item" generated by a tool. diff --git a/docs/reference/reportingDescriptorReference.md b/docs/reference/reportingDescriptorReference.md index 8c93145..99ba911 100644 --- a/docs/reference/reportingDescriptorReference.md +++ b/docs/reference/reportingDescriptorReference.md @@ -1,3 +1,4 @@ + # reportingDescriptorReference object A `reportingDescriptorReference` object identifies a particular `reportingDescriptor` object, diff --git a/docs/reference/reportingDescriptorRelationship.md b/docs/reference/reportingDescriptorRelationship.md index 2c19fff..a470643 100644 --- a/docs/reference/reportingDescriptorRelationship.md +++ b/docs/reference/reportingDescriptorRelationship.md @@ -1,3 +1,4 @@ + # reportingDescriptorRelationship object A `reportingDescriptorRelationship` object specifies one or more directed relationships diff --git a/docs/reference/result.md b/docs/reference/result.md index 45a057b..b81c049 100644 --- a/docs/reference/result.md +++ b/docs/reference/result.md @@ -1,3 +1,4 @@ + # result object A `result` object describes a single result detected by an analysis tool. diff --git a/docs/reference/resultProvenance.md b/docs/reference/resultProvenance.md index 61410b3..4f58d5a 100644 --- a/docs/reference/resultProvenance.md +++ b/docs/reference/resultProvenance.md @@ -1,3 +1,4 @@ + # resultProvenance object A `resultProvenance` object contains information about the how and when theResult was detected. diff --git a/docs/reference/run.md b/docs/reference/run.md index 04a0aef..05603c2 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -1,3 +1,4 @@ + # run object An sarifLog object specifies the version of the file format and contains the output from one or more runs. diff --git a/docs/reference/runAutomationDetails.md b/docs/reference/runAutomationDetails.md index 16c9df5..7621e2a 100644 --- a/docs/reference/runAutomationDetails.md +++ b/docs/reference/runAutomationDetails.md @@ -1,3 +1,4 @@ + # runAutomationDetails object A `runAutomationDetails` object contains information that specifies theRun’s identity and role within an engineering system. diff --git a/docs/reference/sarifLog.md b/docs/reference/sarifLog.md index 10e54d7..e412b22 100644 --- a/docs/reference/sarifLog.md +++ b/docs/reference/sarifLog.md @@ -1,3 +1,4 @@ + # sariflog object An sarifLog object specifies the version of the file format and contains the output from one or more runs. diff --git a/docs/reference/specialLocations.md b/docs/reference/specialLocations.md index a2e3384..32acf16 100644 --- a/docs/reference/specialLocations.md +++ b/docs/reference/specialLocations.md @@ -1,3 +1,4 @@ + # specialLocations object A `specialLocations` object defines locations of special significance to SARIF consumers. diff --git a/docs/reference/stack.md b/docs/reference/stack.md index bdc6c24..0bcd4fa 100644 --- a/docs/reference/stack.md +++ b/docs/reference/stack.md @@ -1,3 +1,4 @@ + # stack object A `stack` object describes a single call stack. diff --git a/docs/reference/stackFrame.md b/docs/reference/stackFrame.md index f05396e..07f0ead 100644 --- a/docs/reference/stackFrame.md +++ b/docs/reference/stackFrame.md @@ -1,3 +1,4 @@ + # stackFrame object A `stackFrame` object describes a single stack frame within a call stack. diff --git a/docs/reference/suppression.md b/docs/reference/suppression.md index a720520..6aada4b 100644 --- a/docs/reference/suppression.md +++ b/docs/reference/suppression.md @@ -1,3 +1,4 @@ + # suppression object A `suppression` object describes a request to suppress a result. diff --git a/docs/reference/threadFlow.md b/docs/reference/threadFlow.md index 00985b4..1ac9a5a 100644 --- a/docs/reference/threadFlow.md +++ b/docs/reference/threadFlow.md @@ -1,3 +1,4 @@ + # threadFlow object A `threadFlow` object is a sequence of code locations that specify a possible path through a single thread of execution diff --git a/docs/reference/threadFlowLocation.md b/docs/reference/threadFlowLocation.md index 98795e7..0719b3d 100644 --- a/docs/reference/threadFlowLocation.md +++ b/docs/reference/threadFlowLocation.md @@ -1,3 +1,4 @@ + # threadFlowLocation object A `threadFlowLocation` object represents a location visited by an analysis tool diff --git a/docs/reference/tool.md b/docs/reference/tool.md index d768855..e0a1723 100644 --- a/docs/reference/tool.md +++ b/docs/reference/tool.md @@ -1,3 +1,4 @@ + # tool object A `tool` object describes the analysis tool or converter that was run. diff --git a/docs/reference/toolComponentReference.md b/docs/reference/toolComponentReference.md index ee42ff8..b3bbb1f 100644 --- a/docs/reference/toolComponentReference.md +++ b/docs/reference/toolComponentReference.md @@ -1,3 +1,4 @@ + # toolComponentReference object A `toolComponentReference` object identifies a particular `toolComponent` object, diff --git a/docs/reference/translationMetadata..md b/docs/reference/translationMetadata..md index 17a1c09..93f0e1c 100644 --- a/docs/reference/translationMetadata..md +++ b/docs/reference/translationMetadata..md @@ -1,3 +1,4 @@ + # translationMetadata object A `translationMetadata` object defines locations of special significance to SARIF consumers. diff --git a/docs/reference/versionControlDetails.md b/docs/reference/versionControlDetails.md index bd0e161..0637be5 100644 --- a/docs/reference/versionControlDetails.md +++ b/docs/reference/versionControlDetails.md @@ -1,3 +1,4 @@ + # versionControlDetails object A `versionControlDetails` object specifies the information necessary to retrieve from a version control system (VCS) diff --git a/docs/reference/webRequest.md b/docs/reference/webRequest.md index af13059..cd18006 100644 --- a/docs/reference/webRequest.md +++ b/docs/reference/webRequest.md @@ -1,3 +1,4 @@ + # webRequest object A `webRequest` object describes an HTTP request (RFC7230). diff --git a/docs/reference/webResponse.md b/docs/reference/webResponse.md index eb51e39..e237e4c 100644 --- a/docs/reference/webResponse.md +++ b/docs/reference/webResponse.md @@ -1,3 +1,4 @@ + # webResponse object A `webResponse` object describes the response to an HTTP request (RFC7230)