Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/+dne.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed the section headers for portions of the documentation.
2 changes: 1 addition & 1 deletion docs/user/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Generally, for all of the `CheckTypes`, the arguments will be in the order `inte

For regex or parameter matching, your provided regex or dictionary would be the first argument and the collected data would be the second argument.

# Customized JMESPath
## Customized JMESPath

Since `jdiff` works with JSON objects as data inputs, JMESPath was the obvious choice for traversing the data and extracting the value(s) to compare. However, JMESPath has a limitation where context is lost for the values it collects, in other words, for each given value that JMESPath returns, we cannot be sure what key it was part of.

Expand Down
2 changes: 1 addition & 1 deletion docs/user/lib_getting_started.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Getting Started
# Getting Started


First, you import the `CheckType` class.
Expand Down
6 changes: 3 additions & 3 deletions docs/user/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ In summary, the workflow is generally:

Before we get started with the CheckTypes, we've also included a method of extracting portions of the data for comparison. In many cases in data comparison, we aren't interested in the whole piece of data. We've provided this utility to extract subsets of a larger data object.

## `extract_data_from_json`
### `extract_data_from_json`

As an example, in this case of the object below, we are only interested in comparing the value of a single key-value pair from each item in the interfaces dictionary contained within the response.

Expand Down Expand Up @@ -67,9 +67,9 @@ After getting the response data from an external system, we'll create a query (s
This type of logic to extract keys and value from the object is called anchor logic.


# `CheckTypes` Explained
## `CheckTypes` Explained

## exact_match
### Exact Match

Check type `exact_match` is concerned with the value of the elements within the data structure. The key-value pairs should match between the reference and comparison data. A diff is generated between the two data sets and tested to see whether all the keys and values match.

Expand Down