DRIVERS-2789 Convert Extended JSON spec to markdown

mongodb · May 29, 2024 · c48b67d · c48b67d
1 parent fd27420
commit c48b67d
Show file tree

Hide file tree

Showing 6 changed files with 621 additions and 844 deletions.
diff --git a/source/bson-corpus/bson-corpus.md b/source/bson-corpus/bson-corpus.md
@@ -37,7 +37,7 @@ pseudo-specification provides such tests.
 ## Specification
 
 The specification for BSON lives at <http://bsonspec.org>. The `extjson` format specification is
-[here](../extended-json.rst).
+[here](../extended-json.md).
 
 ## Test Plan
 

diff --git a/source/extended-json.md b/source/extended-json.md
diff --git a/source/extended-json.rst b/source/extended-json.rst
@@ -0,0 +1,4 @@
+
+.. note::
+ This specification has been converted to Markdown and renamed to
+ `extended-json.md <extended-json.md>`_. 
diff --git a/source/gridfs/tests/README.md b/source/gridfs/tests/README.md
@@ -12,7 +12,7 @@ GridFS. These tests utilize the [Unified Test Format](../../unified-test-format/
 The unified test format allows binary stream data to be expressed and matched with `$$hexBytes` (for uploads) and
 `$$matchesHexBytes` (for downloads), respectively; however, those operators are not supported in all contexts, such as
 `insertData` and `outcome`. When binary data must be expressed as a base64-encoded string
-([Extended JSON](../../extended-json.rst) for a BSON binary type), the test SHOULD include a comment noting the
+([Extended JSON](../../extended-json.md) for a BSON binary type), the test SHOULD include a comment noting the
 equivalent value in hexadecimal for human-readability. For example:
 
 ```yaml

diff --git a/source/index.md b/source/index.md
@@ -16,6 +16,7 @@
 - [Driver Mantras](./driver-mantras.md)
 - [Driver Sessions Specification](sessions/driver-sessions.md)
 - [Driver Transactions Specification](transactions/transactions.md)
+- [Extended JSON](./extended-json.md)
 - [FaaS Automated Testing](faas-automated-testing/faas-automated-testing.md)
 - [GridFS Spec](gridfs/gridfs-spec.md)
 - [Handling of DBRefs](./dbref.md)

diff --git a/source/unified-test-format/unified-test-format.md b/source/unified-test-format/unified-test-format.md
@@ -2634,7 +2634,7 @@ Note: the test runner is not required to validate the type or value of a `$$plac
 ### Evaluating Matches
 
 Expected values in tests (e.g. [operation.expectResult](#operation_expectResult)) are expressed as either relaxed or
-canonical [Extended JSON](../extended-json.rst).
+canonical [Extended JSON](../extended-json.md).
 
 The algorithm for matching expected and actual values is specified with the following pseudo-code:
 
@@ -2680,7 +2680,7 @@ The rules for comparing documents and arrays are discussed in more detail in sub
 *other* than documents and arrays, test runners MAY adopt any of the following approaches to compare expected and actual
 values, as long as they are consistent:
 
-- Convert both values to relaxed or canonical [Extended JSON](../extended-json.rst) and compare strings
+- Convert both values to relaxed or canonical [Extended JSON](../extended-json.md) and compare strings
 - Convert both values to BSON, and compare bytes
 - Convert both values to native representations, and compare accordingly
 
@@ -3015,8 +3015,8 @@ tests.
 
 The instructions in this section apply for each test file loaded by the test runner.
 
-Test files, which may be YAML or JSON files, MUST be interpreted using an [Extended JSON](../extended-json.rst) parser.
-The parser MUST accept relaxed and canonical Extended JSON (per [Extended JSON: Parsers](../extended-json.rst#parsers)),
+Test files, which may be YAML or JSON files, MUST be interpreted using an [Extended JSON](../extended-json.md) parser.
+The parser MUST accept relaxed and canonical Extended JSON (per [Extended JSON: Parsers](../extended-json.md#parsers)),
 as test files may use either.
 
 Upon loading a file, the test runner MUST read the [schemaVersion](#schemaVersion) field and determine if the test file