[SERVER-50531] Describe API Version 1 in VERSIONED_API_README.md Created: 25/Aug/20 Updated: 06/Dec/22 Resolved: 01/Sep/20 |
|
| Status: | Closed |
| Project: | Core Server |
| Component/s: | Replication |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | A. Jesse Jiryu Davis | Assignee: | Backlog - Replication Team |
| Resolution: | Won't Fix | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Assigned Teams: |
Replication
|
| Sprint: | Sharding 2020-09-07 |
| Participants: |
| Description |
|
The contents of API Version 1 are currently in a Google Doc, titled "Scope: Versioned MongoDB API". Let's give it a permanent home in the server repo where non-MongoDB people can see it and we can maintain it alongside the code. |
| Comments |
| Comment by A. Jesse Jiryu Davis [ 01/Sep/20 ] |
|
We'll describe in the server docs which commands and parameters are included in API Version 1. We also maintain this information in the code itself. Keeping the code and docs in sync will be enough labor without adding a third description of API V1, and I don't think it will add any value. Developers of MongoDB are accustomed to searching the MongoDB Manual for information about commands, so we don't need to copy or link to the manual from the server repo. |