package sarif

  1. Overview
  2. Docs

Module Sarif.Sarif_v_2_1_0_jSource

The MIME type (RFC 2045) of the artifact.

ArtifactRolesItem

Sourceval show_artifact_roles_item : artifact_roles_item -> Ppx_deriving_runtime.string
Sourcetype external_properties_guid = Sarif_v_2_1_0_t.external_properties_guid

A stable, unique identifier for this external properties object, in the form of a GUID.

Sourceval show_external_properties_guid : external_properties_guid -> Ppx_deriving_runtime.string
Sourcetype external_properties_run_guid = Sarif_v_2_1_0_t.external_properties_run_guid

A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.

Sourceval show_external_properties_run_guid : external_properties_run_guid -> Ppx_deriving_runtime.string
Sourcetype external_properties_version = Sarif_v_2_1_0_t.external_properties_version
Sourceval show_external_properties_version : external_properties_version -> Ppx_deriving_runtime.string
Sourceval compare_int64 : int64 -> int64 -> Ppx_deriving_runtime.int

A value specifying the severity level of the notification.

Sourceval show_notification_level : notification_level -> Ppx_deriving_runtime.string

Key/value pairs that provide additional information about the object.

Sourcetype address = Sarif_v_2_1_0_t.address = {
  1. absolute_address : int64;
    (*

    The address expressed as a byte offset from the start of the addressable region.

    *)
  2. fully_qualified_name : string option;
    (*

    A human-readable fully qualified name that is associated with the address.

    *)
  3. index : int64;
    (*

    The index within run.addresses of the cached object for this address.

    *)
  4. kind : string option;
    (*

    An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.

    *)
  5. length : int64 option;
    (*

    The number of bytes in this range of addresses.

    *)
  6. name : string option;
    (*

    A name that is associated with the address, e.g., '.text'.

    *)
  7. offset_from_parent : int64 option;
    (*

    The byte offset of this address from the absolute or relative address of the parent object.

    *)
  8. parent_index : int64;
    (*

    The index within run.addresses of the parent object.

    *)
  9. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the address.

    *)
  10. relative_address : int64 option;
    (*

    The address expressed as a byte offset from the absolute address of the top-most parent object.

    *)
}

A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

Sourceval compare_address : address -> address -> Ppx_deriving_runtime.int
Sourcetype logical_location = Sarif_v_2_1_0_t.logical_location = {
  1. decorated_name : string option;
    (*

    The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

    *)
  2. fully_qualified_name : string option;
    (*

    The human-readable fully qualified name of the logical location.

    *)
  3. index : int64;
    (*

    The index within the logical locations array.

    *)
  4. kind : string option;
    (*

    The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.

    *)
  5. name : string option;
    (*

    Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

    *)
  6. parent_index : int64;
    (*

    Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

    *)
  7. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the logical location.

    *)
}

A logical location of a construct that produced a result.

Sourcetype message = Sarif_v_2_1_0_t.message = {
  1. arguments : string list option;
    (*

    An array of strings to substitute into the message string.

    *)
  2. id : string option;
    (*

    The identifier for this message.

    *)
  3. markdown : string option;
    (*

    A Markdown message string.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the message.

    *)
  5. text : string option;
    (*

    A plain text message string.

    *)
}

Encapsulates a message intended to be read by the end user.

Sourceval compare_message : message -> message -> Ppx_deriving_runtime.int
Sourcetype artifact_location = Sarif_v_2_1_0_t.artifact_location = {
  1. description : message option;
    (*

    A short description of the artifact location.

    *)
  2. index : int64;
    (*

    The index within the run artifacts array of the artifact object associated with the artifact location.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the artifact location.

    *)
  4. uri : string option;
    (*

    A string containing a valid relative or absolute URI.

    *)
  5. uri_base_id : string option;
    (*

    A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

    *)
}

Specifies the location of an artifact.

Sourcetype edge = Sarif_v_2_1_0_t.edge = {
  1. id : string;
    (*

    A string that uniquely identifies the edge within its graph.

    *)
  2. label : message option;
    (*

    A short description of the edge.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the edge.

    *)
  4. source_node_id : string;
    (*

    Identifies the source node (the node at which the edge starts).

    *)
  5. target_node_id : string;
    (*

    Identifies the target node (the node at which the edge ends).

    *)
}

Represents a directed edge in a graph.

Sourceval compare_edge : edge -> edge -> Ppx_deriving_runtime.int
Sourcetype location_relationship = Sarif_v_2_1_0_t.location_relationship = {
  1. description : message option;
    (*

    A description of the location relationship.

    *)
  2. kinds : string list option;
    (*

    A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the location relationship.

    *)
  4. target : int64;
    (*

    A reference to the related location.

    *)
}

Information about the relation of one location to another.

Sourceval show_location_relationship : location_relationship -> Ppx_deriving_runtime.string
Sourcetype multiformat_message_string = Sarif_v_2_1_0_t.multiformat_message_string = {
  1. markdown : string option;
    (*

    A Markdown message string or format string.

    *)
  2. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the message.

    *)
  3. text : string;
    (*

    A plain text message string or format string.

    *)
}

A message string or message format string rendered in multiple formats.

Sourceval show_multiformat_message_string : multiformat_message_string -> Ppx_deriving_runtime.string
Sourcetype artifact_content = Sarif_v_2_1_0_t.artifact_content = {
  1. binary : string option;
    (*

    MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

    *)
  2. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the artifact content.

    *)
  3. rendered : multiformat_message_string option;
    (*

    An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).

    *)
  4. text : string option;
    (*

    UTF-8-encoded content from a text artifact.

    *)
}

Represents the contents of an artifact.

Sourceval pp_artifact_content : Ppx_deriving_runtime.Format.formatter -> artifact_content -> Ppx_deriving_runtime.unit
Sourceval show_artifact_content : artifact_content -> Ppx_deriving_runtime.string
Sourceval equal_artifact_content : artifact_content -> artifact_content -> Ppx_deriving_runtime.bool
Sourceval compare_artifact_content : artifact_content -> artifact_content -> Ppx_deriving_runtime.int
Sourcetype edge_traversal = Sarif_v_2_1_0_t.edge_traversal = {
  1. edge_id : string;
    (*

    Identifies the edge being traversed.

    *)
  2. final_state : hm_str_mms option;
    (*

    The values of relevant expressions after the edge has been traversed.

    *)
  3. message : message option;
    (*

    A message to display to the user as the edge is traversed.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the edge traversal.

    *)
  5. step_over_edge_count : int64 option;
    (*

    The number of edge traversals necessary to return from a nested graph.

    *)
}

Represents the traversal of a single edge during a graph traversal.

Sourcetype graph_traversal_variant0 = Sarif_v_2_1_0_t.graph_traversal_variant0 = {
  1. description : message option;
    (*

    A description of this graph traversal.

    *)
  2. edge_traversals : edge_traversal list option;
    (*

    The sequences of edges traversed by this graph traversal.

    *)
  3. immutable_state : hm_str_mms option;
    (*

    Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.

    *)
  4. initial_state : hm_str_mms option;
    (*

    Values of relevant expressions at the start of the graph traversal that may change during graph traversal.

    *)
  5. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the graph traversal.

    *)
  6. result_graph_index : int64;
    (*

    The index within the result.graphs to be associated with the result.

    *)
  7. run_graph_index : int64;
    (*

    The index within the run.graphs to be associated with the result.

    *)
}
Sourceval show_graph_traversal_variant0 : graph_traversal_variant0 -> Ppx_deriving_runtime.string
Sourcetype graph_traversal_variant1 = Sarif_v_2_1_0_t.graph_traversal_variant1 = {
  1. description : message option;
    (*

    A description of this graph traversal.

    *)
  2. edge_traversals : edge_traversal list option;
    (*

    The sequences of edges traversed by this graph traversal.

    *)
  3. immutable_state : hm_str_mms option;
    (*

    Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.

    *)
  4. initial_state : hm_str_mms option;
    (*

    Values of relevant expressions at the start of the graph traversal that may change during graph traversal.

    *)
  5. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the graph traversal.

    *)
  6. result_graph_index : int64;
    (*

    The index within the result.graphs to be associated with the result.

    *)
  7. run_graph_index : int64;
    (*

    The index within the run.graphs to be associated with the result.

    *)
}
Sourceval show_graph_traversal_variant1 : graph_traversal_variant1 -> Ppx_deriving_runtime.string

Represents a path through a graph.

Sourcetype rectangle = Sarif_v_2_1_0_t.rectangle = {
  1. bottom : float option;
  2. left : float option;
  3. message : message option;
    (*

    A message relevant to the rectangle.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the rectangle.

    *)
  5. right : float option;
  6. top : float option;
}

An area within an image.

Sourceval compare_rectangle : rectangle -> rectangle -> Ppx_deriving_runtime.int
Sourcetype region = Sarif_v_2_1_0_t.region = {
  1. byte_length : int64 option;
    (*

    The length of the region in bytes.

    *)
  2. byte_offset : int64;
    (*

    The zero-based offset from the beginning of the artifact of the first byte in the region.

    *)
  3. char_length : int64 option;
    (*

    The length of the region in characters.

    *)
  4. char_offset : int64;
    (*

    The zero-based offset from the beginning of the artifact of the first character in the region.

    *)
  5. end_column : int64 option;
    (*

    The column number of the character following the end of the region.

    *)
  6. end_line : int64 option;
    (*

    The line number of the last character in the region.

    *)
  7. message : message option;
    (*

    A message relevant to the region.

    *)
  8. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the region.

    *)
  9. snippet : artifact_content option;
    (*

    The portion of the artifact contents within the specified region.

    *)
  10. source_language : string option;
    (*

    Specifies the source language, if any, of the portion of the artifact specified by the region object.

    *)
  11. start_column : int64 option;
    (*

    The column number of the first character in the region.

    *)
  12. start_line : int64 option;
    (*

    The line number of the first character in the region.

    *)
}

A region within an artifact where a result was detected.

Sourceval compare_region : region -> region -> Ppx_deriving_runtime.int
Sourcetype attachment = Sarif_v_2_1_0_t.attachment = {
  1. artifact_location : artifact_location;
    (*

    The location of the attachment.

    *)
  2. description : message option;
    (*

    A message describing the role played by the attachment.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the attachment.

    *)
  4. rectangles : rectangle list option;
    (*

    An array of rectangles specifying areas of interest within the image.

    *)
  5. regions : region list option;
    (*

    An array of regions of interest within the attachment.

    *)
}

An artifact relevant to a result.

Sourcetype physical_location = Sarif_v_2_1_0_t.physical_location = {
  1. address : address option;
    (*

    The address of the location.

    *)
  2. artifact_location : artifact_location option;
    (*

    The location of the artifact.

    *)
  3. context_region : region option;
    (*

    Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the physical location.

    *)
  5. region : region option;
    (*

    Specifies a portion of the artifact.

    *)
}

A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

Sourcetype location = Sarif_v_2_1_0_t.location = {
  1. annotations : region list option;
    (*

    A set of regions relevant to the location.

    *)
  2. id : int64;
    (*

    Value that distinguishes this location from all other locations within a single result object.

    *)
  3. logical_locations : logical_location list option;
    (*

    The logical locations associated with the result.

    *)
  4. message : message option;
    (*

    A message relevant to the location.

    *)
  5. physical_location : physical_location option;
    (*

    Identifies the artifact and region.

    *)
  6. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the location.

    *)
  7. relationships : location_relationship list option;
    (*

    An array of objects that describe relationships between this location and others.

    *)
}

A location within a programming artifact.

Sourceval compare_location : location -> location -> Ppx_deriving_runtime.int
Sourcetype replacement = Sarif_v_2_1_0_t.replacement = {
  1. deleted_region : region;
    (*

    The region of the artifact to delete.

    *)
  2. inserted_content : artifact_content option;
    (*

    The content to insert at the location specified by the 'deletedRegion' property.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the replacement.

    *)
}

The replacement of a single region of an artifact.

Sourcetype artifact_change = Sarif_v_2_1_0_t.artifact_change = {
  1. artifact_location : artifact_location;
    (*

    The location of the artifact to change.

    *)
  2. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the change.

    *)
  3. replacements : replacement list;
    (*

    An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.

    *)
}

A change to a single artifact.

Sourcetype fix = Sarif_v_2_1_0_t.fix = {
  1. artifact_changes : artifact_change list;
    (*

    One or more artifact changes that comprise a fix for a result.

    *)
  2. description : message option;
    (*

    A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the fix.

    *)
}

A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.

Sourceval compare_fix : fix -> fix -> Ppx_deriving_runtime.int
Sourcetype reporting_configuration_level = Sarif_v_2_1_0_t.reporting_configuration_level

Specifies the failure level for the report.

Sourceval show_reporting_configuration_level : reporting_configuration_level -> Ppx_deriving_runtime.string
Sourcetype reporting_configuration = Sarif_v_2_1_0_t.reporting_configuration = {
  1. enabled : bool;
    (*

    Specifies whether the report may be produced during the scan.

    *)
  2. level : reporting_configuration_level option;
    (*

    Specifies the failure level for the report.

    *)
  3. parameters : property_bag option;
    (*

    Contains configuration information specific to a report.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the reporting configuration.

    *)
  5. rank : int64;
}

Information about a rule or notification that can be configured at runtime.

Sourceval show_reporting_configuration : reporting_configuration -> Ppx_deriving_runtime.string
Sourcetype reporting_descriptor_deprecated_guids_item = Sarif_v_2_1_0_t.reporting_descriptor_deprecated_guids_item

ReportingDescriptorDeprecatedGuidsItem

Sourceval show_reporting_descriptor_deprecated_guids_item : reporting_descriptor_deprecated_guids_item -> Ppx_deriving_runtime.string
Sourcetype reporting_descriptor_guid = Sarif_v_2_1_0_t.reporting_descriptor_guid

A unique identifier for the reporting descriptor in the form of a GUID.

Sourceval show_reporting_descriptor_guid : reporting_descriptor_guid -> Ppx_deriving_runtime.string
Sourcetype reporting_descriptor_reference_guid = Sarif_v_2_1_0_t.reporting_descriptor_reference_guid

A guid that uniquely identifies the descriptor.

Sourceval show_reporting_descriptor_reference_guid : reporting_descriptor_reference_guid -> Ppx_deriving_runtime.string
Sourcetype result_baseline_state = Sarif_v_2_1_0_t.result_baseline_state

The state of a result relative to a baseline of a previous run.

Sourceval show_result_baseline_state : result_baseline_state -> Ppx_deriving_runtime.string
Sourcetype result_correlation_guid = Sarif_v_2_1_0_t.result_correlation_guid

A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

Sourceval show_result_correlation_guid : result_correlation_guid -> Ppx_deriving_runtime.string

A stable, unique identifier for the result in the form of a GUID.

A value that categorizes results by evaluation state.

A value specifying the severity level of the result.

Sourcetype result_provenance_first_detection_run_guid = Sarif_v_2_1_0_t.result_provenance_first_detection_run_guid

A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.

Sourceval show_result_provenance_first_detection_run_guid : result_provenance_first_detection_run_guid -> Ppx_deriving_runtime.string
Sourcetype result_provenance_last_detection_run_guid = Sarif_v_2_1_0_t.result_provenance_last_detection_run_guid

A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.

Sourceval show_result_provenance_last_detection_run_guid : result_provenance_last_detection_run_guid -> Ppx_deriving_runtime.string
Sourcetype result_provenance = Sarif_v_2_1_0_t.result_provenance = {
  1. conversion_sources : physical_location list option;
    (*

    An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.

    *)
  2. first_detection_run_guid : result_provenance_first_detection_run_guid option;
    (*

    A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.

    *)
  3. first_detection_time_utc : string option;
    (*

    The Coordinated Universal Time (UTC) date and time at which the result was first detected. See "Date/time properties" in the SARIF spec for the required format.

    *)
  4. invocation_index : int64;
    (*

    The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.

    *)
  5. last_detection_run_guid : result_provenance_last_detection_run_guid option;
    (*

    A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.

    *)
  6. last_detection_time_utc : string option;
    (*

    The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See "Date/time properties" in the SARIF spec for the required format.

    *)
  7. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the result.

    *)
}

Contains information about how and when a result was detected.

Sourcetype stack_frame = Sarif_v_2_1_0_t.stack_frame = {
  1. location : location option;
    (*

    The location to which this stack frame refers.

    *)
  2. module_ : string option;
    (*

    The name of the module that contains the code of this stack frame.

    *)
  3. parameters : string list option;
    (*

    The parameters of the call that is executing.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the stack frame.

    *)
  5. thread_id : int64 option;
    (*

    The thread identifier of the stack frame.

    *)
}

A function call within a stack trace.

Sourcetype stack = Sarif_v_2_1_0_t.stack = {
  1. frames : stack_frame list;
    (*

    An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

    *)
  2. message : message option;
    (*

    A message relevant to this call stack.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the stack.

    *)
}

A call stack that is relevant to a result.

Sourceval compare_stack : stack -> stack -> Ppx_deriving_runtime.int

A stable, unique identifier for the suprression in the form of a GUID.

A string that indicates where the suppression is persisted.

A string that indicates the review status of the suppression.

Sourceval show_suppression_status : suppression_status -> Ppx_deriving_runtime.string
Sourcetype suppression = Sarif_v_2_1_0_t.suppression = {
  1. guid : suppression_guid option;
    (*

    A stable, unique identifier for the suprression in the form of a GUID.

    *)
  2. justification : string option;
    (*

    A string representing the justification for the suppression.

    *)
  3. kind : suppression_kind;
    (*

    A string that indicates where the suppression is persisted.

    *)
  4. location : location option;
    (*

    Identifies the location associated with the suppression.

    *)
  5. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the suppression.

    *)
  6. status : suppression_status option;
    (*

    A string that indicates the review status of the suppression.

    *)
}

A suppression that is relevant to a result.

Sourcetype thread_flow_location_importance = Sarif_v_2_1_0_t.thread_flow_location_importance

Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

Sourceval show_thread_flow_location_importance : thread_flow_location_importance -> Ppx_deriving_runtime.string
Sourcetype tool_component_contents_item = Sarif_v_2_1_0_t.tool_component_contents_item

ToolComponentContentsItem

Sourceval show_tool_component_contents_item : tool_component_contents_item -> Ppx_deriving_runtime.string
Sourcetype tool_component_dotted_quad_file_version = Sarif_v_2_1_0_t.tool_component_dotted_quad_file_version

The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

Sourceval show_tool_component_dotted_quad_file_version : tool_component_dotted_quad_file_version -> Ppx_deriving_runtime.string

A unique identifier for the tool component in the form of a GUID.

Sourceval show_tool_component_guid : tool_component_guid -> Ppx_deriving_runtime.string
Sourcetype tool_component_language = Sarif_v_2_1_0_t.tool_component_language

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

Sourceval show_tool_component_language : tool_component_language -> Ppx_deriving_runtime.string
Sourcetype tool_component_reference_guid = Sarif_v_2_1_0_t.tool_component_reference_guid

The 'guid' property of the referenced toolComponent.

Sourceval show_tool_component_reference_guid : tool_component_reference_guid -> Ppx_deriving_runtime.string
Sourcetype tool_component_reference = Sarif_v_2_1_0_t.tool_component_reference = {
  1. guid : tool_component_reference_guid option;
    (*

    The 'guid' property of the referenced toolComponent.

    *)
  2. index : int64;
    (*

    An index into the referenced toolComponent in tool.extensions.

    *)
  3. name : string option;
    (*

    The 'name' property of the referenced toolComponent.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the toolComponentReference.

    *)
}

Identifies a particular toolComponent object, either the driver or an extension.

Sourceval show_tool_component_reference : tool_component_reference -> Ppx_deriving_runtime.string
Sourcetype reporting_descriptor_reference = Sarif_v_2_1_0_t.reporting_descriptor_reference = {
  1. guid : reporting_descriptor_reference_guid option;
    (*

    A guid that uniquely identifies the descriptor.

    *)
  2. id : string option;
    (*

    The id of the descriptor.

    *)
  3. index : int64;
    (*

    The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the reporting descriptor reference.

    *)
  5. tool_component : tool_component_reference option;
    (*

    A reference used to locate the toolComponent associated with the descriptor.

    *)
}

Information about how to locate a relevant reporting descriptor.

Sourceval show_reporting_descriptor_reference : reporting_descriptor_reference -> Ppx_deriving_runtime.string
Sourcetype configuration_override = Sarif_v_2_1_0_t.configuration_override = {
  1. configuration : reporting_configuration;
    (*

    Specifies how the rule or notification was configured during the scan.

    *)
  2. descriptor : reporting_descriptor_reference;
    (*

    A reference used to locate the descriptor whose configuration was overridden.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the configuration override.

    *)
}

Information about how a specific rule or notification was reconfigured at runtime.

Sourceval show_configuration_override : configuration_override -> Ppx_deriving_runtime.string
Sourcetype reporting_descriptor_relationship = Sarif_v_2_1_0_t.reporting_descriptor_relationship = {
  1. description : message option;
    (*

    A description of the reporting descriptor relationship.

    *)
  2. kinds : string list option;
    (*

    A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the reporting descriptor reference.

    *)
  4. target : reporting_descriptor_reference;
    (*

    A reference to the related reporting descriptor.

    *)
}

Information about the relation of one reporting descriptor to another.

Sourceval show_reporting_descriptor_relationship : reporting_descriptor_relationship -> Ppx_deriving_runtime.string
Sourcetype reporting_descriptor = Sarif_v_2_1_0_t.reporting_descriptor = {
  1. default_configuration : reporting_configuration option;
    (*

    Default reporting configuration information.

    *)
  2. deprecated_guids : reporting_descriptor_deprecated_guids_item list option;
    (*

    An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.

    *)
  3. deprecated_ids : string list option;
    (*

    An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.

    *)
  4. deprecated_names : string list option;
    (*

    An array of readable identifiers by which this report was known in some previous version of the analysis tool.

    *)
  5. full_description : multiformat_message_string option;
    (*

    A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

    *)
  6. guid : reporting_descriptor_guid option;
    (*

    A unique identifier for the reporting descriptor in the form of a GUID.

    *)
  7. help : multiformat_message_string option;
    (*

    Provides the primary documentation for the report, useful when there is no online documentation.

    *)
  8. help_uri : string option;
    (*

    A URI where the primary documentation for the report can be found.

    *)
  9. id : string;
    (*

    A stable, opaque identifier for the report.

    *)
  10. message_strings : hm_str_mms option;
    (*

    A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

    *)
  11. name : string option;
    (*

    A report identifier that is understandable to an end user.

    *)
  12. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the report.

    *)
  13. relationships : reporting_descriptor_relationship list option;
    (*

    An array of objects that describe relationships between this reporting descriptor and others.

    *)
  14. short_description : multiformat_message_string option;
    (*

    A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.

    *)
}

Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.

Sourceval show_reporting_descriptor : reporting_descriptor -> Ppx_deriving_runtime.string
Sourcetype translation_metadata = Sarif_v_2_1_0_t.translation_metadata = {
  1. download_uri : string option;
    (*

    The absolute URI from which the translation metadata can be downloaded.

    *)
  2. full_description : multiformat_message_string option;
    (*

    A comprehensive description of the translation metadata.

    *)
  3. full_name : string option;
    (*

    The full name associated with the translation metadata.

    *)
  4. information_uri : string option;
    (*

    The absolute URI from which information related to the translation metadata can be downloaded.

    *)
  5. name : string;
    (*

    The name associated with the translation metadata.

    *)
  6. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the translation metadata.

    *)
  7. short_description : multiformat_message_string option;
    (*

    A brief description of the translation metadata.

    *)
}

Provides additional metadata related to translation.

Sourceval show_translation_metadata : translation_metadata -> Ppx_deriving_runtime.string
Sourcetype tool_component = Sarif_v_2_1_0_t.tool_component = {
  1. associated_component : tool_component_reference option;
    (*

    The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.

    *)
  2. contents : tool_component_contents_item list option;
    (*

    The kinds of data contained in this object.

    *)
  3. dotted_quad_file_version : tool_component_dotted_quad_file_version option;
    (*

    The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

    *)
  4. download_uri : string option;
    (*

    The absolute URI from which the tool component can be downloaded.

    *)
  5. full_description : multiformat_message_string option;
    (*

    A comprehensive description of the tool component.

    *)
  6. full_name : string option;
    (*

    The name of the tool component along with its version and any other useful identifying information, such as its locale.

    *)
  7. global_message_strings : hm_str_mms option;
    (*

    A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

    *)
  8. guid : tool_component_guid option;
    (*

    A unique identifier for the tool component in the form of a GUID.

    *)
  9. information_uri : string option;
    (*

    The absolute URI at which information about this version of the tool component can be found.

    *)
  10. is_comprehensive : bool;
    (*

    Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

    *)
  11. language : tool_component_language option;
    (*

    The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

    *)
  12. localized_data_semantic_version : string option;
    (*

    The semantic version of the localized strings defined in this component; maintained by components that provide translations.

    *)
  13. locations : artifact_location list option;
    (*

    An array of the artifactLocation objects associated with the tool component.

    *)
  14. minimum_required_localized_data_semantic_version : string option;
    (*

    The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

    *)
  15. name : string;
    (*

    The name of the tool component.

    *)
  16. notifications : reporting_descriptor list option;
    (*

    An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

    *)
  17. organization : string option;
    (*

    The organization or company that produced the tool component.

    *)
  18. product : string option;
    (*

    A product suite to which the tool component belongs.

    *)
  19. product_suite : string option;
    (*

    A localizable string containing the name of the suite of products to which the tool component belongs.

    *)
  20. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the tool component.

    *)
  21. release_date_utc : string option;
    (*

    A string specifying the UTC date (and optionally, the time) of the component's release.

    *)
  22. rules : reporting_descriptor list option;
    (*

    An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

    *)
  23. semantic_version : string option;
    (*

    The tool component version in the format specified by Semantic Versioning 2.0.

    *)
  24. short_description : multiformat_message_string option;
    (*

    A brief description of the tool component.

    *)
  25. supported_taxonomies : tool_component_reference list option;
    (*

    An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

    *)
  26. taxa : reporting_descriptor list option;
    (*

    An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

    *)
  27. translation_metadata : translation_metadata option;
    (*

    Translation metadata, required for a translation, not populated by other component types.

    *)
  28. version : string option;
    (*

    The tool component version, in whatever format the component natively provides.

    *)
}

A component, such as a plug-in or the driver, of the analysis tool that was run.

Sourcetype tool = Sarif_v_2_1_0_t.tool = {
  1. driver : tool_component;
    (*

    The analysis tool that was run.

    *)
  2. extensions : tool_component list option;
    (*

    Tool extensions that contributed to or reconfigured the analysis tool that was run.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the tool.

    *)
}

The analysis tool that was run.

Sourceval compare_tool : tool -> tool -> Ppx_deriving_runtime.int
Sourcetype web_request = Sarif_v_2_1_0_t.web_request = {
  1. body : artifact_content option;
    (*

    The body of the request.

    *)
  2. headers : hm_str_str option;
    (*

    The request headers.

    *)
  3. index : int64;
    (*

    The index within the run.webRequests array of the request object associated with this result.

    *)
  4. method_ : string option;
    (*

    The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.

    *)
  5. parameters : hm_str_str option;
    (*

    The request parameters.

    *)
  6. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the request.

    *)
  7. protocol : string option;
    (*

    The request protocol. Example: 'http'.

    *)
  8. target : string option;
    (*

    The target of the request.

    *)
  9. version : string option;
    (*

    The request version. Example: '1.1'.

    *)
}

Describes an HTTP request.

Sourcetype web_response = Sarif_v_2_1_0_t.web_response = {
  1. body : artifact_content option;
    (*

    The body of the request.

    *)
  2. headers : hm_str_str option;
    (*

    The request headers.

    *)
  3. index : int64;
    (*

    The index within the run.webRequests array of the request object associated with this result.

    *)
  4. no_response_received : bool;
    (*

    Specifies whether a response was received from the server.

    *)
  5. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the request.

    *)
  6. protocol : string option;
    (*

    The request protocol. Example: 'http'.

    *)
  7. reason_phrase : string option;
    (*

    The response reason. Example: 'Not found'.

    *)
  8. status_code : string option;
    (*

    The response status code. Example: 451.

    *)
  9. version : string option;
    (*

    The request version. Example: '1.1'.

    *)
}

Describes the response to an HTTP request.

Sourcetype thread_flow_location = Sarif_v_2_1_0_t.thread_flow_location = {
  1. execution_order : int64;
    (*

    An integer representing the temporal order in which execution reached this location.

    *)
  2. execution_time_utc : string option;
    (*

    The Coordinated Universal Time (UTC) date and time at which this location was executed.

    *)
  3. importance : thread_flow_location_importance option;
    (*

    Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

    *)
  4. index : int64;
    (*

    he index within the run threadFlowLocations array.

    *)
  5. kinds : string list option;
    (*

    A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.

    *)
  6. location : location option;
    (*

    The code location.

    *)
  7. module_ : string option;
    (*

    The name of the module that contains the code that is executing.

    *)
  8. nesting_level : int64 option;
    (*

    An integer representing a containment hierarchy within the thread flow.

    *)
  9. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the threadflow location.

    *)
  10. stack : stack option;
    (*

    The call stack leading to this location.

    *)
  11. state : hm_str_mms option;
    (*

    A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.

    *)
  12. taxa : reporting_descriptor_reference list option;
    (*

    An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.

    *)
  13. web_request : web_request option;
    (*

    A web request associated with this thread flow location.

    *)
  14. web_response : web_response option;
    (*

    A web response associated with this thread flow location.

    *)
}

A location visited by an analysis tool while simulating or monitoring the execution of a program.

Sourceval show_thread_flow_location : thread_flow_location -> Ppx_deriving_runtime.string
Sourcetype thread_flow = Sarif_v_2_1_0_t.thread_flow = {
  1. id : string option;
    (*

    An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.

    *)
  2. immutable_state : hm_str_mms option;
    (*

    Values of relevant expressions at the start of the thread flow that remain constant.

    *)
  3. initial_state : hm_str_mms option;
    (*

    Values of relevant expressions at the start of the thread flow that may change during thread flow execution.

    *)
  4. locations : thread_flow_location list;
    (*

    A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.

    *)
  5. message : message option;
    (*

    A message relevant to the thread flow.

    *)
  6. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the thread flow.

    *)
}

Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.

Sourcetype code_flow = Sarif_v_2_1_0_t.code_flow = {
  1. message : message option;
    (*

    A message relevant to the code flow.

    *)
  2. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the code flow.

    *)
  3. thread_flows : thread_flow list;
    (*

    An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.

    *)
}

A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.

Sourceval compare_code_flow : code_flow -> code_flow -> Ppx_deriving_runtime.int
Sourcetype node = Sarif_v_2_1_0_t.node = {
  1. children : node list option;
    (*

    Array of child nodes.

    *)
  2. id : string;
    (*

    A string that uniquely identifies the node within its graph.

    *)
  3. label : message option;
    (*

    A short description of the node.

    *)
  4. location : location option;
    (*

    A code location associated with the node.

    *)
  5. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the node.

    *)
}

Represents a node in a graph.

Sourceval compare_node : node -> node -> Ppx_deriving_runtime.int
Sourcetype exception_ = Sarif_v_2_1_0_t.exception_ = {
  1. inner_exceptions : exception_ list option;
    (*

    An array of exception objects each of which is considered a cause of this exception.

    *)
  2. kind : string option;
    (*

    A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

    *)
  3. message : string option;
    (*

    A message that describes the exception.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the exception.

    *)
  5. stack : stack option;
    (*

    The sequence of function calls leading to the exception.

    *)
}

Describes a runtime exception encountered during the execution of an analysis tool.

Sourceval pp_exception_ : Ppx_deriving_runtime.Format.formatter -> exception_ -> Ppx_deriving_runtime.unit
Sourceval show_exception_ : exception_ -> Ppx_deriving_runtime.string
Sourceval equal_exception_ : exception_ -> exception_ -> Ppx_deriving_runtime.bool
Sourceval compare_exception_ : exception_ -> exception_ -> Ppx_deriving_runtime.int
Sourcetype graph = Sarif_v_2_1_0_t.graph = {
  1. description : message option;
    (*

    A description of the graph.

    *)
  2. edges : edge list option;
    (*

    An array of edge objects representing the edges of the graph.

    *)
  3. nodes : node list option;
    (*

    An array of node objects representing the nodes of the graph.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the graph.

    *)
}

A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).

Sourceval compare_graph : graph -> graph -> Ppx_deriving_runtime.int
Sourcetype result = Sarif_v_2_1_0_t.result = {
  1. analysis_target : artifact_location option;
    (*

    Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.

    *)
  2. attachments : attachment list option;
    (*

    A set of artifacts relevant to the result.

    *)
  3. baseline_state : result_baseline_state option;
    (*

    The state of a result relative to a baseline of a previous run.

    *)
  4. code_flows : code_flow list option;
    (*

    An array of 'codeFlow' objects relevant to the result.

    *)
  5. correlation_guid : result_correlation_guid option;
    (*

    A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

    *)
  6. fingerprints : hm_str_str option;
    (*

    A set of strings each of which individually defines a stable, unique identity for the result.

    *)
  7. fixes : fix list option;
    (*

    An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

    *)
  8. graph_traversals : graph_traversal list option;
    (*

    An array of one or more unique 'graphTraversal' objects.

    *)
  9. graphs : graph list option;
    (*

    An array of zero or more unique graph objects associated with the result.

    *)
  10. guid : result_guid option;
    (*

    A stable, unique identifier for the result in the form of a GUID.

    *)
  11. hosted_viewer_uri : string option;
    (*

    An absolute URI at which the result can be viewed.

    *)
  12. kind : result_kind option;
    (*

    A value that categorizes results by evaluation state.

    *)
  13. level : result_level option;
    (*

    A value specifying the severity level of the result.

    *)
  14. locations : location list option;
    (*

    The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

    *)
  15. message : message;
    (*

    A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.

    *)
  16. occurrence_count : int64 option;
    (*

    A positive integer specifying the number of times this logically unique result was observed in this run.

    *)
  17. partial_fingerprints : hm_str_str option;
    (*

    A set of strings that contribute to the stable, unique identity of the result.

    *)
  18. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the result.

    *)
  19. provenance : result_provenance option;
    (*

    Information about how and when the result was detected.

    *)
  20. rank : int64;
  21. related_locations : location list option;
    (*

    A set of locations relevant to this result.

    *)
  22. rule : reporting_descriptor_reference option;
    (*

    A reference used to locate the rule descriptor relevant to this result.

    *)
  23. rule_id : string option;
    (*

    The stable, unique identifier of the rule, if any, to which this result is relevant.

    *)
  24. rule_index : int64;
    (*

    The index within the tool component rules array of the rule object associated with this result.

    *)
  25. stacks : stack list option;
    (*

    An array of 'stack' objects relevant to the result.

    *)
  26. suppressions : suppression list option;
    (*

    A set of suppressions relevant to this result.

    *)
  27. taxa : reporting_descriptor_reference list option;
    (*

    An array of references to taxonomy reporting descriptors that are applicable to the result.

    *)
  28. web_request : web_request option;
    (*

    A web request associated with this result.

    *)
  29. web_response : web_response option;
    (*

    A web response associated with this result.

    *)
  30. work_item_uris : string list option;
    (*

    The URIs of the work items associated with this result.

    *)
}

A result produced by an analysis tool.

Sourceval compare_result : result -> result -> Ppx_deriving_runtime.int
Sourcetype notification = Sarif_v_2_1_0_t.notification = {
  1. associated_rule : reporting_descriptor_reference option;
    (*

    A reference used to locate the rule descriptor associated with this notification.

    *)
  2. descriptor : reporting_descriptor_reference option;
    (*

    A reference used to locate the descriptor relevant to this notification.

    *)
  3. exception_ : exception_ option;
    (*

    The runtime exception, if any, relevant to this notification.

    *)
  4. level : notification_level option;
    (*

    A value specifying the severity level of the notification.

    *)
  5. locations : location list option;
    (*

    The locations relevant to this notification.

    *)
  6. message : message;
    (*

    A message that describes the condition that was encountered.

    *)
  7. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the notification.

    *)
  8. thread_id : int64 option;
    (*

    The thread identifier of the code that generated the notification.

    *)
  9. time_utc : string option;
    (*

    The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.

    *)
}

Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

Sourcetype invocation = Sarif_v_2_1_0_t.invocation = {
  1. account : string option;
    (*

    The account under which the invocation occurred.

    *)
  2. arguments : string option;
    (*

    An array of strings, containing in order the command line arguments passed to the tool from the operating system.

    *)
  3. command_line : string option;
    (*

    The command line used to invoke the tool.

    *)
  4. end_time_utc : string option;
    (*

    The Coordinated Universal Time (UTC) date and time at which the invocation ended. See "Date/time properties" in the SARIF spec for the required format.

    *)
  5. environment_variables : hm_str_str option;
    (*

    The environment variables associated with the analysis tool process, expressed as key/value pairs.

    *)
  6. executable_location : artifact_location option;
    (*

    An absolute URI specifying the location of the executable that was invoked.

    *)
  7. execution_successful : bool;
    (*

    Specifies whether the tool's execution completed successfully.

    *)
  8. exit_code : int64 option;
    (*

    The process exit code.

    *)
  9. exit_code_description : string option;
    (*

    The reason for the process exit.

    *)
  10. exit_signal_name : string option;
    (*

    The name of the signal that caused the process to exit.

    *)
  11. exit_signal_number : int64 option;
    (*

    The numeric value of the signal that caused the process to exit.

    *)
  12. notification_configuration_overrides : configuration_override list option;
    (*

    An array of configurationOverride objects that describe notifications related runtime overrides.

    *)
  13. process_id : int64 option;
    (*

    The id of the process in which the invocation occurred.

    *)
  14. process_start_failure_message : string option;
    (*

    The reason given by the operating system that the process failed to start.

    *)
  15. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the invocation.

    *)
  16. response_files : artifact_location list option;
    (*

    The locations of any response files specified on the tool's command line.

    *)
  17. rule_configuration_overrides : configuration_override list option;
    (*

    An array of configurationOverride objects that describe rules related runtime overrides.

    *)
  18. start_time_utc : string option;
    (*

    The Coordinated Universal Time (UTC) date and time at which the invocation started. See "Date/time properties" in the SARIF spec for the required format.

    *)
  19. stderr : artifact_location option;
    (*

    A file containing the standard error stream from the process that was invoked.

    *)
  20. stdin : artifact_location option;
    (*

    A file containing the standard input stream to the process that was invoked.

    *)
  21. stdout : artifact_location option;
    (*

    A file containing the standard output stream from the process that was invoked.

    *)
  22. stdout_stderr : artifact_location option;
    (*

    A file containing the interleaved standard output and standard error stream from the process that was invoked.

    *)
  23. tool_configuration_notifications : notification list option;
    (*

    A list of conditions detected by the tool that are relevant to the tool's configuration.

    *)
  24. tool_execution_notifications : notification list option;
    (*

    A list of runtime conditions detected by the tool during the analysis.

    *)
  25. working_directory : artifact_location option;
    (*

    The working directory for the invocation.

    *)
}

The runtime environment of the analysis tool run.

Sourcetype conversion = Sarif_v_2_1_0_t.conversion = {
  1. analysis_tool_log_files : artifact_location list option;
    (*

    The locations of the analysis tool's per-run log files.

    *)
  2. invocation : invocation option;
    (*

    An invocation object that describes the invocation of the converter.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the conversion.

    *)
  4. tool : tool;
    (*

    A tool object that describes the converter.

    *)
}

Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

Sourcetype artifact = Sarif_v_2_1_0_t.artifact = {
  1. contents : artifact_content option;
    (*

    The contents of the artifact.

    *)
  2. description : message option;
    (*

    A short description of the artifact.

    *)
  3. encoding : string option;
    (*

    Specifies the encoding for an artifact object that refers to a text file.

    *)
  4. hashes : hm_str_str option;
    (*

    A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.

    *)
  5. last_modified_time_utc : string option;
    (*

    The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.

    *)
  6. length : int64;
    (*

    The length of the artifact in bytes.

    *)
  7. location : artifact_location option;
    (*

    The location of the artifact.

    *)
  8. mime_type : artifact_mimetype option;
    (*

    The MIME type (RFC 2045) of the artifact.

    *)
  9. offset : int64 option;
    (*

    The offset in bytes of the artifact within its containing artifact.

    *)
  10. parent_index : int64;
    (*

    Identifies the index of the immediate parent of the artifact, if this artifact is nested.

    *)
  11. properties : external_properties option;
    (*

    Key/value pairs that provide additional information about the artifact.

    *)
  12. roles : artifact_roles_item list option;
    (*

    The role or roles played by the artifact in the analysis.

    *)
  13. source_language : string option;
    (*

    Specifies the source language for any artifact object that refers to a text file that contains source code.

    *)
}

A single artifact. In some cases, this artifact might be nested within another artifact.

Sourceand external_properties = Sarif_v_2_1_0_t.external_properties = {
  1. addresses : address list option;
    (*

    Addresses that will be merged with a separate run.

    *)
  2. artifacts : artifact list option;
    (*

    An array of artifact objects that will be merged with a separate run.

    *)
  3. conversion : conversion option;
    (*

    A conversion object that will be merged with a separate run.

    *)
  4. driver : tool_component option;
    (*

    The analysis tool object that will be merged with a separate run.

    *)
  5. extensions : tool_component list option;
    (*

    Tool extensions that will be merged with a separate run.

    *)
  6. externalized_properties : property_bag option;
    (*

    Key/value pairs that provide additional information that will be merged with a separate run.

    *)
  7. graph : graph list option;
    (*

    An array of graph objects that will be merged with a separate run.

    *)
  8. guid : external_properties_guid option;
    (*

    A stable, unique identifier for this external properties object, in the form of a GUID.

    *)
  9. invocations : invocation option;
    (*

    Describes the invocation of the analysis tool that will be merged with a separate run.

    *)
  10. logical_locations : logical_location list option;
    (*

    An array of logical locations such as namespaces, types or functions that will be merged with a separate run.

    *)
  11. policies : tool_component list option;
    (*

    Tool policies that will be merged with a separate run.

    *)
  12. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the external properties.

    *)
  13. results : result option;
    (*

    An array of result objects that will be merged with a separate run.

    *)
  14. run_guid : external_properties_run_guid option;
    (*

    A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.

    *)
  15. schema : string option;
    (*

    The URI of the JSON schema corresponding to the version of the external property file format.

    *)
  16. taxonomies : tool_component list option;
    (*

    Tool taxonomies that will be merged with a separate run.

    *)
  17. thread_flow_locations : thread_flow_location list option;
    (*

    An array of threadFlowLocation objects that will be merged with a separate run.

    *)
  18. translations : tool_component list option;
    (*

    Tool translations that will be merged with a separate run.

    *)
  19. version : external_properties_version option;
    (*

    The SARIF format version of this external properties object.

    *)
  20. web_requests : web_request list option;
    (*

    Requests that will be merged with a separate run.

    *)
  21. web_responses : web_response list option;
    (*

    Responses that will be merged with a separate run.

    *)
}

The top-level element of an external property file.

Sourceval show_external_properties : external_properties -> Ppx_deriving_runtime.string
Sourceval compare_artifact : artifact -> artifact -> Ppx_deriving_runtime.int
Sourcetype version_control_details = Sarif_v_2_1_0_t.version_control_details = {
  1. as_of_time_utc : string option;
    (*

    A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.

    *)
  2. branch : string option;
    (*

    The name of a branch containing the revision.

    *)
  3. mapped_to : artifact_location option;
    (*

    The location in the local file system to which the root of the repository was mapped at the time of the analysis.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the version control details.

    *)
  5. repository_uri : string;
    (*

    The absolute URI of the repository.

    *)
  6. revision_id : string option;
    (*

    A string that uniquely and permanently identifies the revision within the repository.

    *)
  7. revision_tag : string option;
    (*

    A tag that has been applied to the revision.

    *)
}

Specifies the information necessary to retrieve a desired revision from a version control system.

Sourceval show_version_control_details : version_control_details -> Ppx_deriving_runtime.string
Sourcetype special_locations = Sarif_v_2_1_0_t.special_locations = {
  1. display_base : artifact_location option;
    (*

    Provides a suggestion to SARIF consumers to display file paths relative to the specified location.

    *)
  2. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the special locations.

    *)
}

Defines locations of special significance to SARIF consumers.

The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

Specifies the unit in which the tool measures columns.

The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

Sourcetype run_automation_details_guid = Sarif_v_2_1_0_t.run_automation_details_guid

A stable, unique identifier for this object's containing run object in the form of a GUID.

Sourceval show_run_automation_details_guid : run_automation_details_guid -> Ppx_deriving_runtime.string
Sourcetype run_automation_details_correlation_guid = Sarif_v_2_1_0_t.run_automation_details_correlation_guid

A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.

Sourceval show_run_automation_details_correlation_guid : run_automation_details_correlation_guid -> Ppx_deriving_runtime.string
Sourcetype run_automation_details = Sarif_v_2_1_0_t.run_automation_details = {
  1. correlation_guid : run_automation_details_correlation_guid option;
    (*

    A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.

    *)
  2. description : message option;
    (*

    A description of the identity and role played within the engineering system by this object's containing run object.

    *)
  3. guid : run_automation_details_guid option;
    (*

    A stable, unique identifier for this object's containing run object in the form of a GUID.

    *)
  4. id : string option;
    (*

    A hierarchical string that uniquely identifies this object's containing run object.

    *)
  5. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the run automation details.

    *)
}

Information that describes a run's identity and role within an engineering system process.

Sourceval show_run_automation_details : run_automation_details -> Ppx_deriving_runtime.string
Sourceval compare_hm_str_al : hm_str_al -> hm_str_al -> Ppx_deriving_runtime.int
Sourcetype external_property_file_reference_guid = Sarif_v_2_1_0_t.external_property_file_reference_guid

A stable, unique identifier for the external property file in the form of a GUID.

Sourceval show_external_property_file_reference_guid : external_property_file_reference_guid -> Ppx_deriving_runtime.string
Sourcetype external_property_file_reference = Sarif_v_2_1_0_t.external_property_file_reference = {
  1. guid : external_property_file_reference_guid option;
    (*

    A stable, unique identifier for the external property file in the form of a GUID.

    *)
  2. item_count : int64;
    (*

    A non-negative integer specifying the number of items contained in the external property file.

    *)
  3. location : artifact_location option;
    (*

    The location of the external property file.

    *)
  4. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the external property file.

    *)
}

Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run.

Sourceval show_external_property_file_reference : external_property_file_reference -> Ppx_deriving_runtime.string
Sourcetype external_property_file_references = Sarif_v_2_1_0_t.external_property_file_references = {
  1. addresses : external_property_file_reference list option;
    (*

    An array of external property files containing run.addresses arrays to be merged with the root log file.

    *)
  2. artifacts : external_property_file_reference list option;
    (*

    An array of external property files containing run.artifacts arrays to be merged with the root log file.

    *)
  3. conversion : external_property_file_reference option;
    (*

    An external property file containing a run.conversion object to be merged with the root log file.

    *)
  4. driver : external_property_file_reference option;
    (*

    An external property file containing a run.driver object to be merged with the root log file.

    *)
  5. extensions : external_property_file_reference list option;
    (*

    An array of external property files containing run.extensions arrays to be merged with the root log file.

    *)
  6. externalized_properties : external_property_file_reference option;
    (*

    An external property file containing a run.properties object to be merged with the root log file.

    *)
  7. graphs : external_property_file_reference list option;
    (*

    An array of external property files containing a run.graphs object to be merged with the root log file.

    *)
  8. invocations : external_property_file_reference list option;
    (*

    An array of external property files containing run.invocations arrays to be merged with the root log file.

    *)
  9. logical_locations : external_property_file_reference list option;
    (*

    An array of external property files containing run.logicalLocations arrays to be merged with the root log file.

    *)
  10. policies : external_property_file_reference list option;
    (*

    An array of external property files containing run.policies arrays to be merged with the root log file.

    *)
  11. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the external property files.

    *)
  12. results : external_property_file_reference list option;
    (*

    An array of external property files containing run.results arrays to be merged with the root log file.

    *)
  13. taxonomies : external_property_file_reference list option;
    (*

    An array of external property files containing run.taxonomies arrays to be merged with the root log file.

    *)
  14. thread_flow_locations : external_property_file_reference list option;
    (*

    An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.

    *)
  15. translations : external_property_file_reference list option;
    (*

    An array of external property files containing run.translations arrays to be merged with the root log file.

    *)
  16. web_requests : external_property_file_reference list option;
    (*

    An array of external property files containing run.requests arrays to be merged with the root log file.

    *)
  17. web_responses : external_property_file_reference list option;
    (*

    An array of external property files containing run.responses arrays to be merged with the root log file.

    *)
}

References to external property files that should be inlined with the content of a root log file.

Sourceval show_external_property_file_references : external_property_file_references -> Ppx_deriving_runtime.string
Sourcetype run = Sarif_v_2_1_0_t.run = {
  1. addresses : address list option;
    (*

    Addresses associated with this run instance, if any.

    *)
  2. artifacts : artifact list option;
    (*

    An array of artifact objects relevant to the run.

    *)
  3. automation_details : run_automation_details option;
    (*

    Automation details that describe this run.

    *)
  4. baseline_guid : run_baseline_guid option;
    (*

    The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

    *)
  5. column_kind : run_column_kind option;
    (*

    Specifies the unit in which the tool measures columns.

    *)
  6. conversion : conversion option;
    (*

    A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.

    *)
  7. default_encoding : string option;
    (*

    Specifies the default encoding for any artifact object that refers to a text file.

    *)
  8. default_source_language : string option;
    (*

    Specifies the default source language for any artifact object that refers to a text file that contains source code.

    *)
  9. external_property_file_references : external_property_file_references option;
    (*

    References to external property files that should be inlined with the content of a root log file.

    *)
  10. graphs : graph list option;
    (*

    An array of zero or more unique graph objects associated with the run.

    *)
  11. invocations : invocation list option;
    (*

    Describes the invocation of the analysis tool.

    *)
  12. language : run_language option;
    (*

    The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

    *)
  13. logical_locations : logical_location list option;
    (*

    An array of logical locations such as namespaces, types or functions.

    *)
  14. newline_sequences : string list;
    (*

    An ordered list of character sequences that were treated as line breaks when computing region information for the run.

    *)
  15. original_uri_base_ids : hm_str_al option;
    (*

    The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.

    *)
  16. policies : tool_component list option;
    (*

    Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).

    *)
  17. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the run.

    *)
  18. redaction_tokens : string list option;
    (*

    An array of strings used to replace sensitive information in a redaction-aware property.

    *)
  19. results : result list option;
    (*

    The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.

    *)
  20. run_aggregates : run_automation_details list option;
    (*

    Automation details that describe the aggregate of runs to which this run belongs.

    *)
  21. special_locations : special_locations option;
    (*

    A specialLocations object that defines locations of special significance to SARIF consumers.

    *)
  22. taxonomies : tool_component list option;
    (*

    An array of toolComponent objects relevant to a taxonomy in which results are categorized.

    *)
  23. thread_flow_locations : thread_flow_location list option;
    (*

    An array of threadFlowLocation objects cached at run level.

    *)
  24. tool : tool;
    (*

    Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.

    *)
  25. translations : tool_component list option;
    (*

    Specifies the revision in version control of the artifacts that were scanned.

    *)
  26. version_control_provenance : version_control_details list option;
    (*

    Specifies the revision in version control of the artifacts that were scanned.

    *)
  27. web_requests : web_request list option;
    (*

    An array of request objects cached at run level.

    *)
  28. web_responses : web_response list option;
    (*

    An array of response objects cached at run level.

    *)
}

Describes a single run of an analysis tool, and contains the reported output of that run.

Sourceval compare_run : run -> run -> Ppx_deriving_runtime.int
Sourcetype sarif_json_schema = Sarif_v_2_1_0_t.sarif_json_schema = {
  1. version : sarif_version;
    (*

    The SARIF format version of this log file.

    *)
  2. inline_external_properties : external_properties list option;
    (*

    References to external property files that share data between runs.

    *)
  3. properties : property_bag option;
    (*

    Key/value pairs that provide additional information about the log file.

    *)
  4. runs : run list;
    (*

    The set of runs contained in this log file.

    *)
  5. schema : string option;
    (*

    The URI of the JSON schema corresponding to the version.

    *)
}

Core type: Static Analysis Results Format (SARIF) Version 2.1.0 JSON Schema: a standard format for the output of static analysis tools.

Sourceval write_artifact_mimetype : Buffer.t -> artifact_mimetype -> unit

Output a JSON value of type artifact_mimetype.

Sourceval string_of_artifact_mimetype : ?len:int -> artifact_mimetype -> string

Serialize a value of type artifact_mimetype into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_artifact_mimetype : Yojson.Safe.lexer_state -> Lexing.lexbuf -> artifact_mimetype

Input JSON data of type artifact_mimetype.

Sourceval artifact_mimetype_of_string : string -> artifact_mimetype

Deserialize JSON data of type artifact_mimetype.

Sourceval write_artifact_roles_item : Buffer.t -> artifact_roles_item -> unit

Output a JSON value of type artifact_roles_item.

Sourceval string_of_artifact_roles_item : ?len:int -> artifact_roles_item -> string

Serialize a value of type artifact_roles_item into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_artifact_roles_item : Yojson.Safe.lexer_state -> Lexing.lexbuf -> artifact_roles_item

Input JSON data of type artifact_roles_item.

Sourceval artifact_roles_item_of_string : string -> artifact_roles_item

Deserialize JSON data of type artifact_roles_item.

Sourceval write_external_properties_guid : Buffer.t -> external_properties_guid -> unit

Output a JSON value of type external_properties_guid.

Sourceval string_of_external_properties_guid : ?len:int -> external_properties_guid -> string

Serialize a value of type external_properties_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_external_properties_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> external_properties_guid

Input JSON data of type external_properties_guid.

Sourceval external_properties_guid_of_string : string -> external_properties_guid

Deserialize JSON data of type external_properties_guid.

Sourceval write_external_properties_run_guid : Buffer.t -> external_properties_run_guid -> unit

Output a JSON value of type external_properties_run_guid.

Sourceval string_of_external_properties_run_guid : ?len:int -> external_properties_run_guid -> string

Serialize a value of type external_properties_run_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_external_properties_run_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> external_properties_run_guid

Input JSON data of type external_properties_run_guid.

Sourceval external_properties_run_guid_of_string : string -> external_properties_run_guid

Deserialize JSON data of type external_properties_run_guid.

Sourceval write_external_properties_version : Buffer.t -> external_properties_version -> unit

Output a JSON value of type external_properties_version.

Sourceval string_of_external_properties_version : ?len:int -> external_properties_version -> string

Serialize a value of type external_properties_version into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_external_properties_version : Yojson.Safe.lexer_state -> Lexing.lexbuf -> external_properties_version

Input JSON data of type external_properties_version.

Sourceval external_properties_version_of_string : string -> external_properties_version

Deserialize JSON data of type external_properties_version.

Sourceval write_hm_str_str : Buffer.t -> hm_str_str -> unit

Output a JSON value of type hm_str_str.

Sourceval string_of_hm_str_str : ?len:int -> hm_str_str -> string

Serialize a value of type hm_str_str into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_hm_str_str : Yojson.Safe.lexer_state -> Lexing.lexbuf -> hm_str_str

Input JSON data of type hm_str_str.

Sourceval hm_str_str_of_string : string -> hm_str_str

Deserialize JSON data of type hm_str_str.

Sourceval write_int64 : Buffer.t -> int64 -> unit

Output a JSON value of type int64.

Sourceval string_of_int64 : ?len:int -> int64 -> string

Serialize a value of type int64 into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_int64 : Yojson.Safe.lexer_state -> Lexing.lexbuf -> int64

Input JSON data of type int64.

Sourceval int64_of_string : string -> int64

Deserialize JSON data of type int64.

Sourceval write_notification_level : Buffer.t -> notification_level -> unit

Output a JSON value of type notification_level.

Sourceval string_of_notification_level : ?len:int -> notification_level -> string

Serialize a value of type notification_level into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_notification_level : Yojson.Safe.lexer_state -> Lexing.lexbuf -> notification_level

Input JSON data of type notification_level.

Sourceval notification_level_of_string : string -> notification_level

Deserialize JSON data of type notification_level.

Sourceval write_property_bag : Buffer.t -> property_bag -> unit

Output a JSON value of type property_bag.

Sourceval string_of_property_bag : ?len:int -> property_bag -> string

Serialize a value of type property_bag into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_property_bag : Yojson.Safe.lexer_state -> Lexing.lexbuf -> property_bag

Input JSON data of type property_bag.

Sourceval property_bag_of_string : string -> property_bag

Deserialize JSON data of type property_bag.

Sourceval write_address : Buffer.t -> address -> unit

Output a JSON value of type address.

Sourceval string_of_address : ?len:int -> address -> string

Serialize a value of type address into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_address : Yojson.Safe.lexer_state -> Lexing.lexbuf -> address

Input JSON data of type address.

Sourceval address_of_string : string -> address

Deserialize JSON data of type address.

Sourceval write_logical_location : Buffer.t -> logical_location -> unit

Output a JSON value of type logical_location.

Sourceval string_of_logical_location : ?len:int -> logical_location -> string

Serialize a value of type logical_location into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_logical_location : Yojson.Safe.lexer_state -> Lexing.lexbuf -> logical_location

Input JSON data of type logical_location.

Sourceval logical_location_of_string : string -> logical_location

Deserialize JSON data of type logical_location.

Sourceval write_message : Buffer.t -> message -> unit

Output a JSON value of type message.

Sourceval string_of_message : ?len:int -> message -> string

Serialize a value of type message into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_message : Yojson.Safe.lexer_state -> Lexing.lexbuf -> message

Input JSON data of type message.

Sourceval message_of_string : string -> message

Deserialize JSON data of type message.

Sourceval write_artifact_location : Buffer.t -> artifact_location -> unit

Output a JSON value of type artifact_location.

Sourceval string_of_artifact_location : ?len:int -> artifact_location -> string

Serialize a value of type artifact_location into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_artifact_location : Yojson.Safe.lexer_state -> Lexing.lexbuf -> artifact_location

Input JSON data of type artifact_location.

Sourceval artifact_location_of_string : string -> artifact_location

Deserialize JSON data of type artifact_location.

Sourceval write_edge : Buffer.t -> edge -> unit

Output a JSON value of type edge.

Sourceval string_of_edge : ?len:int -> edge -> string

Serialize a value of type edge into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_edge : Yojson.Safe.lexer_state -> Lexing.lexbuf -> edge

Input JSON data of type edge.

Sourceval edge_of_string : string -> edge

Deserialize JSON data of type edge.

Sourceval write_location_relationship : Buffer.t -> location_relationship -> unit

Output a JSON value of type location_relationship.

Sourceval string_of_location_relationship : ?len:int -> location_relationship -> string

Serialize a value of type location_relationship into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_location_relationship : Yojson.Safe.lexer_state -> Lexing.lexbuf -> location_relationship

Input JSON data of type location_relationship.

Sourceval location_relationship_of_string : string -> location_relationship

Deserialize JSON data of type location_relationship.

Sourceval write_multiformat_message_string : Buffer.t -> multiformat_message_string -> unit

Output a JSON value of type multiformat_message_string.

Sourceval string_of_multiformat_message_string : ?len:int -> multiformat_message_string -> string

Serialize a value of type multiformat_message_string into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_multiformat_message_string : Yojson.Safe.lexer_state -> Lexing.lexbuf -> multiformat_message_string

Input JSON data of type multiformat_message_string.

Sourceval multiformat_message_string_of_string : string -> multiformat_message_string

Deserialize JSON data of type multiformat_message_string.

Sourceval write_artifact_content : Buffer.t -> artifact_content -> unit

Output a JSON value of type artifact_content.

Sourceval string_of_artifact_content : ?len:int -> artifact_content -> string

Serialize a value of type artifact_content into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_artifact_content : Yojson.Safe.lexer_state -> Lexing.lexbuf -> artifact_content

Input JSON data of type artifact_content.

Sourceval artifact_content_of_string : string -> artifact_content

Deserialize JSON data of type artifact_content.

Sourceval write_hm_str_mms : Buffer.t -> hm_str_mms -> unit

Output a JSON value of type hm_str_mms.

Sourceval string_of_hm_str_mms : ?len:int -> hm_str_mms -> string

Serialize a value of type hm_str_mms into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_hm_str_mms : Yojson.Safe.lexer_state -> Lexing.lexbuf -> hm_str_mms

Input JSON data of type hm_str_mms.

Sourceval hm_str_mms_of_string : string -> hm_str_mms

Deserialize JSON data of type hm_str_mms.

Sourceval write_edge_traversal : Buffer.t -> edge_traversal -> unit

Output a JSON value of type edge_traversal.

Sourceval string_of_edge_traversal : ?len:int -> edge_traversal -> string

Serialize a value of type edge_traversal into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_edge_traversal : Yojson.Safe.lexer_state -> Lexing.lexbuf -> edge_traversal

Input JSON data of type edge_traversal.

Sourceval edge_traversal_of_string : string -> edge_traversal

Deserialize JSON data of type edge_traversal.

Sourceval write_graph_traversal_variant0 : Buffer.t -> graph_traversal_variant0 -> unit

Output a JSON value of type graph_traversal_variant0.

Sourceval string_of_graph_traversal_variant0 : ?len:int -> graph_traversal_variant0 -> string

Serialize a value of type graph_traversal_variant0 into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_graph_traversal_variant0 : Yojson.Safe.lexer_state -> Lexing.lexbuf -> graph_traversal_variant0

Input JSON data of type graph_traversal_variant0.

Sourceval graph_traversal_variant0_of_string : string -> graph_traversal_variant0

Deserialize JSON data of type graph_traversal_variant0.

Sourceval write_graph_traversal_variant1 : Buffer.t -> graph_traversal_variant1 -> unit

Output a JSON value of type graph_traversal_variant1.

Sourceval string_of_graph_traversal_variant1 : ?len:int -> graph_traversal_variant1 -> string

Serialize a value of type graph_traversal_variant1 into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_graph_traversal_variant1 : Yojson.Safe.lexer_state -> Lexing.lexbuf -> graph_traversal_variant1

Input JSON data of type graph_traversal_variant1.

Sourceval graph_traversal_variant1_of_string : string -> graph_traversal_variant1

Deserialize JSON data of type graph_traversal_variant1.

Sourceval write_graph_traversal : Buffer.t -> graph_traversal -> unit

Output a JSON value of type graph_traversal.

Sourceval string_of_graph_traversal : ?len:int -> graph_traversal -> string

Serialize a value of type graph_traversal into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_graph_traversal : Yojson.Safe.lexer_state -> Lexing.lexbuf -> graph_traversal

Input JSON data of type graph_traversal.

Sourceval graph_traversal_of_string : string -> graph_traversal

Deserialize JSON data of type graph_traversal.

Sourceval write_rectangle : Buffer.t -> rectangle -> unit

Output a JSON value of type rectangle.

Sourceval string_of_rectangle : ?len:int -> rectangle -> string

Serialize a value of type rectangle into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_rectangle : Yojson.Safe.lexer_state -> Lexing.lexbuf -> rectangle

Input JSON data of type rectangle.

Sourceval rectangle_of_string : string -> rectangle

Deserialize JSON data of type rectangle.

Sourceval write_region : Buffer.t -> region -> unit

Output a JSON value of type region.

Sourceval string_of_region : ?len:int -> region -> string

Serialize a value of type region into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_region : Yojson.Safe.lexer_state -> Lexing.lexbuf -> region

Input JSON data of type region.

Sourceval region_of_string : string -> region

Deserialize JSON data of type region.

Sourceval write_attachment : Buffer.t -> attachment -> unit

Output a JSON value of type attachment.

Sourceval string_of_attachment : ?len:int -> attachment -> string

Serialize a value of type attachment into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_attachment : Yojson.Safe.lexer_state -> Lexing.lexbuf -> attachment

Input JSON data of type attachment.

Sourceval attachment_of_string : string -> attachment

Deserialize JSON data of type attachment.

Sourceval write_physical_location : Buffer.t -> physical_location -> unit

Output a JSON value of type physical_location.

Sourceval string_of_physical_location : ?len:int -> physical_location -> string

Serialize a value of type physical_location into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_physical_location : Yojson.Safe.lexer_state -> Lexing.lexbuf -> physical_location

Input JSON data of type physical_location.

Sourceval physical_location_of_string : string -> physical_location

Deserialize JSON data of type physical_location.

Sourceval write_location : Buffer.t -> location -> unit

Output a JSON value of type location.

Sourceval string_of_location : ?len:int -> location -> string

Serialize a value of type location into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_location : Yojson.Safe.lexer_state -> Lexing.lexbuf -> location

Input JSON data of type location.

Sourceval location_of_string : string -> location

Deserialize JSON data of type location.

Sourceval write_replacement : Buffer.t -> replacement -> unit

Output a JSON value of type replacement.

Sourceval string_of_replacement : ?len:int -> replacement -> string

Serialize a value of type replacement into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_replacement : Yojson.Safe.lexer_state -> Lexing.lexbuf -> replacement

Input JSON data of type replacement.

Sourceval replacement_of_string : string -> replacement

Deserialize JSON data of type replacement.

Sourceval write_artifact_change : Buffer.t -> artifact_change -> unit

Output a JSON value of type artifact_change.

Sourceval string_of_artifact_change : ?len:int -> artifact_change -> string

Serialize a value of type artifact_change into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_artifact_change : Yojson.Safe.lexer_state -> Lexing.lexbuf -> artifact_change

Input JSON data of type artifact_change.

Sourceval artifact_change_of_string : string -> artifact_change

Deserialize JSON data of type artifact_change.

Sourceval write_fix : Buffer.t -> fix -> unit

Output a JSON value of type fix.

Sourceval string_of_fix : ?len:int -> fix -> string

Serialize a value of type fix into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_fix : Yojson.Safe.lexer_state -> Lexing.lexbuf -> fix

Input JSON data of type fix.

Sourceval fix_of_string : string -> fix

Deserialize JSON data of type fix.

Sourceval write_reporting_configuration_level : Buffer.t -> reporting_configuration_level -> unit

Output a JSON value of type reporting_configuration_level.

Sourceval string_of_reporting_configuration_level : ?len:int -> reporting_configuration_level -> string

Serialize a value of type reporting_configuration_level into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_reporting_configuration_level : Yojson.Safe.lexer_state -> Lexing.lexbuf -> reporting_configuration_level

Input JSON data of type reporting_configuration_level.

Sourceval reporting_configuration_level_of_string : string -> reporting_configuration_level

Deserialize JSON data of type reporting_configuration_level.

Sourceval write_reporting_configuration : Buffer.t -> reporting_configuration -> unit

Output a JSON value of type reporting_configuration.

Sourceval string_of_reporting_configuration : ?len:int -> reporting_configuration -> string

Serialize a value of type reporting_configuration into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_reporting_configuration : Yojson.Safe.lexer_state -> Lexing.lexbuf -> reporting_configuration

Input JSON data of type reporting_configuration.

Sourceval reporting_configuration_of_string : string -> reporting_configuration

Deserialize JSON data of type reporting_configuration.

Sourceval write_reporting_descriptor_deprecated_guids_item : Buffer.t -> reporting_descriptor_deprecated_guids_item -> unit

Output a JSON value of type reporting_descriptor_deprecated_guids_item.

Sourceval string_of_reporting_descriptor_deprecated_guids_item : ?len:int -> reporting_descriptor_deprecated_guids_item -> string

Serialize a value of type reporting_descriptor_deprecated_guids_item into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_reporting_descriptor_deprecated_guids_item : Yojson.Safe.lexer_state -> Lexing.lexbuf -> reporting_descriptor_deprecated_guids_item

Input JSON data of type reporting_descriptor_deprecated_guids_item.

Sourceval reporting_descriptor_deprecated_guids_item_of_string : string -> reporting_descriptor_deprecated_guids_item

Deserialize JSON data of type reporting_descriptor_deprecated_guids_item.

Sourceval write_reporting_descriptor_guid : Buffer.t -> reporting_descriptor_guid -> unit

Output a JSON value of type reporting_descriptor_guid.

Sourceval string_of_reporting_descriptor_guid : ?len:int -> reporting_descriptor_guid -> string

Serialize a value of type reporting_descriptor_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_reporting_descriptor_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> reporting_descriptor_guid

Input JSON data of type reporting_descriptor_guid.

Sourceval reporting_descriptor_guid_of_string : string -> reporting_descriptor_guid

Deserialize JSON data of type reporting_descriptor_guid.

Sourceval write_reporting_descriptor_reference_guid : Buffer.t -> reporting_descriptor_reference_guid -> unit

Output a JSON value of type reporting_descriptor_reference_guid.

Sourceval string_of_reporting_descriptor_reference_guid : ?len:int -> reporting_descriptor_reference_guid -> string

Serialize a value of type reporting_descriptor_reference_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_reporting_descriptor_reference_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> reporting_descriptor_reference_guid

Input JSON data of type reporting_descriptor_reference_guid.

Sourceval reporting_descriptor_reference_guid_of_string : string -> reporting_descriptor_reference_guid

Deserialize JSON data of type reporting_descriptor_reference_guid.

Sourceval write_result_baseline_state : Buffer.t -> result_baseline_state -> unit

Output a JSON value of type result_baseline_state.

Sourceval string_of_result_baseline_state : ?len:int -> result_baseline_state -> string

Serialize a value of type result_baseline_state into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_result_baseline_state : Yojson.Safe.lexer_state -> Lexing.lexbuf -> result_baseline_state

Input JSON data of type result_baseline_state.

Sourceval result_baseline_state_of_string : string -> result_baseline_state

Deserialize JSON data of type result_baseline_state.

Sourceval write_result_correlation_guid : Buffer.t -> result_correlation_guid -> unit

Output a JSON value of type result_correlation_guid.

Sourceval string_of_result_correlation_guid : ?len:int -> result_correlation_guid -> string

Serialize a value of type result_correlation_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_result_correlation_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> result_correlation_guid

Input JSON data of type result_correlation_guid.

Sourceval result_correlation_guid_of_string : string -> result_correlation_guid

Deserialize JSON data of type result_correlation_guid.

Sourceval write_result_guid : Buffer.t -> result_guid -> unit

Output a JSON value of type result_guid.

Sourceval string_of_result_guid : ?len:int -> result_guid -> string

Serialize a value of type result_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_result_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> result_guid

Input JSON data of type result_guid.

Sourceval result_guid_of_string : string -> result_guid

Deserialize JSON data of type result_guid.

Sourceval write_result_kind : Buffer.t -> result_kind -> unit

Output a JSON value of type result_kind.

Sourceval string_of_result_kind : ?len:int -> result_kind -> string

Serialize a value of type result_kind into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_result_kind : Yojson.Safe.lexer_state -> Lexing.lexbuf -> result_kind

Input JSON data of type result_kind.

Sourceval result_kind_of_string : string -> result_kind

Deserialize JSON data of type result_kind.

Sourceval write_result_level : Buffer.t -> result_level -> unit

Output a JSON value of type result_level.

Sourceval string_of_result_level : ?len:int -> result_level -> string

Serialize a value of type result_level into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_result_level : Yojson.Safe.lexer_state -> Lexing.lexbuf -> result_level

Input JSON data of type result_level.

Sourceval result_level_of_string : string -> result_level

Deserialize JSON data of type result_level.

Sourceval write_result_provenance_first_detection_run_guid : Buffer.t -> result_provenance_first_detection_run_guid -> unit

Output a JSON value of type result_provenance_first_detection_run_guid.

Sourceval string_of_result_provenance_first_detection_run_guid : ?len:int -> result_provenance_first_detection_run_guid -> string

Serialize a value of type result_provenance_first_detection_run_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_result_provenance_first_detection_run_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> result_provenance_first_detection_run_guid

Input JSON data of type result_provenance_first_detection_run_guid.

Sourceval result_provenance_first_detection_run_guid_of_string : string -> result_provenance_first_detection_run_guid

Deserialize JSON data of type result_provenance_first_detection_run_guid.

Sourceval write_result_provenance_last_detection_run_guid : Buffer.t -> result_provenance_last_detection_run_guid -> unit

Output a JSON value of type result_provenance_last_detection_run_guid.

Sourceval string_of_result_provenance_last_detection_run_guid : ?len:int -> result_provenance_last_detection_run_guid -> string

Serialize a value of type result_provenance_last_detection_run_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_result_provenance_last_detection_run_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> result_provenance_last_detection_run_guid

Input JSON data of type result_provenance_last_detection_run_guid.

Sourceval result_provenance_last_detection_run_guid_of_string : string -> result_provenance_last_detection_run_guid

Deserialize JSON data of type result_provenance_last_detection_run_guid.

Sourceval write_result_provenance : Buffer.t -> result_provenance -> unit

Output a JSON value of type result_provenance.

Sourceval string_of_result_provenance : ?len:int -> result_provenance -> string

Serialize a value of type result_provenance into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_result_provenance : Yojson.Safe.lexer_state -> Lexing.lexbuf -> result_provenance

Input JSON data of type result_provenance.

Sourceval result_provenance_of_string : string -> result_provenance

Deserialize JSON data of type result_provenance.

Sourceval write_stack_frame : Buffer.t -> stack_frame -> unit

Output a JSON value of type stack_frame.

Sourceval string_of_stack_frame : ?len:int -> stack_frame -> string

Serialize a value of type stack_frame into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_stack_frame : Yojson.Safe.lexer_state -> Lexing.lexbuf -> stack_frame

Input JSON data of type stack_frame.

Sourceval stack_frame_of_string : string -> stack_frame

Deserialize JSON data of type stack_frame.

Sourceval write_stack : Buffer.t -> stack -> unit

Output a JSON value of type stack.

Sourceval string_of_stack : ?len:int -> stack -> string

Serialize a value of type stack into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_stack : Yojson.Safe.lexer_state -> Lexing.lexbuf -> stack

Input JSON data of type stack.

Sourceval stack_of_string : string -> stack

Deserialize JSON data of type stack.

Sourceval write_suppression_guid : Buffer.t -> suppression_guid -> unit

Output a JSON value of type suppression_guid.

Sourceval string_of_suppression_guid : ?len:int -> suppression_guid -> string

Serialize a value of type suppression_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_suppression_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> suppression_guid

Input JSON data of type suppression_guid.

Sourceval suppression_guid_of_string : string -> suppression_guid

Deserialize JSON data of type suppression_guid.

Sourceval write_suppression_kind : Buffer.t -> suppression_kind -> unit

Output a JSON value of type suppression_kind.

Sourceval string_of_suppression_kind : ?len:int -> suppression_kind -> string

Serialize a value of type suppression_kind into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_suppression_kind : Yojson.Safe.lexer_state -> Lexing.lexbuf -> suppression_kind

Input JSON data of type suppression_kind.

Sourceval suppression_kind_of_string : string -> suppression_kind

Deserialize JSON data of type suppression_kind.

Sourceval write_suppression_status : Buffer.t -> suppression_status -> unit

Output a JSON value of type suppression_status.

Sourceval string_of_suppression_status : ?len:int -> suppression_status -> string

Serialize a value of type suppression_status into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_suppression_status : Yojson.Safe.lexer_state -> Lexing.lexbuf -> suppression_status

Input JSON data of type suppression_status.

Sourceval suppression_status_of_string : string -> suppression_status

Deserialize JSON data of type suppression_status.

Sourceval write_suppression : Buffer.t -> suppression -> unit

Output a JSON value of type suppression.

Sourceval string_of_suppression : ?len:int -> suppression -> string

Serialize a value of type suppression into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_suppression : Yojson.Safe.lexer_state -> Lexing.lexbuf -> suppression

Input JSON data of type suppression.

Sourceval suppression_of_string : string -> suppression

Deserialize JSON data of type suppression.

Sourceval write_thread_flow_location_importance : Buffer.t -> thread_flow_location_importance -> unit

Output a JSON value of type thread_flow_location_importance.

Sourceval string_of_thread_flow_location_importance : ?len:int -> thread_flow_location_importance -> string

Serialize a value of type thread_flow_location_importance into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_thread_flow_location_importance : Yojson.Safe.lexer_state -> Lexing.lexbuf -> thread_flow_location_importance

Input JSON data of type thread_flow_location_importance.

Sourceval thread_flow_location_importance_of_string : string -> thread_flow_location_importance

Deserialize JSON data of type thread_flow_location_importance.

Sourceval write_tool_component_contents_item : Buffer.t -> tool_component_contents_item -> unit

Output a JSON value of type tool_component_contents_item.

Sourceval string_of_tool_component_contents_item : ?len:int -> tool_component_contents_item -> string

Serialize a value of type tool_component_contents_item into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_tool_component_contents_item : Yojson.Safe.lexer_state -> Lexing.lexbuf -> tool_component_contents_item

Input JSON data of type tool_component_contents_item.

Sourceval tool_component_contents_item_of_string : string -> tool_component_contents_item

Deserialize JSON data of type tool_component_contents_item.

Sourceval write_tool_component_dotted_quad_file_version : Buffer.t -> tool_component_dotted_quad_file_version -> unit

Output a JSON value of type tool_component_dotted_quad_file_version.

Sourceval string_of_tool_component_dotted_quad_file_version : ?len:int -> tool_component_dotted_quad_file_version -> string

Serialize a value of type tool_component_dotted_quad_file_version into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_tool_component_dotted_quad_file_version : Yojson.Safe.lexer_state -> Lexing.lexbuf -> tool_component_dotted_quad_file_version

Input JSON data of type tool_component_dotted_quad_file_version.

Sourceval tool_component_dotted_quad_file_version_of_string : string -> tool_component_dotted_quad_file_version

Deserialize JSON data of type tool_component_dotted_quad_file_version.

Sourceval write_tool_component_guid : Buffer.t -> tool_component_guid -> unit

Output a JSON value of type tool_component_guid.

Sourceval string_of_tool_component_guid : ?len:int -> tool_component_guid -> string

Serialize a value of type tool_component_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_tool_component_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> tool_component_guid

Input JSON data of type tool_component_guid.

Sourceval tool_component_guid_of_string : string -> tool_component_guid

Deserialize JSON data of type tool_component_guid.

Sourceval write_tool_component_language : Buffer.t -> tool_component_language -> unit

Output a JSON value of type tool_component_language.

Sourceval string_of_tool_component_language : ?len:int -> tool_component_language -> string

Serialize a value of type tool_component_language into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_tool_component_language : Yojson.Safe.lexer_state -> Lexing.lexbuf -> tool_component_language

Input JSON data of type tool_component_language.

Sourceval tool_component_language_of_string : string -> tool_component_language

Deserialize JSON data of type tool_component_language.

Sourceval write_tool_component_reference_guid : Buffer.t -> tool_component_reference_guid -> unit

Output a JSON value of type tool_component_reference_guid.

Sourceval string_of_tool_component_reference_guid : ?len:int -> tool_component_reference_guid -> string

Serialize a value of type tool_component_reference_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_tool_component_reference_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> tool_component_reference_guid

Input JSON data of type tool_component_reference_guid.

Sourceval tool_component_reference_guid_of_string : string -> tool_component_reference_guid

Deserialize JSON data of type tool_component_reference_guid.

Sourceval write_tool_component_reference : Buffer.t -> tool_component_reference -> unit

Output a JSON value of type tool_component_reference.

Sourceval string_of_tool_component_reference : ?len:int -> tool_component_reference -> string

Serialize a value of type tool_component_reference into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_tool_component_reference : Yojson.Safe.lexer_state -> Lexing.lexbuf -> tool_component_reference

Input JSON data of type tool_component_reference.

Sourceval tool_component_reference_of_string : string -> tool_component_reference

Deserialize JSON data of type tool_component_reference.

Sourceval write_reporting_descriptor_reference : Buffer.t -> reporting_descriptor_reference -> unit

Output a JSON value of type reporting_descriptor_reference.

Sourceval string_of_reporting_descriptor_reference : ?len:int -> reporting_descriptor_reference -> string

Serialize a value of type reporting_descriptor_reference into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_reporting_descriptor_reference : Yojson.Safe.lexer_state -> Lexing.lexbuf -> reporting_descriptor_reference

Input JSON data of type reporting_descriptor_reference.

Sourceval reporting_descriptor_reference_of_string : string -> reporting_descriptor_reference

Deserialize JSON data of type reporting_descriptor_reference.

Sourceval write_configuration_override : Buffer.t -> configuration_override -> unit

Output a JSON value of type configuration_override.

Sourceval string_of_configuration_override : ?len:int -> configuration_override -> string

Serialize a value of type configuration_override into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_configuration_override : Yojson.Safe.lexer_state -> Lexing.lexbuf -> configuration_override

Input JSON data of type configuration_override.

Sourceval configuration_override_of_string : string -> configuration_override

Deserialize JSON data of type configuration_override.

Sourceval write_reporting_descriptor_relationship : Buffer.t -> reporting_descriptor_relationship -> unit

Output a JSON value of type reporting_descriptor_relationship.

Sourceval string_of_reporting_descriptor_relationship : ?len:int -> reporting_descriptor_relationship -> string

Serialize a value of type reporting_descriptor_relationship into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_reporting_descriptor_relationship : Yojson.Safe.lexer_state -> Lexing.lexbuf -> reporting_descriptor_relationship

Input JSON data of type reporting_descriptor_relationship.

Sourceval reporting_descriptor_relationship_of_string : string -> reporting_descriptor_relationship

Deserialize JSON data of type reporting_descriptor_relationship.

Sourceval write_reporting_descriptor : Buffer.t -> reporting_descriptor -> unit

Output a JSON value of type reporting_descriptor.

Sourceval string_of_reporting_descriptor : ?len:int -> reporting_descriptor -> string

Serialize a value of type reporting_descriptor into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_reporting_descriptor : Yojson.Safe.lexer_state -> Lexing.lexbuf -> reporting_descriptor

Input JSON data of type reporting_descriptor.

Sourceval reporting_descriptor_of_string : string -> reporting_descriptor

Deserialize JSON data of type reporting_descriptor.

Sourceval write_translation_metadata : Buffer.t -> translation_metadata -> unit

Output a JSON value of type translation_metadata.

Sourceval string_of_translation_metadata : ?len:int -> translation_metadata -> string

Serialize a value of type translation_metadata into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_translation_metadata : Yojson.Safe.lexer_state -> Lexing.lexbuf -> translation_metadata

Input JSON data of type translation_metadata.

Sourceval translation_metadata_of_string : string -> translation_metadata

Deserialize JSON data of type translation_metadata.

Sourceval write_tool_component : Buffer.t -> tool_component -> unit

Output a JSON value of type tool_component.

Sourceval string_of_tool_component : ?len:int -> tool_component -> string

Serialize a value of type tool_component into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_tool_component : Yojson.Safe.lexer_state -> Lexing.lexbuf -> tool_component

Input JSON data of type tool_component.

Sourceval tool_component_of_string : string -> tool_component

Deserialize JSON data of type tool_component.

Sourceval write_tool : Buffer.t -> tool -> unit

Output a JSON value of type tool.

Sourceval string_of_tool : ?len:int -> tool -> string

Serialize a value of type tool into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_tool : Yojson.Safe.lexer_state -> Lexing.lexbuf -> tool

Input JSON data of type tool.

Sourceval tool_of_string : string -> tool

Deserialize JSON data of type tool.

Sourceval write_web_request : Buffer.t -> web_request -> unit

Output a JSON value of type web_request.

Sourceval string_of_web_request : ?len:int -> web_request -> string

Serialize a value of type web_request into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_web_request : Yojson.Safe.lexer_state -> Lexing.lexbuf -> web_request

Input JSON data of type web_request.

Sourceval web_request_of_string : string -> web_request

Deserialize JSON data of type web_request.

Sourceval write_web_response : Buffer.t -> web_response -> unit

Output a JSON value of type web_response.

Sourceval string_of_web_response : ?len:int -> web_response -> string

Serialize a value of type web_response into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_web_response : Yojson.Safe.lexer_state -> Lexing.lexbuf -> web_response

Input JSON data of type web_response.

Sourceval web_response_of_string : string -> web_response

Deserialize JSON data of type web_response.

Sourceval write_thread_flow_location : Buffer.t -> thread_flow_location -> unit

Output a JSON value of type thread_flow_location.

Sourceval string_of_thread_flow_location : ?len:int -> thread_flow_location -> string

Serialize a value of type thread_flow_location into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_thread_flow_location : Yojson.Safe.lexer_state -> Lexing.lexbuf -> thread_flow_location

Input JSON data of type thread_flow_location.

Sourceval thread_flow_location_of_string : string -> thread_flow_location

Deserialize JSON data of type thread_flow_location.

Sourceval write_thread_flow : Buffer.t -> thread_flow -> unit

Output a JSON value of type thread_flow.

Sourceval string_of_thread_flow : ?len:int -> thread_flow -> string

Serialize a value of type thread_flow into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_thread_flow : Yojson.Safe.lexer_state -> Lexing.lexbuf -> thread_flow

Input JSON data of type thread_flow.

Sourceval thread_flow_of_string : string -> thread_flow

Deserialize JSON data of type thread_flow.

Sourceval write_code_flow : Buffer.t -> code_flow -> unit

Output a JSON value of type code_flow.

Sourceval string_of_code_flow : ?len:int -> code_flow -> string

Serialize a value of type code_flow into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_code_flow : Yojson.Safe.lexer_state -> Lexing.lexbuf -> code_flow

Input JSON data of type code_flow.

Sourceval code_flow_of_string : string -> code_flow

Deserialize JSON data of type code_flow.

Sourceval write_node : Buffer.t -> node -> unit

Output a JSON value of type node.

Sourceval string_of_node : ?len:int -> node -> string

Serialize a value of type node into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_node : Yojson.Safe.lexer_state -> Lexing.lexbuf -> node

Input JSON data of type node.

Sourceval node_of_string : string -> node

Deserialize JSON data of type node.

Sourceval write_exception_ : Buffer.t -> exception_ -> unit

Output a JSON value of type exception_.

Sourceval string_of_exception_ : ?len:int -> exception_ -> string

Serialize a value of type exception_ into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_exception_ : Yojson.Safe.lexer_state -> Lexing.lexbuf -> exception_

Input JSON data of type exception_.

Sourceval exception__of_string : string -> exception_

Deserialize JSON data of type exception_.

Sourceval write_graph : Buffer.t -> graph -> unit

Output a JSON value of type graph.

Sourceval string_of_graph : ?len:int -> graph -> string

Serialize a value of type graph into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_graph : Yojson.Safe.lexer_state -> Lexing.lexbuf -> graph

Input JSON data of type graph.

Sourceval graph_of_string : string -> graph

Deserialize JSON data of type graph.

Sourceval write_result : Buffer.t -> result -> unit

Output a JSON value of type result.

Sourceval string_of_result : ?len:int -> result -> string

Serialize a value of type result into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_result : Yojson.Safe.lexer_state -> Lexing.lexbuf -> result

Input JSON data of type result.

Sourceval result_of_string : string -> result

Deserialize JSON data of type result.

Sourceval write_notification : Buffer.t -> notification -> unit

Output a JSON value of type notification.

Sourceval string_of_notification : ?len:int -> notification -> string

Serialize a value of type notification into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_notification : Yojson.Safe.lexer_state -> Lexing.lexbuf -> notification

Input JSON data of type notification.

Sourceval notification_of_string : string -> notification

Deserialize JSON data of type notification.

Sourceval write_invocation : Buffer.t -> invocation -> unit

Output a JSON value of type invocation.

Sourceval string_of_invocation : ?len:int -> invocation -> string

Serialize a value of type invocation into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_invocation : Yojson.Safe.lexer_state -> Lexing.lexbuf -> invocation

Input JSON data of type invocation.

Sourceval invocation_of_string : string -> invocation

Deserialize JSON data of type invocation.

Sourceval write_conversion : Buffer.t -> conversion -> unit

Output a JSON value of type conversion.

Sourceval string_of_conversion : ?len:int -> conversion -> string

Serialize a value of type conversion into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_conversion : Yojson.Safe.lexer_state -> Lexing.lexbuf -> conversion

Input JSON data of type conversion.

Sourceval conversion_of_string : string -> conversion

Deserialize JSON data of type conversion.

Sourceval write_artifact : Buffer.t -> artifact -> unit

Output a JSON value of type artifact.

Sourceval string_of_artifact : ?len:int -> artifact -> string

Serialize a value of type artifact into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_artifact : Yojson.Safe.lexer_state -> Lexing.lexbuf -> artifact

Input JSON data of type artifact.

Sourceval artifact_of_string : string -> artifact

Deserialize JSON data of type artifact.

Sourceval write_external_properties : Buffer.t -> external_properties -> unit

Output a JSON value of type external_properties.

Sourceval string_of_external_properties : ?len:int -> external_properties -> string

Serialize a value of type external_properties into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_external_properties : Yojson.Safe.lexer_state -> Lexing.lexbuf -> external_properties

Input JSON data of type external_properties.

Sourceval external_properties_of_string : string -> external_properties

Deserialize JSON data of type external_properties.

Sourceval write_version_control_details : Buffer.t -> version_control_details -> unit

Output a JSON value of type version_control_details.

Sourceval string_of_version_control_details : ?len:int -> version_control_details -> string

Serialize a value of type version_control_details into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_version_control_details : Yojson.Safe.lexer_state -> Lexing.lexbuf -> version_control_details

Input JSON data of type version_control_details.

Sourceval version_control_details_of_string : string -> version_control_details

Deserialize JSON data of type version_control_details.

Sourceval write_special_locations : Buffer.t -> special_locations -> unit

Output a JSON value of type special_locations.

Sourceval string_of_special_locations : ?len:int -> special_locations -> string

Serialize a value of type special_locations into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_special_locations : Yojson.Safe.lexer_state -> Lexing.lexbuf -> special_locations

Input JSON data of type special_locations.

Sourceval special_locations_of_string : string -> special_locations

Deserialize JSON data of type special_locations.

Sourceval write_sarif_version : Buffer.t -> sarif_version -> unit

Output a JSON value of type sarif_version.

Sourceval string_of_sarif_version : ?len:int -> sarif_version -> string

Serialize a value of type sarif_version into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_sarif_version : Yojson.Safe.lexer_state -> Lexing.lexbuf -> sarif_version

Input JSON data of type sarif_version.

Sourceval sarif_version_of_string : string -> sarif_version

Deserialize JSON data of type sarif_version.

Sourceval write_run_language : Buffer.t -> run_language -> unit

Output a JSON value of type run_language.

Sourceval string_of_run_language : ?len:int -> run_language -> string

Serialize a value of type run_language into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_run_language : Yojson.Safe.lexer_state -> Lexing.lexbuf -> run_language

Input JSON data of type run_language.

Sourceval run_language_of_string : string -> run_language

Deserialize JSON data of type run_language.

Sourceval write_run_column_kind : Buffer.t -> run_column_kind -> unit

Output a JSON value of type run_column_kind.

Sourceval string_of_run_column_kind : ?len:int -> run_column_kind -> string

Serialize a value of type run_column_kind into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_run_column_kind : Yojson.Safe.lexer_state -> Lexing.lexbuf -> run_column_kind

Input JSON data of type run_column_kind.

Sourceval run_column_kind_of_string : string -> run_column_kind

Deserialize JSON data of type run_column_kind.

Sourceval write_run_baseline_guid : Buffer.t -> run_baseline_guid -> unit

Output a JSON value of type run_baseline_guid.

Sourceval string_of_run_baseline_guid : ?len:int -> run_baseline_guid -> string

Serialize a value of type run_baseline_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_run_baseline_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> run_baseline_guid

Input JSON data of type run_baseline_guid.

Sourceval run_baseline_guid_of_string : string -> run_baseline_guid

Deserialize JSON data of type run_baseline_guid.

Sourceval write_run_automation_details_guid : Buffer.t -> run_automation_details_guid -> unit

Output a JSON value of type run_automation_details_guid.

Sourceval string_of_run_automation_details_guid : ?len:int -> run_automation_details_guid -> string

Serialize a value of type run_automation_details_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_run_automation_details_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> run_automation_details_guid

Input JSON data of type run_automation_details_guid.

Sourceval run_automation_details_guid_of_string : string -> run_automation_details_guid

Deserialize JSON data of type run_automation_details_guid.

Sourceval write_run_automation_details_correlation_guid : Buffer.t -> run_automation_details_correlation_guid -> unit

Output a JSON value of type run_automation_details_correlation_guid.

Sourceval string_of_run_automation_details_correlation_guid : ?len:int -> run_automation_details_correlation_guid -> string

Serialize a value of type run_automation_details_correlation_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_run_automation_details_correlation_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> run_automation_details_correlation_guid

Input JSON data of type run_automation_details_correlation_guid.

Sourceval run_automation_details_correlation_guid_of_string : string -> run_automation_details_correlation_guid

Deserialize JSON data of type run_automation_details_correlation_guid.

Sourceval write_run_automation_details : Buffer.t -> run_automation_details -> unit

Output a JSON value of type run_automation_details.

Sourceval string_of_run_automation_details : ?len:int -> run_automation_details -> string

Serialize a value of type run_automation_details into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_run_automation_details : Yojson.Safe.lexer_state -> Lexing.lexbuf -> run_automation_details

Input JSON data of type run_automation_details.

Sourceval run_automation_details_of_string : string -> run_automation_details

Deserialize JSON data of type run_automation_details.

Sourceval write_hm_str_al : Buffer.t -> hm_str_al -> unit

Output a JSON value of type hm_str_al.

Sourceval string_of_hm_str_al : ?len:int -> hm_str_al -> string

Serialize a value of type hm_str_al into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_hm_str_al : Yojson.Safe.lexer_state -> Lexing.lexbuf -> hm_str_al

Input JSON data of type hm_str_al.

Sourceval hm_str_al_of_string : string -> hm_str_al

Deserialize JSON data of type hm_str_al.

Sourceval write_external_property_file_reference_guid : Buffer.t -> external_property_file_reference_guid -> unit

Output a JSON value of type external_property_file_reference_guid.

Sourceval string_of_external_property_file_reference_guid : ?len:int -> external_property_file_reference_guid -> string

Serialize a value of type external_property_file_reference_guid into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_external_property_file_reference_guid : Yojson.Safe.lexer_state -> Lexing.lexbuf -> external_property_file_reference_guid

Input JSON data of type external_property_file_reference_guid.

Sourceval external_property_file_reference_guid_of_string : string -> external_property_file_reference_guid

Deserialize JSON data of type external_property_file_reference_guid.

Sourceval write_external_property_file_reference : Buffer.t -> external_property_file_reference -> unit

Output a JSON value of type external_property_file_reference.

Sourceval string_of_external_property_file_reference : ?len:int -> external_property_file_reference -> string

Serialize a value of type external_property_file_reference into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_external_property_file_reference : Yojson.Safe.lexer_state -> Lexing.lexbuf -> external_property_file_reference

Input JSON data of type external_property_file_reference.

Sourceval external_property_file_reference_of_string : string -> external_property_file_reference

Deserialize JSON data of type external_property_file_reference.

Sourceval write_external_property_file_references : Buffer.t -> external_property_file_references -> unit

Output a JSON value of type external_property_file_references.

Sourceval string_of_external_property_file_references : ?len:int -> external_property_file_references -> string

Serialize a value of type external_property_file_references into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_external_property_file_references : Yojson.Safe.lexer_state -> Lexing.lexbuf -> external_property_file_references

Input JSON data of type external_property_file_references.

Sourceval external_property_file_references_of_string : string -> external_property_file_references

Deserialize JSON data of type external_property_file_references.

Sourceval write_run : Buffer.t -> run -> unit

Output a JSON value of type run.

Sourceval string_of_run : ?len:int -> run -> string

Serialize a value of type run into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_run : Yojson.Safe.lexer_state -> Lexing.lexbuf -> run

Input JSON data of type run.

Sourceval run_of_string : string -> run

Deserialize JSON data of type run.

Sourceval write_sarif_json_schema : Buffer.t -> sarif_json_schema -> unit

Output a JSON value of type sarif_json_schema.

Sourceval string_of_sarif_json_schema : ?len:int -> sarif_json_schema -> string

Serialize a value of type sarif_json_schema into a JSON string.

  • parameter len

    specifies the initial length of the buffer used internally. Default: 1024.

Sourceval read_sarif_json_schema : Yojson.Safe.lexer_state -> Lexing.lexbuf -> sarif_json_schema

Input JSON data of type sarif_json_schema.

Sourceval sarif_json_schema_of_string : string -> sarif_json_schema

Deserialize JSON data of type sarif_json_schema.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct