Summary

mongodb/specifications@a9096ad for DRIVERS-2253 removed the spec version (among other front matter) from the Unified Test Format (and other specs) . Today, the Unified Test Format only maintains a schema version.

That commit neglected to clean up all references to the spec version. For example, Impact of Spec Changes on Schema Version still reads as if it's talking about the spec version.

Take a pass through Schema Version and ensure that requirements for bumping the schema version are clearly communicated. For example, we should note how adding operations does not impact the schema version since operations are not modeled in the JSON schema. The addition of entities may entail a bump to the schema version depending on whether new syntax is introduced (not the case with entities that are only created by operations, such as createFindCursor).

Additionally, add a Design Rationale to note what is and is not covered by the schema, and explain why some things like operations/arguments are intentionally unmodeled.

This came up from a discussion in mongodb/specifications#1412 for DRIVERS-2533.

Motivation

Who is the affected end user?

Spec test authors.

How does this affect the end user?

Users may have an incomplete understanding of how spec test changes impact the schema version.

Is this issue urgent?

No.

Is this ticket required by a downstream team?

No.

Is this ticket only for tests?

Yes.