[SERVER-56913] Describe IDL in VERSIONED_API_README.md Created: 13/May/21 Updated: 06/Dec/22 |
|
| Status: | Backlog |
| Project: | Core Server |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | A. Jesse Jiryu Davis | Assignee: | Backlog - Replication Team |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | former-quick-wins | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Assigned Teams: |
Replication
|
| Participants: |
| Description |
|
Developers working with the Versioned API should know how to use IDL fields such as api_version, strict, and reply_type. (And is there a way in IDL to deprecate a command in an API version?) We should also explain that an API v1 command's IDL definition generates a C++ base class, and how developers should inherit from that base class. Let's add a bit more detail to VERSIONED_API_README.md. |