Summarize IDL changes re Compatibility Notes API V1 (DOCS-14385)

[DOCS-14010] Investigate changes in SERVER-52540: Specify input/output to drop command in IDL Created: 20/Nov/20  Updated: 13/Nov/23  Due: 22/Jan/21  Resolved: 28/Apr/21

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 5.0.0-rc0, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Sub-task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Joseph Dougherty
Resolution: Fixed Votes: 0
Labels: docs-manual-idl
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-52540 Specify input/output to drop command ... Closed
Related
is related to DOCS-14385 Summarize IDL changes re Compatibilit... Closed
Participants:
Days since reply: 2 years, 41 weeks, 1 day ago

 Description   

Description

Downstream Change Summary

The "drop" command used to ignore unrecognized arguments; now it rejects invocations with unrecognized arguments.

Description of Linked Ticket

null

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Joseph Dougherty [ 27/Apr/21 ]

The drop command is documented on the 5.0 Compatibility Changes page:
https://jira.mongodb.org/browse/DOCS-14385

Command behavior re rejecting invalid arguments is documented on the Versioned API page:
https://jira.mongodb.org/browse/DOCSP-15027

Comment by Githook User [ 20/Jan/21 ]

Author:

{'name': 'Joseph Dougherty', 'email': 'joseph.dougherty@mongodb.com', 'username': 'jmd-mongo'}

Message: DOCS-14010 API V1 Commands Reject Unrecognized Arguments
Branch: v5.0
https://github.com/mongodb/docs/commit/27b81998a0a27e6a0257cd8c46a37c8fcd72f80c

Comment by A. Jesse Jiryu Davis [ 13/Jan/21 ]

Good question. Here's the list, in the section "Commands in Version 1 for mongod/s and Atlas Proxy":

https://docs.google.com/document/d/10heZ18gZQw3x4MFPaTcY1Pwb0XCW7aSsEX5-cSe-nvs/edit#heading=h.d2pgvnubdq8d

As the "API Version Testing" project progresses (PM-1804) we'll convert more commands to IDL definitions with "api_version: 1". I think by the end that all API V1 commands will be so defined. However, we might have to make exceptions. The authoritative list is in the doc above.

Comment by A. Jesse Jiryu Davis [ 12/Jan/21 ]

Right- the set of accepted fields still matches the docs. But if you pass "whatever: 1" you'll now get an error.

Comment by A. Jesse Jiryu Davis [ 11/Jan/21 ]

1. Right.
2a. No arguments.
2b. See generic_argument.idl, the arguments in there are accepted by many commands, although there's a lot of custom logic for each. E.g., writeConcern is defined as a generic arg, but only certain commands (including "drop") actually accept writeConcern.
3. Not inherited from a parent, defined in generic_argument.idl.

Hope that helps. From users' perspective, the only thing that matters is what I said in the summary: The "drop" command used to ignore unrecognized arguments; now it rejects invocations with unrecognized arguments. This page needs no modifications IMO:

https://docs.mongodb.com/manual/reference/command/drop/

... maybe just a mention in the release notes like "the following commands now reject unrecognized parameters", followed by a list of all commands in API V1.

Generated at Thu Feb 08 08:09:17 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.