diff --git a/source/client-side-encryption/subtype6.md b/source/bson-binary-encrypted/binary-encrypted.md similarity index 99% rename from source/client-side-encryption/subtype6.md rename to source/bson-binary-encrypted/binary-encrypted.md index 90427e0685..176a1b1db3 100644 --- a/source/client-side-encryption/subtype6.md +++ b/source/bson-binary-encrypted/binary-encrypted.md @@ -1,4 +1,4 @@ -# BSON Binary Subtype 6 +# BSON Binary Encrypted - Status: Accepted - Minimum Server Version: 4.2 diff --git a/source/uuid.md b/source/bson-binary-uuid/uuid.md similarity index 99% rename from source/uuid.md rename to source/bson-binary-uuid/uuid.md index ced26373fa..1c6e52d4db 100644 --- a/source/uuid.md +++ b/source/bson-binary-uuid/uuid.md @@ -1,4 +1,4 @@ -# Handling of Native UUID Types +# BSON Binary UUID - Status: Accepted - Minimum Server Version: N/A diff --git a/source/bson-corpus/bson-corpus.md b/source/bson-corpus/bson-corpus.md index dcb9f9c520..5d9e645a04 100644 --- 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 . The `extjson` format specification is -[here](../extended-json.md). +[here](../extended-json/extended-json.md). ## Test Plan diff --git a/source/bson-decimal128/decimal128.md b/source/bson-decimal128/decimal128.md index 1f927cee62..b4767b70b6 100644 --- a/source/bson-decimal128/decimal128.md +++ b/source/bson-decimal128/decimal128.md @@ -1,4 +1,4 @@ -# BSON Decimal128 Type Handling in Drivers +# BSON Decimal128 - Status: Accepted - Minimum Server Version: 3.4 diff --git a/source/objectid.md b/source/bson-objectid/objectid.md similarity index 99% rename from source/objectid.md rename to source/bson-objectid/objectid.md index 34da2d7234..424f962747 100644 --- a/source/objectid.md +++ b/source/bson-objectid/objectid.md @@ -1,4 +1,4 @@ -# ObjectID format +# BSON ObjectID - Status: Accepted - Minimum Server Version: N/A diff --git a/source/client-side-encryption/client-side-encryption.md b/source/client-side-encryption/client-side-encryption.md index 32c3c07bec..7dc6a77632 100644 --- a/source/client-side-encryption/client-side-encryption.md +++ b/source/client-side-encryption/client-side-encryption.md @@ -99,7 +99,7 @@ A local process the driver communicates with to determine how to encrypt values This term, spelled in all-lowercase with an underscore, refers to the client-side field-level-encryption dynamic library provided as part of a MongoDB Enterprise distribution. It replaces [mongocryptd](#mongocryptd) as the method of -[marking-up a database command for encryption](./subtype6.md#intent-to-encrypt). +[marking-up a database command for encryption](../bson-binary-encrypted/binary-encrypted.md#intent-to-encrypt). See also: @@ -108,8 +108,8 @@ See also: **ciphertext** -One of the data formats of [BSON binary subtype 6](./subtype6.md), representing an encoded BSON document containing -encrypted ciphertext and metadata. +One of the data formats of [BSON binary encrypted](../bson-binary-encrypted/binary-encrypted.md), representing an +encoded BSON document containing encrypted ciphertext and metadata. **FLE** @@ -258,7 +258,7 @@ connect to [mongocryptd](#mongocryptd) and instead rely on [crypt_shared](#crypt [crypt_shared](#crypt_shared) is a dynamically-loaded C++ library providing query analysis for auto-encryption. It replaces [mongocryptd](#mongocryptd) for performing query analysis to - -[mark-up sensitive fields within a command](./subtype6.md#intent-to-encrypt). +[mark-up sensitive fields within a command](../bson-binary-encrypted/binary-encrypted.md#intent-to-encrypt). Drivers are not required to load and interact with [crypt_shared](#crypt_shared) directly. Instead, they inform [libmongocrypt](#libmongocrypt) where to find [crypt_shared](#crypt_shared) and [libmongocrypt](#libmongocrypt) will @@ -305,7 +305,7 @@ Drivers MAY deviate the spelling of option names to conform to their language's in an idiomatic way (e.g. keyword arguments, builder classes, etc.). Drivers MAY use a native UUID type in place of a parameter or return type specified as a BSON binary with subtype 0x04 -as described in [Handling of Native UUID Types](../uuid.md). +as described in [Handling of Native UUID Types](../bson-binary-uuid/uuid.md). ### MongoClient Changes @@ -1791,7 +1791,7 @@ struct { } ``` -See [Driver Spec: BSON Binary Subtype 6](./subtype6.md) for more information. +See [Driver Spec: BSON Binary Encrypted](../bson-binary-encrypted/binary-encrypted.md) for more information. ### JSONSchema "encrypt" diff --git a/source/client-side-encryption/subtype6.rst b/source/client-side-encryption/subtype6.rst index 2f50cf9e5d..9e7010e822 100644 --- a/source/client-side-encryption/subtype6.rst +++ b/source/client-side-encryption/subtype6.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `subtype6.md `_. + `subtype6.md <../bson-binary-encrypted/binary-encrypted.md>`_. diff --git a/source/client-side-operations-timeout/client-side-operations-timeout.md b/source/client-side-operations-timeout/client-side-operations-timeout.md index 91a6a438b2..d9921ceada 100644 --- a/source/client-side-operations-timeout/client-side-operations-timeout.md +++ b/source/client-side-operations-timeout/client-side-operations-timeout.md @@ -91,8 +91,8 @@ The `timeoutMS` option applies to all operations defined in the following specif - [CRUD](../crud/crud.md) - [Change Streams](../change-streams/change-streams.md) - [Client Side Encryption](../client-side-encryption/client-side-encryption.md) -- [Enumerating Collections](../enumerate-collections.md) -- [Enumerating Databases](../enumerate-databases.md) +- [Enumerating Collections](../enumerate-collections/enumerate-collections.md) +- [Enumerating Databases](../enumerate-databases/enumerate-databases.md) - [GridFS](../gridfs/gridfs-spec.md) - [Index Management](../index-management/index-management.md) - [Transactions](../transactions/transactions.md) diff --git a/source/crud/bulk-write.md b/source/crud/bulk-write.md index 6e279f4fa0..4d4918c6ed 100644 --- a/source/crud/bulk-write.md +++ b/source/crud/bulk-write.md @@ -505,8 +505,8 @@ operation should be performed as its value. The documents have the following for } ``` -If the document to be inserted does not contain an `_id` field, drivers MUST generate a new [`ObjectId`](../objectid.md) -and add it as the `_id` field at the beginning of the document. +If the document to be inserted does not contain an `_id` field, drivers MUST generate a new +[`ObjectId`](../bson-objectid/objectid.md) and add it as the `_id` field at the beginning of the document. #### Update diff --git a/source/dbref.rst b/source/dbref.rst index cf6a891525..a63ea99332 100644 --- a/source/dbref.rst +++ b/source/dbref.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `dbref.md `_. + `dbref.md `_. diff --git a/source/dbref.md b/source/dbref/dbref.md similarity index 99% rename from source/dbref.md rename to source/dbref/dbref.md index 93ea3c63d3..f97b34d085 100644 --- a/source/dbref.md +++ b/source/dbref/dbref.md @@ -1,4 +1,4 @@ -# Handling of DBRefs +# DBRef - Status: Accepted - Minimum Server Version: N/A diff --git a/source/enumerate-collections.rst b/source/enumerate-collections.rst index fa0d29a9c6..5964cbb3b3 100644 --- a/source/enumerate-collections.rst +++ b/source/enumerate-collections.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `enumerate-collections.md `_. + `enumerate-collections.md `_. diff --git a/source/enumerate-collections.md b/source/enumerate-collections/enumerate-collections.md similarity index 98% rename from source/enumerate-collections.md rename to source/enumerate-collections/enumerate-collections.md index ce239f07ca..4b1ababa5b 100644 --- a/source/enumerate-collections.md +++ b/source/enumerate-collections/enumerate-collections.md @@ -133,10 +133,10 @@ All methods: - MAY allow the `cursor.batchSize` option to be passed. - SHOULD allow the `comment` option to be passed. - MUST apply timeouts per the - [Client Side Operations Timeout](./client-side-operations-timeout/client-side-operations-timeout.md) specification. + [Client Side Operations Timeout](../client-side-operations-timeout/client-side-operations-timeout.md) specification. All methods that return cursors MUST support the timeout options documented in -[Client Side Operations Timeout: Cursors](./client-side-operations-timeout/client-side-operations-timeout.md#cursors). +[Client Side Operations Timeout: Cursors](../client-side-operations-timeout/client-side-operations-timeout.md#cursors). #### Getting Collection Names diff --git a/source/enumerate-databases.rst b/source/enumerate-databases.rst index 80f9d8f61c..bb371ab331 100644 --- a/source/enumerate-databases.rst +++ b/source/enumerate-databases.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `enumerate-databases.md `_. + `enumerate-databases.md `_. diff --git a/source/enumerate-databases.md b/source/enumerate-databases/enumerate-databases.md similarity index 96% rename from source/enumerate-databases.md rename to source/enumerate-databases/enumerate-databases.md index a95651f90c..9ed5614276 100644 --- a/source/enumerate-databases.md +++ b/source/enumerate-databases/enumerate-databases.md @@ -99,7 +99,7 @@ backwards compatibility when adding new methods. All methods SHOULD be implemented on the MongoClient object. All methods MUST apply timeouts per the -[Client Side Operations Timeout](./client-side-operations-timeout/client-side-operations-timeout.md) specification. +[Client Side Operations Timeout](../client-side-operations-timeout/client-side-operations-timeout.md) specification. #### Enumerating Full Database Information @@ -210,8 +210,9 @@ to be expanded to support this option. ## Design Rationale -The design of this specification is inspired by the [Collection Enumeration](./enumerate-collections.md) and -[Index Management](./index-management/index-management.md) specifications. Since most drivers already implement a +The design of this specification is inspired by the +[Collection Enumeration](../enumerate-collections/enumerate-collections.md) and +[Index Management](../index-management/index-management.md) specifications. Since most drivers already implement a `listDatabases` command helper in some fashion, this spec is flexible when it comes to existing APIs. ## Backwards Compatibility diff --git a/source/extended-json.rst b/source/extended-json.rst index fc32e1d430..b0bb3b397b 100644 --- a/source/extended-json.rst +++ b/source/extended-json.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `extended-json.md `_. + `extended-json.md `_. diff --git a/source/extended-json.md b/source/extended-json/extended-json.md similarity index 98% rename from source/extended-json.md rename to source/extended-json/extended-json.md index bb3c7b367a..8b181543ce 100644 --- a/source/extended-json.md +++ b/source/extended-json/extended-json.md @@ -109,7 +109,7 @@ ______________________________________________________________________ #### Representation of Non-finite Numeric Values -Following the [Extended JSON format for the Decimal128 type](./bson-decimal128/decimal128.md#to-string-representation), +Following the [Extended JSON format for the Decimal128 type](../bson-decimal128/decimal128.md#to-string-representation), non-finite numeric values are encoded as follows: | **Value** | **String** | @@ -217,9 +217,9 @@ parsing JSON numbers: #### Special rules for parsing `$uuid` fields -As per the [UUID specification](uuid.md), Binary subtype 3 or 4 are used to represent UUIDs in BSON. Consequently, UUIDs -are handled as per the convention described for the `Binary` type in the [Conversion table](#conversion-table), e.g. the -following document written with the MongoDB Python Driver: +As per the [UUID specification](../bson-binary-uuid/uuid.md), Binary subtype 3 or 4 are used to represent UUIDs in BSON. +Consequently, UUIDs are handled as per the convention described for the `Binary` type in the +[Conversion table](#conversion-table), e.g. the following document written with the MongoDB Python Driver: ```javascript {"Binary": uuid.UUID("c8edabc3-f738-4ca3-b68d-ab92a91478a3")} @@ -238,7 +238,7 @@ is transformed into the following (newlines and spaces added for readability): > [!NOTE] > The above described type conversion assumes that UUID representation is set to `STANDARD`. See the -> [UUID specification](uuid.md) for more information about UUID representations. +> [UUID specification](../bson-binary-uuid/uuid.md) for more information about UUID representations. While this transformation preserves BSON subtype information (since UUIDs can be represented as BSON subtype 3 *or* 4), base64-encoding is not the standard way of representing UUIDs and using it makes comparing these values against textual @@ -320,7 +320,7 @@ exception of the DBRef convention, which is accounted for in this spec). ## Test Plan Drivers, tools, and libraries can test their compliance to this specification by running the tests in version 2.0 and -above of the [BSON Corpus Test Suite](./bson-corpus/bson-corpus.md). +above of the [BSON Corpus Test Suite](../bson-corpus/bson-corpus.md). ## Examples @@ -718,7 +718,7 @@ parsed as a normal document and not reported as an error. - Clarified parser and generator rules. - 2017-02-01: Initial specification version 1.0. -[^1]: This MUST conform to the [Decimal128 specification](./bson-decimal128/decimal128.md#writing-to-extended-json) +[^1]: This MUST conform to the [Decimal128 specification](../bson-decimal128/decimal128.md#writing-to-extended-json) [^2]: BSON Regular Expression options MUST be in alphabetical order. diff --git a/source/find_getmore_killcursors_commands.rst b/source/find_getmore_killcursors_commands.rst index f02c983145..0b3b947043 100644 --- a/source/find_getmore_killcursors_commands.rst +++ b/source/find_getmore_killcursors_commands.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `find_getmore_killcursors_commands.md `_. + `find_getmore_killcursors_commands.md `_. diff --git a/source/find_getmore_killcursors_commands.md b/source/find_getmore_killcursors_commands/find_getmore_killcursors_commands.md similarity index 98% rename from source/find_getmore_killcursors_commands.md rename to source/find_getmore_killcursors_commands/find_getmore_killcursors_commands.md index 3f77738181..0ac99bde8d 100644 --- a/source/find_getmore_killcursors_commands.md +++ b/source/find_getmore_killcursors_commands/find_getmore_killcursors_commands.md @@ -1,4 +1,4 @@ -# Find, getMore and killCursors commands. +# Find, getMore and killCursors commands - Status: Accepted - Minimum Server Version: 3.2 @@ -120,7 +120,7 @@ The **secondaryOk** flag SHOULD not be set for all follow-up **getMore** and **k server keeps the original **secondaryOk** value first set on the **find** command. More detailed information about the interaction of the **secondaryOk** with **OP_QUERY** can be found in the Server -Selection Spec [Passing a Read Preference](./server-selection/server-selection.md#passing-read-preference-to-mongos). +Selection Spec [Passing a Read Preference](../server-selection/server-selection.md#passing-read-preference-to-mongos). #### Behavior of Limit, skip and batchSize @@ -131,7 +131,7 @@ existing **OP_QUERY** behavior where there is no server-side concept of limit an of the limit on the client side and **MUST** send a **OP_KILL_CURSORS** wire protocol message when the limit is reached. When setting the **batchSize** on the **find** and **getMore** commands the value of **batchSize** **MUST** be based on -the cursor limit calculations specified in the [CRUD](./crud/crud.md#find) specification. +the cursor limit calculations specified in the [CRUD](../crud/crud.md#find) specification. Note that with 5.0, the server-side handling of cursors with a limit has changed. Before 5.0, some cursors were automatically closed when the limit was reached (e.g. when running **find** with **limit**), and the reply document did @@ -452,7 +452,7 @@ The **find** command does not include a readPreference field. To pass a readPref This format is general for all commands when executing against a Mongos proxy. More in depth information about passing read preferences to Mongos can be found in the Server Selection Specification -[Server Selection Specification](./server-selection/server-selection.md#passing-read-preference-to-mongos). +[Server Selection Specification](../server-selection/server-selection.md#passing-read-preference-to-mongos). ## Changelog diff --git a/source/gridfs/tests/README.md b/source/gridfs/tests/README.md index 8285b2e306..64600a9a29 100644 --- a/source/gridfs/tests/README.md +++ b/source/gridfs/tests/README.md @@ -12,8 +12,8 @@ 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.md) for a BSON binary type), the test SHOULD include a comment noting the -equivalent value in hexadecimal for human-readability. For example: +([Extended JSON](../../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 data: { $binary: { base64: "ESIzRA==", subType: "00" } } # hex 11223344 diff --git a/source/index.md b/source/index.md index 0876ed8a7a..22ba76c141 100644 --- a/source/index.md +++ b/source/index.md @@ -2,9 +2,11 @@ - [Atlas Serverless Tests](serverless-testing/README.md) - [Authentication](auth/auth.md) -- [BSON Binary Subtype 6](client-side-encryption/subtype6.md) +- [BSON Binary Encrypted](bson-binary-encrypted/binary-encrypted.md) +- [BSON Binary UUID](bson-binary-uuid/uuid.md) - [BSON Corpus](bson-corpus/bson-corpus.md) -- [BSON Decimal128 Type Handling in Drivers](bson-decimal128/decimal128.md) +- [BSON Decimal128](bson-decimal128/decimal128.md) +- [BSON ObjectID](bson-objectid/objectid.md) - [Bulk Write](crud/bulk-write.md) - [CRUD API](crud/crud.md) - [Causal Consistency Specification](causal-consistency/causal-consistency.md) @@ -16,15 +18,14 @@ - [Connection Monitoring and Pooling](connection-monitoring-and-pooling/connection-monitoring-and-pooling.md) - [Connection String Spec](connection-string/connection-string-spec.md) - [Convenient API for Transactions](transactions-convenient-api/transactions-convenient-api.md) +- [DBRef](dbref/dbref.md) - [Driver Mantras](./driver-mantras.md) -- [Enumerating Collections](./enumerate-collections.md) -- [Enumerating Databases](./enumerate-databases.md) -- [Extended JSON](./extended-json.md) +- [Enumerating Collections](enumerate-collections/enumerate-collections.md) +- [Enumerating Databases](enumerate-databases/enumerate-databases.md) +- [Extended JSON](extended-json/extended-json.md) - [FaaS Automated Testing](faas-automated-testing/faas-automated-testing.md) -- [Find, getMore and killCursors commands.](./find_getmore_killcursors_commands.md) +- [Find, getMore and killCursors commands](find_getmore_killcursors_commands/find_getmore_killcursors_commands.md) - [GridFS Spec](gridfs/gridfs-spec.md) -- [Handling of DBRefs](./dbref.md) -- [Handling of Native UUID Types](./uuid.md) - [Index Management](index-management/index-management.md) - [Initial DNS Seedlist Discovery](initial-dns-seedlist-discovery/initial-dns-seedlist-discovery.md) - [Load Balancer Support](load-balancers/load-balancers.md) @@ -34,7 +35,6 @@ - [MongoDB Handshake](mongodb-handshake/handshake.md) - [OCSP Support](ocsp-support/ocsp-support.md) - [OP_MSG](message/OP_MSG.md) -- [ObjectID format](./objectid.md) - [Performance Benchmarking](benchmarking/benchmarking.md) - [Polling SRV Records for mongos Discovery](polling-srv-records-for-mongos-discovery/polling-srv-records-for-mongos-discovery.md) - [Read and Write Concern](read-write-concern/read-write-concern.md) @@ -49,7 +49,7 @@ - [Server Monitoring](server-discovery-and-monitoring/server-monitoring.md) - [Server Selection](server-selection/server-selection.md) - [Server Selection Test Plan](server-selection/server-selection-tests.md) -- [Server Wire version and Feature List](./wireversion-featurelist.md) +- [Server Wire version and Feature List](wireversion-featurelist/wireversion-featurelist.md) - [Sessions Specification](sessions/driver-sessions.md) - [Snapshot Reads Specification](sessions/snapshot-sessions.md) - [Stable API For Drivers](versioned-api/versioned-api.md) @@ -57,4 +57,4 @@ - [URI Options Specification](uri-options/uri-options.md) - [Unified Test Format](unified-test-format/unified-test-format.md) - [Wire Compression in Drivers](compression/OP_COMPRESSED.md) -- [Write Commands Specification](./server_write_commands.md) +- [Write Commands Specification](server_write_commands/server_write_commands.md) diff --git a/source/objectid.rst b/source/objectid.rst index 07f2f88a65..0ede5a7506 100644 --- a/source/objectid.rst +++ b/source/objectid.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `objectid.md `_. + `objectid.md `_. diff --git a/source/retryable-reads/retryable-reads.md b/source/retryable-reads/retryable-reads.md index 417ee6e9c2..a34bf12243 100644 --- a/source/retryable-reads/retryable-reads.md +++ b/source/retryable-reads/retryable-reads.md @@ -84,7 +84,7 @@ the defined name but MAY deviate to comply with their existing conventions. Drivers MUST verify server eligibility by ensuring that `maxWireVersion` is at least 6 because retryable reads require a MongoDB 3.6 standalone, replica set or shard cluster, MongoDB 3.6 server wire version is 6 as defined in the -[Server Wire version and Feature List specification](../wireversion-featurelist.md). +[Server Wire version and Feature List specification](../wireversion-featurelist/wireversion-featurelist.md). The minimum server version is 3.6 because @@ -142,9 +142,9 @@ Most of the above methods are defined in the following specifications: - [Change Streams](../change-streams/change-streams.md) - [CRUD](../crud/crud.md) -- [Enumerating Collections](../enumerate-collections.md) +- [Enumerating Collections](../enumerate-collections/enumerate-collections.md) - [Enumerating Indexes](../index-management/index-management.md#enumerate-indexes) -- [Enumerating Databases](../enumerate-databases.md) +- [Enumerating Databases](../enumerate-databases/enumerate-databases.md) - [GridFS Spec](../gridfs/gridfs-spec.md) #### Unsupported Read Operations diff --git a/source/run-command/run-command.md b/source/run-command/run-command.md index 772c6df052..b7c13c6338 100644 --- a/source/run-command/run-command.md +++ b/source/run-command/run-command.md @@ -293,12 +293,13 @@ permit users to change `getMore` field settings at any time during the cursor's commands MUST be constructed with the changes to those fields. If that API is offered drivers MUST write tests asserting `getMore` commands are constructed with any updated fields. -- See Find, getMore and killCursors commands' section on [GetMore](../find_getmore_killcursors_commands.md#getmore) +- See Find, getMore and killCursors commands' section on + [GetMore](../find_getmore_killcursors_commands/find_getmore_killcursors_commands.md#getmore) ##### Tailable and TailableAwait - **See first:** Find, getMore and killCursors commands's section on - [Tailable cursors](../find_getmore_killcursors_commands.md#tailable-cursors) + [Tailable cursors](../find_getmore_killcursors_commands/find_getmore_killcursors_commands.md#tailable-cursors) It is the responsibility of the caller to construct their initial command with `awaitData` and `tailable` flags **as well as** inform RunCursorCommand of the `cursorType` that should be constructed. Requesting a `cursorType` that does @@ -313,7 +314,7 @@ ClientSession associated with the cursor MUST be ended and the ServerSession ret - See Driver Sessions' section on [When sending a killCursors command](../sessions/driver-sessions.md#when-sending-a-killcursors-command) - See Find, getMore and killCursors commands' section on - [killCursors](../find_getmore_killcursors_commands.md#killcursors) + [killCursors](../find_getmore_killcursors_commands/find_getmore_killcursors_commands.md#killcursors) ##### Client Side Operations Timeout diff --git a/source/server_write_commands.rst b/source/server_write_commands.rst index 5ccc920ff0..72b08c4575 100644 --- a/source/server_write_commands.rst +++ b/source/server_write_commands.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `server_write_commands.md `_. + `server_write_commands.md `_. diff --git a/source/server_write_commands.md b/source/server_write_commands/server_write_commands.md similarity index 100% rename from source/server_write_commands.md rename to source/server_write_commands/server_write_commands.md diff --git a/source/sessions/driver-sessions.md b/source/sessions/driver-sessions.md index d98cc9fe54..e8e11be962 100644 --- a/source/sessions/driver-sessions.md +++ b/source/sessions/driver-sessions.md @@ -504,8 +504,9 @@ Drivers MUST document the behavior of unacknowledged writes for both explicit an ### When wrapping commands in a `$query` field If the driver is wrapping the command in a `$query` field for non-OP_MSG messages in order to pass a readPreference to a -mongos (see [ReadPreference and Mongos](../find_getmore_killcursors_commands.md#readpreference-and-mongos)), the driver -SHOULD NOT add the `lsid` as a top-level field, and MUST add the `lsid` as a field of the `$query` +mongos (see +[ReadPreference and Mongos](../find_getmore_killcursors_commands/find_getmore_killcursors_commands.md#readpreference-and-mongos)), +the driver SHOULD NOT add the `lsid` as a top-level field, and MUST add the `lsid` as a field of the `$query` ```typescript // Wrapped command: diff --git a/source/unified-test-format/unified-test-format.md b/source/unified-test-format/unified-test-format.md index 8654b64cba..f94c63a759 100644 --- a/source/unified-test-format/unified-test-format.md +++ b/source/unified-test-format/unified-test-format.md @@ -1428,7 +1428,7 @@ evaluated consistently. These operations and their arguments may be documented in the following specifications: - [Change Streams](../change-streams/change-streams.md) -- [Enumerating Databases](../enumerate-databases.md) +- [Enumerating Databases](../enumerate-databases/enumerate-databases.md) Client operations that require special handling or are not documented by an existing specification are described below. @@ -1542,7 +1542,7 @@ These operations and their arguments may be documented in the following specific - [Change Streams](../change-streams/change-streams.md) - [CRUD](../crud/crud.md) -- [Enumerating Collections](../enumerate-collections.md) +- [Enumerating Collections](../enumerate-collections/enumerate-collections.md) Database operations that require special handling or are not documented by an existing specification are described below. @@ -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.md). +canonical [Extended JSON](../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.md) and compare strings +- Convert both values to relaxed or canonical [Extended JSON](../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,9 +3015,9 @@ 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.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. +Test files, which may be YAML or JSON files, MUST be interpreted using an +[Extended JSON](../extended-json/extended-json.md) parser. The parser MUST accept relaxed and canonical Extended JSON +(per [Extended JSON: Parsers](../extended-json/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 can be processed further. Test runners MAY support multiple versions and MUST NOT process incompatible files (as diff --git a/source/uuid.rst b/source/uuid.rst index 6a5de7c4dc..134cb293b9 100644 --- a/source/uuid.rst +++ b/source/uuid.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `uuid.md `_. + `uuid.md `_. diff --git a/source/wireversion-featurelist.rst b/source/wireversion-featurelist.rst index a7ebe4dece..1ae2436ff8 100644 --- a/source/wireversion-featurelist.rst +++ b/source/wireversion-featurelist.rst @@ -1,4 +1,4 @@ .. note:: This specification has been converted to Markdown and renamed to - `wireversion-featurelist.md `_. + `wireversion-featurelist.md `_. diff --git a/source/wireversion-featurelist.md b/source/wireversion-featurelist/wireversion-featurelist.md similarity index 100% rename from source/wireversion-featurelist.md rename to source/wireversion-featurelist/wireversion-featurelist.md