Skip to content

Commit 79f53c3

Browse files
committed
DRIVERS-2789 Convert Extended JSON spec to markdown
1 parent 95d3246 commit 79f53c3

File tree

6 files changed

+621
-844
lines changed

6 files changed

+621
-844
lines changed

source/bson-corpus/bson-corpus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ pseudo-specification provides such tests.
3737
## Specification
3838

3939
The specification for BSON lives at <http://bsonspec.org>. The `extjson` format specification is
40-
[here](../extended-json.rst).
40+
[here](../extended-json.md).
4141

4242
## Test Plan
4343

source/extended-json.md

Lines changed: 610 additions & 838 deletions
Large diffs are not rendered by default.

source/extended-json.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
.. note::
3+
This specification has been converted to Markdown and renamed to
4+
`extended-json.md <extended-json.md>`_.

source/gridfs/tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ GridFS. These tests utilize the [Unified Test Format](../../unified-test-format/
1212
The unified test format allows binary stream data to be expressed and matched with `$$hexBytes` (for uploads) and
1313
`$$matchesHexBytes` (for downloads), respectively; however, those operators are not supported in all contexts, such as
1414
`insertData` and `outcome`. When binary data must be expressed as a base64-encoded string
15-
([Extended JSON](../../extended-json.rst) for a BSON binary type), the test SHOULD include a comment noting the
15+
([Extended JSON](../../extended-json.md) for a BSON binary type), the test SHOULD include a comment noting the
1616
equivalent value in hexadecimal for human-readability. For example:
1717

1818
```yaml

source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
- [Driver Mantras](./driver-mantras.md)
1717
- [Driver Sessions Specification](sessions/driver-sessions.md)
1818
- [Driver Transactions Specification](transactions/transactions.md)
19+
- [Extended JSON](./extended-json.md)
1920
- [FaaS Automated Testing](faas-automated-testing/faas-automated-testing.md)
2021
- [GridFS Spec](gridfs/gridfs-spec.md)
2122
- [Handling of DBRefs](./dbref.md)

source/unified-test-format/unified-test-format.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2634,7 +2634,7 @@ Note: the test runner is not required to validate the type or value of a `$$plac
26342634
### Evaluating Matches
26352635
26362636
Expected values in tests (e.g. [operation.expectResult](#operation_expectResult)) are expressed as either relaxed or
2637-
canonical [Extended JSON](../extended-json.rst).
2637+
canonical [Extended JSON](../extended-json.md).
26382638
26392639
The algorithm for matching expected and actual values is specified with the following pseudo-code:
26402640
@@ -2680,7 +2680,7 @@ The rules for comparing documents and arrays are discussed in more detail in sub
26802680
*other* than documents and arrays, test runners MAY adopt any of the following approaches to compare expected and actual
26812681
values, as long as they are consistent:
26822682
2683-
- Convert both values to relaxed or canonical [Extended JSON](../extended-json.rst) and compare strings
2683+
- Convert both values to relaxed or canonical [Extended JSON](../extended-json.md) and compare strings
26842684
- Convert both values to BSON, and compare bytes
26852685
- Convert both values to native representations, and compare accordingly
26862686
@@ -3015,8 +3015,8 @@ tests.
30153015
30163016
The instructions in this section apply for each test file loaded by the test runner.
30173017
3018-
Test files, which may be YAML or JSON files, MUST be interpreted using an [Extended JSON](../extended-json.rst) parser.
3019-
The parser MUST accept relaxed and canonical Extended JSON (per [Extended JSON: Parsers](../extended-json.rst#parsers)),
3018+
Test files, which may be YAML or JSON files, MUST be interpreted using an [Extended JSON](../extended-json.md) parser.
3019+
The parser MUST accept relaxed and canonical Extended JSON (per [Extended JSON: Parsers](../extended-json.md#parsers)),
30203020
as test files may use either.
30213021
30223022
Upon loading a file, the test runner MUST read the [schemaVersion](#schemaVersion) field and determine if the test file

0 commit comments

Comments
 (0)