forked from mongodb/specifications
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DRIVERS-2789 Convert Versioned API Spec to Markdown
- Loading branch information
Showing
8 changed files
with
172 additions
and
264 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,24 @@ | ||
================ | ||
Stable API Tests | ||
================ | ||
# Stable API Tests | ||
|
||
.. contents:: | ||
______________________________________________________________________ | ||
|
||
---- | ||
## Notes | ||
|
||
Notes | ||
===== | ||
This directory contains tests for the Stable API specification. They are implemented in the | ||
[Unified Test Format](../../unified-test-format/unified-test-format.md), and require schema version 1.1. Note that to | ||
run these tests, the server must be started with both `enableTestCommands` and `acceptApiVersion2` parameters set to | ||
true. | ||
|
||
This directory contains tests for the Stable API specification. They are | ||
implemented in the `Unified Test Format <../../unified-test-format/unified-test-format.md>`__, | ||
and require schema version 1.1. Note that to run these tests, the server must be | ||
started with both ``enableTestCommands`` and ``acceptApiVersion2`` parameters | ||
set to true. | ||
## Testing with required API version | ||
|
||
Testing with required API version | ||
================================= | ||
Drivers MUST run their test suite against a cluster with the `requireApiVersion` parameter enabled and also requires | ||
authentication. | ||
|
||
Drivers MUST run their test suite against a cluster with the | ||
``requireApiVersion`` parameter enabled and also requires authentication. | ||
To run this test, proceed as follows: - Start a standalone mongod instance | ||
|
||
To run this test, proceed as follows: | ||
- Start a standalone mongod instance | ||
- Connect to the standalone instance and run the following command on the `admin` database: | ||
`{ setParameter: 1, requireApiVersion: true }` | ||
- Declare an API version for the test run through the `MONGODB_API_VERSION` environment variable. | ||
- If the environment variable is set, all clients created in tests MUST declare the `ServerApiVersion` specified. | ||
|
||
- Connect to the standalone instance and run the following command on the | ||
``admin`` database: ``{ setParameter: 1, requireApiVersion: true }`` | ||
|
||
- Declare an API version for the test run through the ``MONGODB_API_VERSION`` | ||
environment variable. | ||
|
||
- If the environment variable is set, all clients created in tests MUST declare | ||
the ``ServerApiVersion`` specified. | ||
|
||
Only standalone servers must be tested. The tests should run for each server | ||
version >= 5.0, including ``latest``. | ||
Only standalone servers must be tested. The tests should run for each server version >= 5.0, including `latest`. |
Oops, something went wrong.